| 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 | .IR pkgconfdir/config . |
| 33 | See |
| 34 | .BR disorder_config (5) |
| 35 | for further information. |
| 36 | .TP |
| 37 | .B \-\-pidfile \fIPATH\fR, \fB\-P \fIPATH |
| 38 | Write a pidfile. |
| 39 | .TP |
| 40 | .B \-\-foreground\fR, \fB\-f |
| 41 | Run in the foreground. |
| 42 | (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. |
| 48 | This is the default if DisOrder runs in the background. |
| 49 | .TP |
| 50 | .B \-\-debug\fR, \fB\-d |
| 51 | Enable debugging. |
| 52 | .TP |
| 53 | .B \-\-help\fR, \fB\-h |
| 54 | Display a usage message. |
| 55 | .TP |
| 56 | .B \-\-version\fR, \fB\-V |
| 57 | Display version number. |
| 58 | .SH NOTES |
| 59 | For configuration file documentation, see |
| 60 | .BR disorder_config (5). |
| 61 | .SS "Startup" |
| 62 | The first time a new install of DisOrder is started it will run |
| 63 | .B disorder-rescan |
| 64 | to pick up new tracks. |
| 65 | On subsequent server restarts it will NOT do |
| 66 | this automatically; if you want a rescan at every restart you must |
| 67 | arrange that manually. |
| 68 | .PP |
| 69 | There is however an automatic rescan once every 24 hours. |
| 70 | .PP |
| 71 | A \fBroot\fR login is automatically created on startup if it does not |
| 72 | exist. |
| 73 | If \fBdisorder\fR(1) is run as root on the same machine as the |
| 74 | server it is capable of extracting the password from the database |
| 75 | directly. |
| 76 | .PP |
| 77 | Therefore it is immediately possible to create other users with |
| 78 | .B "disorder adduser" |
| 79 | as root on the server machine. |
| 80 | However it is likely to be preferable to get users to register |
| 81 | themselves via the web interface; see |
| 82 | .B setup-guest |
| 83 | in |
| 84 | .BR disorder (1) |
| 85 | for more details on this. |
| 86 | .SS "Logging" |
| 87 | In its usual configuration, DisOrder logs to daemon.* via \fBsyslog\fR(3). |
| 88 | Exactly where this ends up depends on the contents of |
| 89 | .IR /etc/syslog.conf . |
| 90 | .SS "Locales" |
| 91 | .B disorderd |
| 92 | is locale-aware. |
| 93 | If you do not set the locale correctly then it may not handle |
| 94 | non-ASCII data properly. |
| 95 | .PP |
| 96 | Filenames and the configuration file are assumed to be encoded using the |
| 97 | current locale. |
| 98 | Internally (within the server, in the database and in |
| 99 | communication between client and server) the UTF-8 encoding is used. |
| 100 | .SS Backups |
| 101 | DisOrder uses Berkeley DB but currently discards log files that are no longer |
| 102 | in use. |
| 103 | This means that DB's catastrophic recovery cannot be used (normal |
| 104 | recovery can be used, and indeed the server does this automatically on |
| 105 | startup). |
| 106 | .PP |
| 107 | It is suggested that instead you just back up the output of |
| 108 | .BR disorder\-dump (8), |
| 109 | which saves only the parts of the database that cannot be regenerated |
| 110 | automatically, and thus has relatively modest storage requirements. |
| 111 | .SH SIGNALS |
| 112 | .TP 8 |
| 113 | .B SIGHUP |
| 114 | Re-read the configuration file. |
| 115 | .IP |
| 116 | Not all configuration options can be modified during the lifetime of the |
| 117 | server; of those that can't, some will just be ignored if they change while |
| 118 | others will cause the new configuration to be rejected. |
| 119 | See \fBdisorder_config\fR(5) for details. |
| 120 | .TP |
| 121 | .B SIGTERM |
| 122 | Terminate the daemon gracefully. |
| 123 | .TP |
| 124 | .B SIGINT |
| 125 | Terminate the daemon gracefully. |
| 126 | .PP |
| 127 | It may be more convenient to perform these operations from the client |
| 128 | \fBdisorder\fR(1). |
| 129 | .SH FILES |
| 130 | .SS "Configuration Files" |
| 131 | .TP |
| 132 | .I pkgconfdir/config |
| 133 | Global configuration file. |
| 134 | See \fBdisorder_config\fR(5). |
| 135 | .TP |
| 136 | .I pkgconfdir/config.private |
| 137 | Private configuration (now largely obsolete). |
| 138 | .TP |
| 139 | .I ~/.disorder/passwd |
| 140 | Per-user password file. |
| 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 LC_ALL\fR, \fBLANG\fR, etc |
| 197 | Current locale. |
| 198 | See \fBlocale\fR(7). |
| 199 | .SH "SEE ALSO" |
| 200 | \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder\-dump\fR(8), |
| 201 | \fBdisorder.cgi\fR(8) |
| 202 | .\" Local Variables: |
| 203 | .\" mode:nroff |
| 204 | .\" End: |