chiark / gitweb /
Import from Arch revision:
[disorder] / doc / disorderd.8.in
CommitLineData
460b9539 1.\"
2.\" Copyright (C) 2004, 2005 Richard Kettlewell
3.\"
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.
8.\"
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.
13.\"
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
17.\" USA
18.\"
19.TH disorderd 8
20.SH NAME
21disorderd \- DisOrder jukebox daemon
22.SH SYNOPSIS
23.B disorderd
24.RI [ OPTIONS ]
25.SH DESCRIPTION
26.B disorderd
27is a daemon which plays audio files and services requests from users
28concerning what is to be played.
29.SH OPTIONS
30.TP
31.B --config \fIPATH\fR, \fB-c \fIPATH
32Set the configuration file. The default is
33.IR pkgconfdir/config .
34See
35.BR disorder_config (5)
36for further information.
37.TP
38.B --pidfile \fIPATH\fR, \fB-P \fIPATH
39Write a pidfile.
40.TP
41.B --foreground, \fB-f
42Run in the foreground. (By default,
43.B disorderd
44detaches from its terminal and runs in the background.)
45.TP
46.B --debug\fR, \fB-d
47Enable debugging.
48.TP
49.B --help\fR, \fB-h
50Display a usage message.
51.TP
52.B --version\fR, \fB-V
53Display version number.
54.SH NOTES
55.SS "Environmental Dependencies"
56It is important that
57.B disorder-deadlock
58and
59.B disorder-rescan
60are available on the PATH. The example "init" script attempts to
61ensure this by appending sbindir to the path, but if you have
62installed programs in unusual locations then this might not work.
63.SS "How To Configure Authentication"
64The administrator should create \fIpkgconfdir/config.private\fR, make sure it
65is not world-readable, and populate it with \fBallow\fR commands
66listing usernames and passwords. Use
67e.g. \fBpwgen\fR(1) to generate random passwords. Passwords should
68then be distributed to users.
69.PP
70Each user should create the file \fI~/.disorder/passwd\fR
71and make sure it is not world-readable. Having done so
72they should add a \fBpassword\fR command to it giving their password (and
73optionally a \fBusername\fR command if their DisOrder username is not the
74same as their login name).
75.SS Locales
76.B disorderd
77is locale-aware. If you do not set the locale correctly then it may
78not handle non-ASCII data properly.
79.PP
80Filenames and the configuration file are assumed to be encoded using the
81current locale. The
82communication with the client happens in UTF-8 (since the client and the server
83don't know what locale each other might be using - in the future they might not
84even be on the same host.)
85.SS Backups
86DisOrder uses Berkeley DB but currently discards log files that are no longer
87in use. This means that DB's catastrophic recovery cannot be used (normal
88recovery can be used, and indeed the server does this automatically on
89startup).
90.PP
91It is suggested that instead you just back up the output of
92.BR disorder-dump (8),
93which saves only the parts of the database that cannot be regenerated
94automatically, and thus has relatively modest storage requirements.
95.SH SIGNALS
96.TP 8
97.B SIGHUP
98Re-read the configuration file.
99.TP
100.B SIGTERM
101Terminate the daemon gracefully.
102.TP
103.B SIGINT
104Terminate the daemon gracefully.
105.PP
106It may be more convenient to perform these operations from the client
107\fBdisorder\fR(1).
108.SH FILES
109.TP
110.I pkgconfdir/config
111Global configuration file. See \fBdisorder_config\fR(5).
112.TP
113.I pkgconfdir/config.private
114Private configuration (usernames and passwords).
115.TP
116.I ~/.disorder/passwd
117Per-user password file.
118.TP
119.I pkgstatedir/queue
120Saved copy of queue. Do not edit while the daemon is running.
121.TP
122.I pkgstatedir/recent
123Saved copy of recently played track list.
124Do not edit while the daemon is running.
125.TP
126.I pkgstatedir/prefs.db
127Preferences database.
128.TP
129.I pkgstatedir/search.db
130Search database.
131.TP
132.I pkgstatedir/tracks.db
133Tracks database.
134.TP
135.I pkgstatedir/DB_CONFIG
136Berkeley DB configuration file. This may be used to override database
137settings without recompiling DisOrder. See the Berkeley DB
138documention for further details.
139.TP
140.I pkgstatedir/log.*
141Database log files.
142.TP
143.I pkgstatedir/socket
144Communication socket for \fBdisorder\fR(1).
145.TP
146.I pkgstatedir/lock
147Lockfile. This prevents multiple instances of DisOrder running
148simultaneously.
149.TP
150.I sbindir/disorder-deadlock
151Deadlock manager.
152.TP
153.I sbindir/disorder-rescan
154Rescanner.
155.SH ENVIRONMENT
156.TP
157.B LC_ALL\fR, \fBLANG\fR, etc
158Current locale. See \fBlocale\fR(7).
159.SH "SEE ALSO"
160\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder-dump\fR(8)
161.\" Local Variables:
162.\" mode:nroff
163.\" End:
164.\" arch-tag:90dfddb7692b5c7f621c81bd7852ebde