chiark - git - mdw - disorder/blob - doc/disorderd.8.in

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