2 .\" Copyright (C) 2004, 2005, 2007, 2008 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 3 of the License, or
7 .\" (at your option) any later version.
9 .\" This program is distributed in the hope that it will be useful,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 .\" GNU 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, see <http://www.gnu.org/licenses/>.
19 disorderd \- DisOrder jukebox daemon
25 is a daemon which plays audio files and services requests from users
26 concerning what is to be played.
29 .B \-\-config \fIPATH\fR, \fB\-c \fIPATH
30 Set the configuration file.
32 .IR pkgconfdir/config .
34 .BR disorder_config (5)
35 for further information.
37 .B \-\-pidfile \fIPATH\fR, \fB\-P \fIPATH
40 .B \-\-foreground\fR, \fB\-f
41 Run in the foreground.
44 detaches from its terminal and runs in the background.)
46 .B \-\-syslog\fR, \fB\-s
48 This is the default if DisOrder runs in the background.
50 .B \-\-debug\fR, \fB\-d
53 .B \-\-help\fR, \fB\-h
54 Display a usage message.
56 .B \-\-version\fR, \fB\-V
57 Display version number.
59 For configuration file documentation, see
60 .BR disorder_config (5).
62 The first time a new install of DisOrder is started it will run
64 to pick up new tracks.
65 On subsequent server restarts it will NOT do
66 this automatically; if you want a rescan at every restart you must
67 arrange that manually.
69 There is however an automatic rescan once every 24 hours.
71 A \fBroot\fR login is automatically created on startup if it does not
73 If \fBdisorder\fR(1) is run as root on the same machine as the
74 server it is capable of extracting the password from the database
77 Therefore it is immediately possible to create other users with
79 as root on the server machine.
80 However it is likely to be preferable to get users to register
81 themselves via the web interface; see
85 for more details on this.
87 In its usual configuration, DisOrder logs to daemon.* via \fBsyslog\fR(3).
88 Exactly where this ends up depends on the contents of
89 .IR /etc/syslog.conf .
93 If you do not set the locale correctly then it may not handle
94 non-ASCII data properly.
96 Filenames and the configuration file are assumed to be encoded using the
98 Internally (within the server, in the database and in
99 communication between client and server) the UTF-8 encoding is used.
101 DisOrder uses Berkeley DB but currently discards log files that are no longer
103 This means that DB's catastrophic recovery cannot be used (normal
104 recovery can be used, and indeed the server does this automatically on
107 It is suggested that instead you just back up the output of
108 .BR disorder\-dump (8),
109 which saves only the parts of the database that cannot be regenerated
110 automatically, and thus has relatively modest storage requirements.
114 Re-read the configuration file.
117 Terminate the daemon gracefully.
120 Terminate the daemon gracefully.
122 It may be more convenient to perform these operations from the client
125 .SS "Configuration Files"
128 Global configuration file.
129 See \fBdisorder_config\fR(5).
131 .I pkgconfdir/config.private
132 Private configuration (now largely obsolete).
134 .I ~/.disorder/passwd
135 Per-user password file.
138 .I pkgstatedir/socket
139 Communication socket for \fBdisorder\fR(1).
140 See \fBdisorder_protocol\fR(5) for protocol documentation.
142 Don't modify these files, especially not while the server is running.
147 .I pkgstatedir/recent
148 Saved copy of recently played track list.
150 .I pkgstatedir/global.db
151 Global preferences database.
153 .I pkgstatedir/noticed.db
154 Records recently added tracks.
156 .I pkgstatedir/prefs.db
157 Preferences database.
159 .I pkgstatedir/schedule.db
160 Database of scheduled tasks.
162 .I pkgstatedir/search.db
163 Search lookup database.
165 .I pkgstatedir/tags.db
168 .I pkgstatedir/tracks.db
171 .I pkgstatedir/users.db
174 .I pkgstatedir/DB_CONFIG
175 Berkeley DB configuration file.
176 This may be used to override database settings without recompiling
178 See the Berkeley DB documention for further details.
180 .I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
181 Database internal files.
183 .I pkgstatedir/speaker/socket
184 Socket for communication with \fBdisorder-speaker\fR(8).
188 This prevents multiple instances of DisOrder running simultaneously.
191 .B LC_ALL\fR, \fBLANG\fR, etc
195 \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder\-dump\fR(8),
196 \fBdisorder.cgi\fR(8)