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