2 .\" Copyright (C) 2004, 2005 Richard Kettlewell
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.
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.
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
21 disorderd \- DisOrder jukebox daemon
27 is a daemon which plays audio files and services requests from users
28 concerning what is to be played.
31 .B --config \fIPATH\fR, \fB-c \fIPATH
32 Set the configuration file. The default is
33 .IR pkgconfdir/config .
35 .BR disorder_config (5)
36 for further information.
38 .B --pidfile \fIPATH\fR, \fB-P \fIPATH
41 .B --foreground, \fB-f
42 Run in the foreground. (By default,
44 detaches from its terminal and runs in the background.)
50 Display a usage message.
52 .B --version\fR, \fB-V
53 Display version number.
55 .SS "Environmental Dependencies"
60 are available on the PATH. The example "init" script attempts to
61 ensure this by appending sbindir to the path, but if you have
62 installed programs in unusual locations then this might not work.
63 .SS "How To Configure Authentication"
64 The administrator should create \fIpkgconfdir/config.private\fR, make sure it
65 is not world-readable, and populate it with \fBallow\fR commands
66 listing usernames and passwords. Use
67 e.g. \fBpwgen\fR(1) to generate random passwords. Passwords should
68 then be distributed to users.
70 Each user should create the file \fI~/.disorder/passwd\fR
71 and make sure it is not world-readable. Having done so
72 they should add a \fBpassword\fR command to it giving their password (and
73 optionally a \fBusername\fR command if their DisOrder username is not the
74 same as their login name).
77 is locale-aware. If you do not set the locale correctly then it may
78 not handle non-ASCII data properly.
80 Filenames and the configuration file are assumed to be encoded using the
82 communication with the client happens in UTF-8 (since the client and the server
83 don't know what locale each other might be using - in the future they might not
84 even be on the same host.)
86 DisOrder uses Berkeley DB but currently discards log files that are no longer
87 in use. This means that DB's catastrophic recovery cannot be used (normal
88 recovery can be used, and indeed the server does this automatically on
91 It is suggested that instead you just back up the output of
92 .BR disorder-dump (8),
93 which saves only the parts of the database that cannot be regenerated
94 automatically, and thus has relatively modest storage requirements.
98 Re-read the configuration file.
101 Terminate the daemon gracefully.
104 Terminate the daemon gracefully.
106 It may be more convenient to perform these operations from the client
111 Global configuration file. See \fBdisorder_config\fR(5).
113 .I pkgconfdir/config.private
114 Private configuration (usernames and passwords).
116 .I ~/.disorder/passwd
117 Per-user password file.
120 Saved copy of queue. Do not edit while the daemon is running.
122 .I pkgstatedir/recent
123 Saved copy of recently played track list.
124 Do not edit while the daemon is running.
126 .I pkgstatedir/prefs.db
127 Preferences database.
129 .I pkgstatedir/search.db
132 .I pkgstatedir/tracks.db
135 .I pkgstatedir/DB_CONFIG
136 Berkeley DB configuration file. This may be used to override database
137 settings without recompiling DisOrder. See the Berkeley DB
138 documention for further details.
143 .I pkgstatedir/socket
144 Communication socket for \fBdisorder\fR(1).
147 Lockfile. This prevents multiple instances of DisOrder running
150 .I sbindir/disorder-deadlock
153 .I sbindir/disorder-rescan
157 .B LC_ALL\fR, \fBLANG\fR, etc
158 Current locale. See \fBlocale\fR(7).
160 \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder-dump\fR(8)
164 .\" arch-tag:90dfddb7692b5c7f621c81bd7852ebde