| 1 | .\" |
| 2 | .\" Copyright (C) 2004, 2005 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 | .SS "How To Configure Authentication" |
| 69 | The administrator should create \fIpkgconfdir/config.private\fR, make sure it |
| 70 | is not world-readable, and populate it with \fBallow\fR commands |
| 71 | listing usernames and passwords. Use |
| 72 | e.g. \fBpwgen\fR(1) to generate random passwords. Passwords should |
| 73 | then be distributed to users. |
| 74 | .PP |
| 75 | Each user should create the file \fI~/.disorder/passwd\fR |
| 76 | and make sure it is not world-readable. Having done so |
| 77 | they should add a \fBpassword\fR command to it giving their password (and |
| 78 | optionally a \fBusername\fR command if their DisOrder username is not the |
| 79 | same as their login name). |
| 80 | .SS Locales |
| 81 | .B disorderd |
| 82 | is locale-aware. If you do not set the locale correctly then it may |
| 83 | not handle non-ASCII data properly. |
| 84 | .PP |
| 85 | Filenames and the configuration file are assumed to be encoded using the |
| 86 | current locale. Internally (within the server, in the database and in |
| 87 | communication between client and server) the UTF-8 encoding is used. |
| 88 | .SS Backups |
| 89 | DisOrder uses Berkeley DB but currently discards log files that are no longer |
| 90 | in use. This means that DB's catastrophic recovery cannot be used (normal |
| 91 | recovery can be used, and indeed the server does this automatically on |
| 92 | startup). |
| 93 | .PP |
| 94 | It is suggested that instead you just back up the output of |
| 95 | .BR disorder-dump (8), |
| 96 | which saves only the parts of the database that cannot be regenerated |
| 97 | automatically, and thus has relatively modest storage requirements. |
| 98 | .SH SIGNALS |
| 99 | .TP 8 |
| 100 | .B SIGHUP |
| 101 | Re-read the configuration file. |
| 102 | .TP |
| 103 | .B SIGTERM |
| 104 | Terminate the daemon gracefully. |
| 105 | .TP |
| 106 | .B SIGINT |
| 107 | Terminate the daemon gracefully. |
| 108 | .PP |
| 109 | It may be more convenient to perform these operations from the client |
| 110 | \fBdisorder\fR(1). |
| 111 | .SH FILES |
| 112 | .TP |
| 113 | .I pkgconfdir/config |
| 114 | Global configuration file. See \fBdisorder_config\fR(5). |
| 115 | .TP |
| 116 | .I pkgconfdir/config.private |
| 117 | Private configuration (usernames and passwords). |
| 118 | .TP |
| 119 | .I ~/.disorder/passwd |
| 120 | Per-user password file. |
| 121 | .TP |
| 122 | .I pkgstatedir/queue |
| 123 | Saved copy of queue. Do not edit while the daemon is running. |
| 124 | .TP |
| 125 | .I pkgstatedir/recent |
| 126 | Saved copy of recently played track list. |
| 127 | Do not edit while the daemon is running. |
| 128 | .TP |
| 129 | .I pkgstatedir/prefs.db |
| 130 | Preferences database. |
| 131 | .TP |
| 132 | .I pkgstatedir/global.db |
| 133 | Global preferences database. |
| 134 | .TP |
| 135 | .I pkgstatedir/search.db |
| 136 | Search lookup database. |
| 137 | .TP |
| 138 | .I pkgstatedir/tags.db |
| 139 | Tag lookup database. |
| 140 | .TP |
| 141 | .I pkgstatedir/tracks.db |
| 142 | Tracks database. |
| 143 | .TP |
| 144 | .I pkgstatedir/DB_CONFIG |
| 145 | Berkeley DB configuration file. This may be used to override database |
| 146 | settings without recompiling DisOrder. See the Berkeley DB |
| 147 | documention for further details. |
| 148 | .TP |
| 149 | .I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.* |
| 150 | Database internal files. |
| 151 | .TP |
| 152 | .I pkgstatedir/socket |
| 153 | Communication socket for \fBdisorder\fR(1). |
| 154 | .TP |
| 155 | .I pkgstatedir/lock |
| 156 | Lockfile. This prevents multiple instances of DisOrder running |
| 157 | simultaneously. |
| 158 | .SH ENVIRONMENT |
| 159 | .TP |
| 160 | .B LC_ALL\fR, \fBLANG\fR, etc |
| 161 | Current locale. See \fBlocale\fR(7). |
| 162 | .SH "SEE ALSO" |
| 163 | \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder-dump\fR(8) |
| 164 | .\" Local Variables: |
| 165 | .\" mode:nroff |
| 166 | .\" End: |