chiark / gitweb /
Put a newline after end-of-sentence "." in man pages. I'm advised
[disorder] / doc / disorderd.8.in
CommitLineData
460b9539 1.\"
08ddd038 2.\" Copyright (C) 2004, 2005, 2007 Richard Kettlewell
460b9539 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
c0c23a60
RK
32Set the configuration file.
33The default is
460b9539 34.IR pkgconfdir/config .
35See
36.BR disorder_config (5)
37for further information.
38.TP
39.B --pidfile \fIPATH\fR, \fB-P \fIPATH
40Write a pidfile.
41.TP
25ca855b 42.B --foreground\fR, \fB-f
c0c23a60
RK
43Run in the foreground.
44(By default,
460b9539 45.B disorderd
46detaches from its terminal and runs in the background.)
47.TP
25ca855b 48.B --syslog\fR, \fB-s
c0c23a60
RK
49Log to syslog.
50This is the default if DisOrder runs in the background.
25ca855b 51.TP
460b9539 52.B --debug\fR, \fB-d
53Enable debugging.
54.TP
55.B --help\fR, \fB-h
56Display a usage message.
57.TP
58.B --version\fR, \fB-V
59Display version number.
60.SH NOTES
180dcdb0
RK
61For configuration file documentation, see
62.BR disorder_config (5).
67a9f4b4
RK
63.SS "Startup"
64The first time a new install of DisOrder is started it will run
460b9539 65.B disorder-rescan
c0c23a60
RK
66to pick up new tracks.
67On subsequent server restarts it will NOT do
67a9f4b4
RK
68this automatically; if you want a rescan at every restart you must
69arrange that manually.
70.PP
71There is however an automatic rescan once every 24 hours.
460b9539 72.PP
08ddd038 73A \fBroot\fR login is automatically created on startup if it does not
c0c23a60
RK
74exist.
75If \fBdisorder\fR(1) is run as root on the same machine as the
08ddd038
RK
76server it is capable of extracting the password from the database
77directly.
78.SS "Locales"
460b9539 79.B disorderd
c0c23a60
RK
80is locale-aware.
81If you do not set the locale correctly then it may not handle
82non-ASCII data properly.
460b9539 83.PP
84Filenames and the configuration file are assumed to be encoded using the
c0c23a60
RK
85current locale.
86Internally (within the server, in the database and in
67a9f4b4 87communication between client and server) the UTF-8 encoding is used.
460b9539 88.SS Backups
89DisOrder uses Berkeley DB but currently discards log files that are no longer
c0c23a60
RK
90in use.
91This means that DB's catastrophic recovery cannot be used (normal
460b9539 92recovery can be used, and indeed the server does this automatically on
93startup).
94.PP
95It is suggested that instead you just back up the output of
96.BR disorder-dump (8),
97which saves only the parts of the database that cannot be regenerated
98automatically, and thus has relatively modest storage requirements.
99.SH SIGNALS
100.TP 8
101.B SIGHUP
102Re-read the configuration file.
103.TP
104.B SIGTERM
105Terminate the daemon gracefully.
106.TP
107.B SIGINT
108Terminate the daemon gracefully.
109.PP
110It may be more convenient to perform these operations from the client
111\fBdisorder\fR(1).
112.SH FILES
113.TP
114.I pkgconfdir/config
c0c23a60
RK
115Global configuration file.
116See \fBdisorder_config\fR(5).
460b9539 117.TP
118.I pkgconfdir/config.private
119Private configuration (usernames and passwords).
120.TP
121.I ~/.disorder/passwd
122Per-user password file.
123.TP
124.I pkgstatedir/queue
c0c23a60
RK
125Saved copy of queue.
126Do not edit while the daemon is running.
460b9539 127.TP
128.I pkgstatedir/recent
129Saved copy of recently played track list.
130Do not edit while the daemon is running.
131.TP
132.I pkgstatedir/prefs.db
133Preferences database.
134.TP
25ca855b
RK
135.I pkgstatedir/global.db
136Global preferences database.
137.TP
460b9539 138.I pkgstatedir/search.db
25ca855b
RK
139Search lookup database.
140.TP
141.I pkgstatedir/tags.db
142Tag lookup database.
460b9539 143.TP
144.I pkgstatedir/tracks.db
145Tracks database.
146.TP
147.I pkgstatedir/DB_CONFIG
c0c23a60
RK
148Berkeley DB configuration file.
149This may be used to override database settings without recompiling
150DisOrder.
151See the Berkeley DB documention for further details.
460b9539 152.TP
25ca855b
RK
153.I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
154Database internal files.
460b9539 155.TP
156.I pkgstatedir/socket
157Communication socket for \fBdisorder\fR(1).
158.TP
159.I pkgstatedir/lock
c0c23a60
RK
160Lockfile.
161This prevents multiple instances of DisOrder running simultaneously.
460b9539 162.SH ENVIRONMENT
163.TP
164.B LC_ALL\fR, \fBLANG\fR, etc
c0c23a60
RK
165Current locale.
166See \fBlocale\fR(7).
460b9539 167.SH "SEE ALSO"
168\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder-dump\fR(8)
169.\" Local Variables:
170.\" mode:nroff
171.\" End: