disorder.py docs improved a little

[disorder] / doc / disorderd.8.in

.\"
.\" Copyright (C) 2004, 2005 Richard Kettlewell
.\"
.\" 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
.\" (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.
.\"
.\" 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
.\"
.TH disorderd 8
.SH NAME
disorderd \- DisOrder jukebox daemon
.SH SYNOPSIS
.B disorderd
.RI [ OPTIONS ]
.SH DESCRIPTION
.B disorderd
is a daemon which plays audio files and services requests from users
concerning what is to be played.
.SH OPTIONS
.TP
.B --config \fIPATH\fR, \fB-c \fIPATH
Set the configuration file.  The default is
.IR pkgconfdir/config .
See
.BR disorder_config (5)
for further information.
.TP
.B --pidfile \fIPATH\fR, \fB-P \fIPATH
Write a pidfile.
.TP
.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
Log to syslog.  This is the default if DisOrder runs in the background.
.TP
.B --debug\fR, \fB-d
Enable debugging.
.TP
.B --help\fR, \fB-h
Display a usage message.
.TP
.B --version\fR, \fB-V
Display version number.
.SH NOTES
.SS "Startup"
The first time a new install of DisOrder is started it will run
.B disorder-rescan
to pick up new tracks.  On subsequent server restarts it will NOT do
this automatically; if you want a rescan at every restart you must
arrange that manually.
.PP
There is however an automatic rescan once every 24 hours.
.SS "How To Configure Authentication"
The administrator should create \fIpkgconfdir/config.private\fR, make sure it
is not world-readable, and populate it with \fBallow\fR commands
listing usernames and passwords.  Use
e.g. \fBpwgen\fR(1) to generate random passwords.  Passwords should
then be distributed to users.
.PP
Each user should create the file \fI~/.disorder/passwd\fR
and make sure it is not world-readable.  Having done so
they should add a \fBpassword\fR command to it giving their password (and
optionally a \fBusername\fR command if their DisOrder username is not the
same as their login name).
.SS Locales
.B disorderd
is locale-aware.  If you do not set the locale correctly then it may
not handle non-ASCII data properly.
.PP
Filenames and the configuration file are assumed to be encoded using the
current locale.  Internally (within the server, in the database and in
communication between client and server) the UTF-8 encoding is used.
.SS Backups
DisOrder uses Berkeley DB but currently discards log files that are no longer
in use.  This means that DB's catastrophic recovery cannot be used (normal
recovery can be used, and indeed the server does this automatically on
startup).
.PP
It is suggested that instead you just back up the output of
.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.
.TP
.B SIGTERM
Terminate the daemon gracefully.
.TP
.B SIGINT
Terminate the daemon gracefully.
.PP
It may be more convenient to perform these operations from the client
\fBdisorder\fR(1).
.SH FILES
.TP
.I pkgconfdir/config
Global configuration file.  See \fBdisorder_config\fR(5).
.TP
.I pkgconfdir/config.private
Private configuration (usernames and passwords).
.TP
.I ~/.disorder/passwd
Per-user password file.
.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/prefs.db
Preferences database.
.TP
.I pkgstatedir/global.db
Global preferences database.
.TP
.I pkgstatedir/search.db
Search lookup database.
.TP
.I pkgstatedir/tags.db
Tag lookup database.
.TP
.I pkgstatedir/tracks.db
Tracks database.
.TP
.I pkgstatedir/DB_CONFIG
Berkeley DB configuration file.  This may be used to override database
settings without recompiling DisOrder.  See the Berkeley DB
documention for further details.
.TP
.I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
Database internal files.
.TP
.I pkgstatedir/socket
Communication socket for \fBdisorder\fR(1).
.TP
.I pkgstatedir/lock
Lockfile.  This prevents multiple instances of DisOrder running
simultaneously.
.SH ENVIRONMENT
.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)
.\" Local Variables:
.\" mode:nroff
.\" End: