chiark / gitweb /
further docs update
[disorder] / doc / disorderd.8.in
CommitLineData
460b9539 1.\"
2.\" Copyright (C) 2004, 2005 Richard Kettlewell
3.\"
4.\" This program is free software; you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by
6.\" the Free Software Foundation; either version 2 of the License, or
7.\" (at your option) any later version.
8.\"
9.\" This program is distributed in the hope that it will be useful, but
10.\" WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12.\" General Public License for more details.
13.\"
14.\" You should have received a copy of the GNU General Public License
15.\" along with this program; if not, write to the Free Software
16.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
17.\" USA
18.\"
19.TH disorderd 8
20.SH NAME
21disorderd \- DisOrder jukebox daemon
22.SH SYNOPSIS
23.B disorderd
24.RI [ OPTIONS ]
25.SH DESCRIPTION
26.B disorderd
27is a daemon which plays audio files and services requests from users
28concerning what is to be played.
29.SH OPTIONS
30.TP
31.B --config \fIPATH\fR, \fB-c \fIPATH
32Set the configuration file. The default is
33.IR pkgconfdir/config .
34See
35.BR disorder_config (5)
36for further information.
37.TP
38.B --pidfile \fIPATH\fR, \fB-P \fIPATH
39Write a pidfile.
40.TP
25ca855b 41.B --foreground\fR, \fB-f
460b9539 42Run in the foreground. (By default,
43.B disorderd
44detaches from its terminal and runs in the background.)
45.TP
25ca855b
RK
46.B --syslog\fR, \fB-s
47Log to syslog. This is the default if DisOrder runs in the background.
48.TP
460b9539 49.B --debug\fR, \fB-d
50Enable debugging.
51.TP
52.B --help\fR, \fB-h
53Display a usage message.
54.TP
55.B --version\fR, \fB-V
56Display version number.
57.SH NOTES
67a9f4b4
RK
58.SS "Startup"
59The first time a new install of DisOrder is started it will run
460b9539 60.B disorder-rescan
67a9f4b4
RK
61to pick up new tracks. On subsequent server restarts it will NOT do
62this automatically; if you want a rescan at every restart you must
63arrange that manually.
64.PP
65There is however an automatic rescan once every 24 hours.
460b9539 66.SS "How To Configure Authentication"
67The administrator should create \fIpkgconfdir/config.private\fR, make sure it
68is not world-readable, and populate it with \fBallow\fR commands
69listing usernames and passwords. Use
70e.g. \fBpwgen\fR(1) to generate random passwords. Passwords should
71then be distributed to users.
72.PP
73Each user should create the file \fI~/.disorder/passwd\fR
74and make sure it is not world-readable. Having done so
75they should add a \fBpassword\fR command to it giving their password (and
76optionally a \fBusername\fR command if their DisOrder username is not the
77same as their login name).
78.SS Locales
79.B disorderd
80is locale-aware. If you do not set the locale correctly then it may
81not handle non-ASCII data properly.
82.PP
83Filenames and the configuration file are assumed to be encoded using the
67a9f4b4
RK
84current locale. Internally (within the server, in the database and in
85communication between client and server) the UTF-8 encoding is used.
460b9539 86.SS Backups
87DisOrder uses Berkeley DB but currently discards log files that are no longer
88in use. This means that DB's catastrophic recovery cannot be used (normal
89recovery can be used, and indeed the server does this automatically on
90startup).
91.PP
92It is suggested that instead you just back up the output of
93.BR disorder-dump (8),
94which saves only the parts of the database that cannot be regenerated
95automatically, and thus has relatively modest storage requirements.
96.SH SIGNALS
97.TP 8
98.B SIGHUP
99Re-read the configuration file.
100.TP
101.B SIGTERM
102Terminate the daemon gracefully.
103.TP
104.B SIGINT
105Terminate the daemon gracefully.
106.PP
107It may be more convenient to perform these operations from the client
108\fBdisorder\fR(1).
109.SH FILES
110.TP
111.I pkgconfdir/config
112Global configuration file. See \fBdisorder_config\fR(5).
113.TP
114.I pkgconfdir/config.private
115Private configuration (usernames and passwords).
116.TP
117.I ~/.disorder/passwd
118Per-user password file.
119.TP
120.I pkgstatedir/queue
121Saved copy of queue. Do not edit while the daemon is running.
122.TP
123.I pkgstatedir/recent
124Saved copy of recently played track list.
125Do not edit while the daemon is running.
126.TP
127.I pkgstatedir/prefs.db
128Preferences database.
129.TP
25ca855b
RK
130.I pkgstatedir/global.db
131Global preferences database.
132.TP
460b9539 133.I pkgstatedir/search.db
25ca855b
RK
134Search lookup database.
135.TP
136.I pkgstatedir/tags.db
137Tag lookup database.
460b9539 138.TP
139.I pkgstatedir/tracks.db
140Tracks database.
141.TP
142.I pkgstatedir/DB_CONFIG
143Berkeley DB configuration file. This may be used to override database
144settings without recompiling DisOrder. See the Berkeley DB
145documention for further details.
146.TP
25ca855b
RK
147.I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
148Database internal files.
460b9539 149.TP
150.I pkgstatedir/socket
151Communication socket for \fBdisorder\fR(1).
152.TP
153.I pkgstatedir/lock
154Lockfile. This prevents multiple instances of DisOrder running
155simultaneously.
460b9539 156.SH ENVIRONMENT
157.TP
158.B LC_ALL\fR, \fBLANG\fR, etc
159Current locale. See \fBlocale\fR(7).
160.SH "SEE ALSO"
161\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder-dump\fR(8)
162.\" Local Variables:
163.\" mode:nroff
164.\" End: