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 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.
34 .IR pkgconfdir/config .
36 .BR disorder_config (5)
37 for further information.
39 .B \-\-pidfile \fIPATH\fR, \fB\-P \fIPATH
42 .B \-\-foreground\fR, \fB\-f
43 Run in the foreground.
46 detaches from its terminal and runs in the background.)
48 .B \-\-syslog\fR, \fB\-s
50 This is the default if DisOrder runs in the background.
52 .B \-\-debug\fR, \fB\-d
55 .B \-\-help\fR, \fB\-h
56 Display a usage message.
58 .B \-\-version\fR, \fB\-V
59 Display version number.
61 For configuration file documentation, see
62 .BR disorder_config (5).
64 The first time a new install of DisOrder is started it will run
66 to pick up new tracks.
67 On subsequent server restarts it will NOT do
68 this automatically; if you want a rescan at every restart you must
69 arrange that manually.
71 There is however an automatic rescan once every 24 hours.
73 A \fBroot\fR login is automatically created on startup if it does not
75 If \fBdisorder\fR(1) is run as root on the same machine as the
76 server it is capable of extracting the password from the database
79 Therefore it is immediately possible to create other users with
81 as root on the server machine.
82 However it is likely to be preferable to get users to register
83 themselves via the web interface; see
87 for more details on this.
89 In its usual configuration, DisOrder logs to daemon.* via \fBsyslog\fR(3).
90 Exactly where this ends up depends on the contents of
91 .IR /etc/syslog.conf .
95 If you do not set the locale correctly then it may not handle
96 non-ASCII data properly.
98 Filenames and the configuration file are assumed to be encoded using the
100 Internally (within the server, in the database and in
101 communication between client and server) the UTF-8 encoding is used.
103 DisOrder uses Berkeley DB but currently discards log files that are no longer
105 This means that DB's catastrophic recovery cannot be used (normal
106 recovery can be used, and indeed the server does this automatically on
109 It is suggested that instead you just back up the output of
110 .BR disorder\-dump (8),
111 which saves only the parts of the database that cannot be regenerated
112 automatically, and thus has relatively modest storage requirements.
116 Re-read the configuration file.
119 Terminate the daemon gracefully.
122 Terminate the daemon gracefully.
124 It may be more convenient to perform these operations from the client
127 .SS "Configuration Files"
130 Global configuration file.
131 See \fBdisorder_config\fR(5).
133 .I pkgconfdir/config.private
134 Private configuration (now largely obsolete).
136 .I ~/.disorder/passwd
137 Per-user password file.
140 .I pkgstatedir/socket
141 Communication socket for \fBdisorder\fR(1).
142 See \fBdisorder_protocol\fR(5) for protocol documentation.
144 Don't modify these files, especially not while the server is running.
149 .I pkgstatedir/recent
150 Saved copy of recently played track list.
152 .I pkgstatedir/global.db
153 Global preferences database.
155 .I pkgstatedir/noticed.db
156 Records recently added tracks.
158 .I pkgstatedir/prefs.db
159 Preferences database.
161 .I pkgstatedir/schedule.db
162 Database of scheduled tasks.
164 .I pkgstatedir/search.db
165 Search lookup database.
167 .I pkgstatedir/tags.db
170 .I pkgstatedir/tracks.db
173 .I pkgstatedir/users.db
176 .I pkgstatedir/DB_CONFIG
177 Berkeley DB configuration file.
178 This may be used to override database settings without recompiling
180 See the Berkeley DB documention for further details.
182 .I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
183 Database internal files.
185 .I pkgstatedir/speaker/socket
186 Socket for communication with \fBdisorder-speaker\fR(8).
190 This prevents multiple instances of DisOrder running simultaneously.
193 .B LC_ALL\fR, \fBLANG\fR, etc
197 \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder\-dump\fR(8),
198 \fBdisorder.cgi\fR(8)