.\"
-.\" Copyright (C) 2004, 2005, 2007 Richard Kettlewell
+.\" Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
.\"
-.\" This program is free software; you can redistribute it and/or modify
+.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
-.\" the Free Software Foundation; either version 2 of the License, or
+.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
-.\"
-.\" This program is distributed in the hope that it will be useful, but
-.\" WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-.\" General Public License for more details.
-.\"
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
.\" You should have received a copy of the GNU General Public License
-.\" along with this program; if not, write to the Free Software
-.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-.\" USA
+.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.\"
.TH disorderd 8
.SH NAME
concerning what is to be played.
.SH OPTIONS
.TP
-.B --config \fIPATH\fR, \fB-c \fIPATH
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
Set the configuration file.
The default is
+given by the
+.B DISORDER_CONFIG
+environment variable, defaulting to
.IR pkgconfdir/config .
See
.BR disorder_config (5)
for further information.
.TP
-.B --pidfile \fIPATH\fR, \fB-P \fIPATH
+.B \-\-pidfile \fIPATH\fR, \fB\-P \fIPATH
Write a pidfile.
.TP
-.B --foreground\fR, \fB-f
+.B \-\-foreground\fR, \fB\-f
Run in the foreground.
(By default,
.B disorderd
detaches from its terminal and runs in the background.)
.TP
-.B --syslog\fR, \fB-s
+.B \-\-syslog\fR, \fB\-s
Log to syslog.
This is the default if DisOrder runs in the background.
.TP
-.B --debug\fR, \fB-d
+.B \-\-debug\fR, \fB\-d
Enable debugging.
.TP
-.B --help\fR, \fB-h
+.B \-\-help\fR, \fB\-h
Display a usage message.
.TP
-.B --version\fR, \fB-V
+.B \-\-version\fR, \fB\-V
Display version number.
.SH NOTES
For configuration file documentation, see
If \fBdisorder\fR(1) is run as root on the same machine as the
server it is capable of extracting the password from the database
directly.
+.PP
+Therefore it is immediately possible to create other users with
+.B "disorder adduser"
+as root on the server machine.
+However it is likely to be preferable to get users to register
+themselves via the web interface; see
+.B setup-guest
+in
+.BR disorder (1)
+for more details on this.
+.SS "Logging"
+In its usual configuration, DisOrder logs to daemon.* via \fBsyslog\fR(3).
+Exactly where this ends up depends on the contents of
+.IR /etc/syslog.conf .
.SS "Locales"
.B disorderd
is locale-aware.
startup).
.PP
It is suggested that instead you just back up the output of
-.BR disorder-dump (8),
+.BR disorder\-dump (8),
which saves only the parts of the database that cannot be regenerated
automatically, and thus has relatively modest storage requirements.
.SH SIGNALS
.TP 8
.B SIGHUP
Re-read the configuration file.
+.IP
+Not all configuration options can be modified during the lifetime of the
+server; of those that can't, some will just be ignored if they change while
+others will cause the new configuration to be rejected.
+See \fBdisorder_config\fR(5) for details.
.TP
.B SIGTERM
Terminate the daemon gracefully.
It may be more convenient to perform these operations from the client
\fBdisorder\fR(1).
.SH FILES
+.SS "Configuration Files"
.TP
.I pkgconfdir/config
Global configuration file.
See \fBdisorder_config\fR(5).
.TP
.I pkgconfdir/config.private
-Private configuration (usernames and passwords).
+Private configuration (now largely obsolete).
+.SS "Communication"
.TP
-.I ~/.disorder/passwd
-Per-user password file.
+.I pkgstatedir/socket
+Communication socket for \fBdisorder\fR(1).
+See \fBdisorder_protocol\fR(5) for protocol documentation.
+.SS "Internal State"
+Don't modify these files, especially not while the server is running.
.TP
.I pkgstatedir/queue
Saved copy of queue.
-Do not edit while the daemon is running.
.TP
.I pkgstatedir/recent
Saved copy of recently played track list.
-Do not edit while the daemon is running.
+.TP
+.I pkgstatedir/global.db
+Global preferences database.
+.TP
+.I pkgstatedir/noticed.db
+Records recently added tracks.
.TP
.I pkgstatedir/prefs.db
Preferences database.
.TP
-.I pkgstatedir/global.db
-Global preferences database.
+.I pkgstatedir/schedule.db
+Database of scheduled tasks.
.TP
.I pkgstatedir/search.db
Search lookup database.
.I pkgstatedir/tracks.db
Tracks database.
.TP
+.I pkgstatedir/users.db
+User database.
+.TP
.I pkgstatedir/DB_CONFIG
Berkeley DB configuration file.
This may be used to override database settings without recompiling
.I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
Database internal files.
.TP
-.I pkgstatedir/socket
-Communication socket for \fBdisorder\fR(1).
+.I pkgstatedir/speaker/socket
+Socket for communication with \fBdisorder-speaker\fR(8).
.TP
.I pkgstatedir/lock
Lockfile.
This prevents multiple instances of DisOrder running simultaneously.
.SH ENVIRONMENT
.TP
+.B DISORDER_CONFIG
+Configuration file to use instead of
+.IR pkgconfdir/config .
+.TP
+.B DISORDER_PRIVCONFIG
+Private configuration file to use instead of
+.IR pkgconfdir/config.private .
+.TP
.B LC_ALL\fR, \fBLANG\fR, etc
Current locale.
See \fBlocale\fR(7).
.SH "SEE ALSO"
-\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder-dump\fR(8)
+\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder\-dump\fR(8),
+\fBdisorder.cgi\fR(8)
.\" Local Variables:
.\" mode:nroff
.\" End:
~mdw / disorder / blobdiff