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.
56 The first time a new install of DisOrder is started it will run
58 to pick up new tracks. On subsequent server restarts it will NOT do
59 this automatically; if you want a rescan at every restart you must
60 arrange that manually.
62 There is however an automatic rescan once every 24 hours.
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
81 current locale. Internally (within the server, in the database and in
82 communication between client and server) the UTF-8 encoding is used.
84 DisOrder uses Berkeley DB but currently discards log files that are no longer
85 in use. This means that DB's catastrophic recovery cannot be used (normal
86 recovery can be used, and indeed the server does this automatically on
89 It is suggested that instead you just back up the output of
90 .BR disorder-dump (8),
91 which saves only the parts of the database that cannot be regenerated
92 automatically, and thus has relatively modest storage requirements.
96 Re-read the configuration file.
99 Terminate the daemon gracefully.
102 Terminate the daemon gracefully.
104 It may be more convenient to perform these operations from the client
109 Global configuration file. See \fBdisorder_config\fR(5).
111 .I pkgconfdir/config.private
112 Private configuration (usernames and passwords).
114 .I ~/.disorder/passwd
115 Per-user password file.
118 Saved copy of queue. Do not edit while the daemon is running.
120 .I pkgstatedir/recent
121 Saved copy of recently played track list.
122 Do not edit while the daemon is running.
124 .I pkgstatedir/prefs.db
125 Preferences database.
127 .I pkgstatedir/search.db
130 .I pkgstatedir/tracks.db
133 .I pkgstatedir/DB_CONFIG
134 Berkeley DB configuration file. This may be used to override database
135 settings without recompiling DisOrder. See the Berkeley DB
136 documention for further details.
141 .I pkgstatedir/socket
142 Communication socket for \fBdisorder\fR(1).
145 Lockfile. This prevents multiple instances of DisOrder running
148 .I sbindir/disorder-deadlock
151 .I sbindir/disorder-rescan
155 .B LC_ALL\fR, \fBLANG\fR, etc
156 Current locale. See \fBlocale\fR(7).
158 \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder-dump\fR(8)