chiark / gitweb /
Warn on attempts to change nice_server during server lifetime.
[disorder] / doc / disorderd.8.in
CommitLineData
460b9539 1.\"
5aff007d 2.\" Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
460b9539 3.\"
e7eb3a27 4.\" This program is free software: you can redistribute it and/or modify
460b9539 5.\" it under the terms of the GNU General Public License as published by
e7eb3a27 6.\" the Free Software Foundation, either version 3 of the License, or
460b9539 7.\" (at your option) any later version.
e7eb3a27
RK
8.\"
9.\" This program is distributed in the hope that it will be useful,
10.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12.\" GNU General Public License for more details.
13.\"
460b9539 14.\" You should have received a copy of the GNU General Public License
e7eb3a27 15.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
460b9539 16.\"
17.TH disorderd 8
18.SH NAME
19disorderd \- DisOrder jukebox daemon
20.SH SYNOPSIS
21.B disorderd
22.RI [ OPTIONS ]
23.SH DESCRIPTION
24.B disorderd
25is a daemon which plays audio files and services requests from users
26concerning what is to be played.
27.SH OPTIONS
28.TP
0d350ff0 29.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
c0c23a60
RK
30Set the configuration file.
31The default is
460b9539 32.IR pkgconfdir/config .
33See
34.BR disorder_config (5)
35for further information.
36.TP
0d350ff0 37.B \-\-pidfile \fIPATH\fR, \fB\-P \fIPATH
460b9539 38Write a pidfile.
39.TP
0d350ff0 40.B \-\-foreground\fR, \fB\-f
c0c23a60
RK
41Run in the foreground.
42(By default,
460b9539 43.B disorderd
44detaches from its terminal and runs in the background.)
45.TP
0d350ff0 46.B \-\-syslog\fR, \fB\-s
c0c23a60
RK
47Log to syslog.
48This is the default if DisOrder runs in the background.
25ca855b 49.TP
0d350ff0 50.B \-\-debug\fR, \fB\-d
460b9539 51Enable debugging.
52.TP
0d350ff0 53.B \-\-help\fR, \fB\-h
460b9539 54Display a usage message.
55.TP
0d350ff0 56.B \-\-version\fR, \fB\-V
460b9539 57Display version number.
58.SH NOTES
180dcdb0
RK
59For configuration file documentation, see
60.BR disorder_config (5).
67a9f4b4
RK
61.SS "Startup"
62The first time a new install of DisOrder is started it will run
460b9539 63.B disorder-rescan
c0c23a60
RK
64to pick up new tracks.
65On subsequent server restarts it will NOT do
67a9f4b4
RK
66this automatically; if you want a rescan at every restart you must
67arrange that manually.
68.PP
69There is however an automatic rescan once every 24 hours.
460b9539 70.PP
08ddd038 71A \fBroot\fR login is automatically created on startup if it does not
c0c23a60
RK
72exist.
73If \fBdisorder\fR(1) is run as root on the same machine as the
08ddd038
RK
74server it is capable of extracting the password from the database
75directly.
7a9edc82
RK
76.PP
77Therefore it is immediately possible to create other users with
78.B "disorder adduser"
79as root on the server machine.
80However it is likely to be preferable to get users to register
81themselves via the web interface; see
82.B setup-guest
83in
84.BR disorder (1)
85for more details on this.
86.SS "Logging"
87In its usual configuration, DisOrder logs to daemon.* via \fBsyslog\fR(3).
88Exactly where this ends up depends on the contents of
89.IR /etc/syslog.conf .
08ddd038 90.SS "Locales"
460b9539 91.B disorderd
c0c23a60
RK
92is locale-aware.
93If you do not set the locale correctly then it may not handle
94non-ASCII data properly.
460b9539 95.PP
96Filenames and the configuration file are assumed to be encoded using the
c0c23a60
RK
97current locale.
98Internally (within the server, in the database and in
67a9f4b4 99communication between client and server) the UTF-8 encoding is used.
460b9539 100.SS Backups
101DisOrder uses Berkeley DB but currently discards log files that are no longer
c0c23a60
RK
102in use.
103This means that DB's catastrophic recovery cannot be used (normal
460b9539 104recovery can be used, and indeed the server does this automatically on
105startup).
106.PP
107It is suggested that instead you just back up the output of
0d350ff0 108.BR disorder\-dump (8),
460b9539 109which saves only the parts of the database that cannot be regenerated
110automatically, and thus has relatively modest storage requirements.
111.SH SIGNALS
112.TP 8
113.B SIGHUP
114Re-read the configuration file.
115.TP
116.B SIGTERM
117Terminate the daemon gracefully.
118.TP
119.B SIGINT
120Terminate the daemon gracefully.
121.PP
122It may be more convenient to perform these operations from the client
123\fBdisorder\fR(1).
124.SH FILES
7a9edc82 125.SS "Configuration Files"
460b9539 126.TP
127.I pkgconfdir/config
c0c23a60
RK
128Global configuration file.
129See \fBdisorder_config\fR(5).
460b9539 130.TP
131.I pkgconfdir/config.private
7a9edc82 132Private configuration (now largely obsolete).
460b9539 133.TP
134.I ~/.disorder/passwd
135Per-user password file.
7a9edc82
RK
136.SS "Communication"
137.TP
138.I pkgstatedir/socket
139Communication socket for \fBdisorder\fR(1).
140See \fBdisorder_protocol\fR(5) for protocol documentation.
141.SS "Internal State"
142Don't modify these files, especially not while the server is running.
460b9539 143.TP
144.I pkgstatedir/queue
c0c23a60 145Saved copy of queue.
460b9539 146.TP
147.I pkgstatedir/recent
148Saved copy of recently played track list.
7a9edc82
RK
149.TP
150.I pkgstatedir/global.db
151Global preferences database.
152.TP
153.I pkgstatedir/noticed.db
154Records recently added tracks.
460b9539 155.TP
156.I pkgstatedir/prefs.db
157Preferences database.
158.TP
7a9edc82
RK
159.I pkgstatedir/schedule.db
160Database of scheduled tasks.
25ca855b 161.TP
460b9539 162.I pkgstatedir/search.db
25ca855b
RK
163Search lookup database.
164.TP
165.I pkgstatedir/tags.db
166Tag lookup database.
460b9539 167.TP
168.I pkgstatedir/tracks.db
169Tracks database.
170.TP
7a9edc82
RK
171.I pkgstatedir/users.db
172User database.
173.TP
460b9539 174.I pkgstatedir/DB_CONFIG
c0c23a60
RK
175Berkeley DB configuration file.
176This may be used to override database settings without recompiling
177DisOrder.
178See the Berkeley DB documention for further details.
460b9539 179.TP
25ca855b
RK
180.I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
181Database internal files.
460b9539 182.TP
7a9edc82
RK
183.I pkgstatedir/speaker/socket
184Socket for communication with \fBdisorder-speaker\fR(8).
460b9539 185.TP
186.I pkgstatedir/lock
c0c23a60
RK
187Lockfile.
188This prevents multiple instances of DisOrder running simultaneously.
460b9539 189.SH ENVIRONMENT
190.TP
191.B LC_ALL\fR, \fBLANG\fR, etc
c0c23a60
RK
192Current locale.
193See \fBlocale\fR(7).
460b9539 194.SH "SEE ALSO"
5c1ae3bc
RK
195\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder\-dump\fR(8),
196\fBdisorder.cgi\fR(8)
460b9539 197.\" Local Variables:
198.\" mode:nroff
199.\" End: