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

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