| | 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 | .SS "Locales" |
| | 79 | .B disorderd |
| | 80 | is locale-aware. |
| | 81 | If you do not set the locale correctly then it may not handle |
| | 82 | non-ASCII data properly. |
| | 83 | .PP |
| | 84 | Filenames and the configuration file are assumed to be encoded using the |
| | 85 | current locale. |
| | 86 | 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. |
| | 91 | This means that DB's catastrophic recovery cannot be used (normal |
| | 92 | recovery can be used, and indeed the server does this automatically on |
| | 93 | startup). |
| | 94 | .PP |
| | 95 | It is suggested that instead you just back up the output of |
| | 96 | .BR disorder\-dump (8), |
| | 97 | which saves only the parts of the database that cannot be regenerated |
| | 98 | automatically, and thus has relatively modest storage requirements. |
| | 99 | .SH SIGNALS |
| | 100 | .TP 8 |
| | 101 | .B SIGHUP |
| | 102 | Re-read the configuration file. |
| | 103 | .TP |
| | 104 | .B SIGTERM |
| | 105 | Terminate the daemon gracefully. |
| | 106 | .TP |
| | 107 | .B SIGINT |
| | 108 | Terminate the daemon gracefully. |
| | 109 | .PP |
| | 110 | It may be more convenient to perform these operations from the client |
| | 111 | \fBdisorder\fR(1). |
| | 112 | .SH FILES |
| | 113 | .TP |
| | 114 | .I pkgconfdir/config |
| | 115 | Global configuration file. |
| | 116 | See \fBdisorder_config\fR(5). |
| | 117 | .TP |
| | 118 | .I pkgconfdir/config.private |
| | 119 | Private configuration (usernames and passwords). |
| | 120 | .TP |
| | 121 | .I ~/.disorder/passwd |
| | 122 | Per-user password file. |
| | 123 | .TP |
| | 124 | .I pkgstatedir/queue |
| | 125 | Saved copy of queue. |
| | 126 | Do not edit while the daemon is running. |
| | 127 | .TP |
| | 128 | .I pkgstatedir/recent |
| | 129 | Saved copy of recently played track list. |
| | 130 | Do not edit while the daemon is running. |
| | 131 | .TP |
| | 132 | .I pkgstatedir/prefs.db |
| | 133 | Preferences database. |
| | 134 | .TP |
| | 135 | .I pkgstatedir/global.db |
| | 136 | Global preferences database. |
| | 137 | .TP |
| | 138 | .I pkgstatedir/search.db |
| | 139 | Search lookup database. |
| | 140 | .TP |
| | 141 | .I pkgstatedir/tags.db |
| | 142 | Tag lookup database. |
| | 143 | .TP |
| | 144 | .I pkgstatedir/tracks.db |
| | 145 | Tracks database. |
| | 146 | .TP |
| | 147 | .I pkgstatedir/DB_CONFIG |
| | 148 | Berkeley DB configuration file. |
| | 149 | This may be used to override database settings without recompiling |
| | 150 | DisOrder. |
| | 151 | See the Berkeley DB documention for further details. |
| | 152 | .TP |
| | 153 | .I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.* |
| | 154 | Database internal files. |
| | 155 | .TP |
| | 156 | .I pkgstatedir/socket |
| | 157 | Communication socket for \fBdisorder\fR(1). |
| | 158 | .TP |
| | 159 | .I pkgstatedir/lock |
| | 160 | Lockfile. |
| | 161 | This prevents multiple instances of DisOrder running simultaneously. |
| | 162 | .SH ENVIRONMENT |
| | 163 | .TP |
| | 164 | .B LC_ALL\fR, \fBLANG\fR, etc |
| | 165 | Current locale. |
| | 166 | See \fBlocale\fR(7). |
| | 167 | .SH "SEE ALSO" |
| | 168 | \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder\-dump\fR(8), |
| | 169 | \fBdisorder.cgi\fR(8) |
| | 170 | .\" Local Variables: |
| | 171 | .\" mode:nroff |
| | 172 | .\" End: |
~mdw / disorder / blame_incremental