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\fR, \fB-f
42 Run in the foreground. (By default,
44 detaches from its terminal and runs in the background.)
47 Log to syslog. This is the default if DisOrder runs in the background.
53 Display a usage message.
55 .B --version\fR, \fB-V
56 Display version number.
58 For configuration file documentation, see
59 .BR disorder_config (5).
61 The first time a new install of DisOrder is started it will run
63 to pick up new tracks. On subsequent server restarts it will NOT do
64 this automatically; if you want a rescan at every restart you must
65 arrange that manually.
67 There is however an automatic rescan once every 24 hours.
68 .SS "How To Configure Authentication"
69 The administrator should create \fIpkgconfdir/config.private\fR, make sure it
70 is not world-readable, and populate it with \fBallow\fR commands
71 listing usernames and passwords. Use
72 e.g. \fBpwgen\fR(1) to generate random passwords. Passwords should
73 then be distributed to users.
75 Each user should create the file \fI~/.disorder/passwd\fR
76 and make sure it is not world-readable. Having done so
77 they should add a \fBpassword\fR command to it giving their password (and
78 optionally a \fBusername\fR command if their DisOrder username is not the
79 same as their login name).
82 is locale-aware. If you do not set the locale correctly then it may
83 not handle non-ASCII data properly.
85 Filenames and the configuration file are assumed to be encoded using the
86 current locale. Internally (within the server, in the database and in
87 communication between client and server) the UTF-8 encoding is used.
89 DisOrder uses Berkeley DB but currently discards log files that are no longer
90 in use. This means that DB's catastrophic recovery cannot be used (normal
91 recovery can be used, and indeed the server does this automatically on
94 It is suggested that instead you just back up the output of
95 .BR disorder-dump (8),
96 which saves only the parts of the database that cannot be regenerated
97 automatically, and thus has relatively modest storage requirements.
101 Re-read the configuration file.
104 Terminate the daemon gracefully.
107 Terminate the daemon gracefully.
109 It may be more convenient to perform these operations from the client
114 Global configuration file. See \fBdisorder_config\fR(5).
116 .I pkgconfdir/config.private
117 Private configuration (usernames and passwords).
119 .I ~/.disorder/passwd
120 Per-user password file.
123 Saved copy of queue. Do not edit while the daemon is running.
125 .I pkgstatedir/recent
126 Saved copy of recently played track list.
127 Do not edit while the daemon is running.
129 .I pkgstatedir/prefs.db
130 Preferences database.
132 .I pkgstatedir/global.db
133 Global preferences database.
135 .I pkgstatedir/search.db
136 Search lookup database.
138 .I pkgstatedir/tags.db
141 .I pkgstatedir/tracks.db
144 .I pkgstatedir/DB_CONFIG
145 Berkeley DB configuration file. This may be used to override database
146 settings without recompiling DisOrder. See the Berkeley DB
147 documention for further details.
149 .I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
150 Database internal files.
152 .I pkgstatedir/socket
153 Communication socket for \fBdisorder\fR(1).
156 Lockfile. This prevents multiple instances of DisOrder running
160 .B LC_ALL\fR, \fBLANG\fR, etc
161 Current locale. See \fBlocale\fR(7).
163 \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder-dump\fR(8)