| 1 | .\" |
| 2 | .\" Copyright (C) 2004-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 disorder_config 5 |
| 20 | .SH NAME |
| 21 | pkgconfdir/config - DisOrder jukebox configuration |
| 22 | .SH DESCRIPTION |
| 23 | The purpose of DisOrder is to organize and play digital audio files, under the |
| 24 | control of multiple users. |
| 25 | \fIpkgconfdir/config\fR is the primary configuration file but this |
| 26 | man page currently documents all of its various configuration files. |
| 27 | .SS Tracks |
| 28 | DisOrder can be configured with multiple collections of tracks, indexing them |
| 29 | by their filename, and picking players on the basis of filename patterns (for |
| 30 | instance, "*.mp3"). |
| 31 | .PP |
| 32 | Although the model is of filenames, it is not inherent that there are |
| 33 | corresponding real files - merely that they can be interpreted by the chosen |
| 34 | player. |
| 35 | See \fBdisorder\fR(3) for more details about this. |
| 36 | .PP |
| 37 | Each track can have a set of preferences associated with it. |
| 38 | These are simple key-value pairs; they can be used for anything you |
| 39 | like, but a number of keys have specific meanings. |
| 40 | See \fBdisorder\fR(1) for more details about these. |
| 41 | .SS "Track Names" |
| 42 | Track names are derived from filenames under the control of regular |
| 43 | expressions, rather than attempting to interpret format-specific embedded name |
| 44 | information. |
| 45 | They can be overridden by setting preferences. |
| 46 | .PP |
| 47 | Names for display are distinguished from names for sorting, so with the right |
| 48 | underlying filenames an album can be displayed in its original order even if |
| 49 | the displayed track titles are not lexically sorted. |
| 50 | .SS "Server State" |
| 51 | A collection of global preferences define various bits of server state: whether |
| 52 | random play is enabled, what tags to check for when picking at random, etc. |
| 53 | .SS "Users And Access Control" |
| 54 | DisOrder distinguishes between multiple users. |
| 55 | This is for access control and reporting, not to provide different |
| 56 | views of the world: i.e. preferences and so on are global. |
| 57 | .PP |
| 58 | Each user has an associated set of rights which contorl which commands they may |
| 59 | execute. |
| 60 | Normally you would give all users most rights, and expect them to |
| 61 | cooperate (they are after all presumed to be in a shared sound environment). |
| 62 | .PP |
| 63 | The full set of rights are: |
| 64 | .TP |
| 65 | .B read |
| 66 | User can perform read-only operations |
| 67 | .TP |
| 68 | .B play |
| 69 | User can add tracks to the queue |
| 70 | .TP |
| 71 | .B "move any" |
| 72 | User can move any track |
| 73 | .TP |
| 74 | .B "move mine" |
| 75 | User can move their own tracks |
| 76 | .TP |
| 77 | .B "move random" |
| 78 | User can move randomly chosen tracks |
| 79 | .TP |
| 80 | .B "remove any" |
| 81 | User can remove any track |
| 82 | .TP |
| 83 | .B "remove mine" |
| 84 | User can remove their own tracks |
| 85 | .TP |
| 86 | .B "remove random" |
| 87 | User can remove randomly chosen tracks |
| 88 | .TP |
| 89 | .B "scratch any" |
| 90 | User can scratch any track |
| 91 | .TP |
| 92 | .B "scratch mine" |
| 93 | User can scratch their own tracks |
| 94 | .TP |
| 95 | .B "scratch random" |
| 96 | User can scratch randomly chosen tracks |
| 97 | .TP |
| 98 | .B volume |
| 99 | User can change the volume |
| 100 | .TP |
| 101 | .B admin |
| 102 | User can perform admin operations |
| 103 | .TP |
| 104 | .B rescan |
| 105 | User can initiate a rescan |
| 106 | .TP |
| 107 | .B register |
| 108 | User can register new users. |
| 109 | Normally only the |
| 110 | .B guest |
| 111 | user would have this right. |
| 112 | .TP |
| 113 | .B userinfo |
| 114 | User can edit their own userinfo |
| 115 | .TP |
| 116 | .B prefs |
| 117 | User can modify track preferences |
| 118 | .TP |
| 119 | .B "global prefs" |
| 120 | User can modify global preferences |
| 121 | .TP |
| 122 | .B pause |
| 123 | User can pause/resume |
| 124 | .PP |
| 125 | Access control is entirely used-based. |
| 126 | If you configure DisOrder to listen for TCP/IP connections then it will |
| 127 | accept a connection from anywhere provided the right password is |
| 128 | available. |
| 129 | Passwords are never transmitted over TCP/IP connections in clear, |
| 130 | but everything else is. |
| 131 | The expected model is that host-based access control is imposed at |
| 132 | the network layer. |
| 133 | .SS "Web Interface" |
| 134 | The web interface is controlled by a collection of template files, one for each |
| 135 | kind of page, and a collection of option files. |
| 136 | These are split up and separate from the main configuration file to |
| 137 | make it more convenient to override specific bits. |
| 138 | .PP |
| 139 | The web interface connects to the DisOrder server like any other user, though |
| 140 | it is given a special privilege to "become" any other user. |
| 141 | (Thus, any process with the same UID as the web interface is very |
| 142 | powerful as far as DisOrder goes. |
| 143 | This model will be changed in a future version.) |
| 144 | .PP |
| 145 | Access control to the web interface is (currently) separate from DisOrder's own |
| 146 | access control (HTTP authentication is required) but uses the same user |
| 147 | namespace. |
| 148 | .SS "Searching And Tags" |
| 149 | Search strings contain a list of search terms separated by spaces. |
| 150 | A search term can either be a single word or a tag, prefixed with "tag:". |
| 151 | .PP |
| 152 | Search words are compared without regard to letter case or accents; thus, all |
| 153 | of the following will be considered to be equal to one another: |
| 154 | .PP |
| 155 | .nf |
| 156 | LATIN CAPITAL LETTER E |
| 157 | LATIN SMALL LETTER E |
| 158 | LATIN CAPITAL LETTER E WITH GRAVE |
| 159 | LATIN SMALL LETTER E WITH GRAVE |
| 160 | LATIN CAPITAL LETTER E plus COMBINING GRAVE ACCENT |
| 161 | LATIN SMALL LETTER E plus COMBINING GRAVE ACCENT |
| 162 | .fi |
| 163 | .PP |
| 164 | The same rules apply to tags but in addition leading and trailing whitespace is |
| 165 | disregarded and all whitespace sequences are treated as equal when they appear |
| 166 | as internal whitespace. |
| 167 | .PP |
| 168 | Where several tags are listed, for instance the tags preference for a track, |
| 169 | the tags are separated by commas. |
| 170 | Therefore tags may not contain commas. |
| 171 | .SH "CONFIGURATION FILE" |
| 172 | .SS "General Syntax" |
| 173 | Lines are split into fields separated by whitespace (space, tab, line |
| 174 | feed, carriage return, form feed). |
| 175 | Comments are started by the number sign ("#"). |
| 176 | .PP |
| 177 | Fields may be unquoted (in which case they may not contain spaces and |
| 178 | may not start with a quotation mark or apostrophe) or quoted by either |
| 179 | quotation marks or apostrophes. |
| 180 | Inside quoted fields every character stands for itself, except that |
| 181 | a backslash can only appear as part of one of the following escape sequences: |
| 182 | .TP |
| 183 | .B \e\e |
| 184 | Backslash |
| 185 | .TP |
| 186 | .B \e" |
| 187 | Quotation mark |
| 188 | .\" " |
| 189 | .TP |
| 190 | .B \e' |
| 191 | Apostrophe |
| 192 | .TP |
| 193 | .B \en |
| 194 | Line feed |
| 195 | .PP |
| 196 | No other escape sequences are allowed. |
| 197 | .PP |
| 198 | Within any line the first field is a configuration command and any |
| 199 | further fields are parameters. |
| 200 | Lines with no fields are ignored. |
| 201 | .PP |
| 202 | After editing the config file use \fBdisorder reconfigure\fR to make |
| 203 | it re-read it. |
| 204 | If there is anything wrong with it the daemon will record a log |
| 205 | message and ignore the new config file. |
| 206 | (You should fix it before next terminating and restarting the daemon, |
| 207 | as it cannot start up without a valid config file.) |
| 208 | .SS "Configuration Files" |
| 209 | Configuration files are read in the following order: |
| 210 | .TP |
| 211 | .I pkgconfdir/config |
| 212 | .TP |
| 213 | .I pkgconfdir/config.private |
| 214 | Should be readable only by the jukebox group. |
| 215 | Not really useful any more and will be abolished in future. |
| 216 | .TP |
| 217 | .I ~\fRUSER\fI/.disorder/passwd |
| 218 | Per-user client configuration. |
| 219 | Optional but if it exists must be readable only by the relevant user. |
| 220 | Would normally contain a \fBpassword\fR directive. |
| 221 | .TP |
| 222 | .I pkgconfdir/config.\fRUSER |
| 223 | Per-user system-controlled client configuration. |
| 224 | Optional but if it exists must be readable only by the relevant user. |
| 225 | Would normally contain a \fBpassword\fR directive. |
| 226 | .IP |
| 227 | The prefererred location for per-user passwords is \fI~/.disorder/passwd\fR and |
| 228 | \fBdisorder authorize\fR writes there now. |
| 229 | .SS "Global Configuration" |
| 230 | .TP |
| 231 | .B home \fIDIRECTORY\fR |
| 232 | The home directory for state files. |
| 233 | Defaults to |
| 234 | .IR pkgstatedir . |
| 235 | The server will create this directory on startup if it does not exist. |
| 236 | .TP |
| 237 | .B plugins \fIPATH\fR |
| 238 | Adds a directory to the plugin path. |
| 239 | (This is also used by the web interface.) |
| 240 | .IP |
| 241 | Plugins are opened the first time they are required and never after, |
| 242 | so after changing a plugin you must restart the server before it is |
| 243 | guaranteed to take effect. |
| 244 | .IP |
| 245 | If |
| 246 | .B plugins |
| 247 | is used without arguments the plugin path is cleared. |
| 248 | .SS "Server Configuration" |
| 249 | .TP |
| 250 | .B alias \fIPATTERN\fR |
| 251 | Defines the pattern use construct virtual filenames from \fBtrackname_\fR |
| 252 | preferences. |
| 253 | .IP |
| 254 | Most characters stand for themselves, the exception being \fB{\fR which is used |
| 255 | to insert a track name part in the form \fB{\fIname\fB}\fR or |
| 256 | \fB{/\fIname\fB}\fR. |
| 257 | .IP |
| 258 | The difference is that the first form just inserts the name part while the |
| 259 | second prefixes it with a \fB/\fR if it is nonempty. |
| 260 | .IP |
| 261 | The pattern should not attempt to include the collection root, which is |
| 262 | automatically included, but should include the proper extension. |
| 263 | .IP |
| 264 | The default is \fB{/artist}{/album}{/title}{ext}\fR. |
| 265 | .TP |
| 266 | .B api \fINAME\fR |
| 267 | Selects the backend used to play sound and to set the volume. |
| 268 | The following options are available: |
| 269 | .RS |
| 270 | .TP |
| 271 | .B alsa |
| 272 | Use the ALSA API. |
| 273 | This is only available on Linux systems, on which it is the default. |
| 274 | .TP |
| 275 | .B coreaudio |
| 276 | Use Apple Core Audio. |
| 277 | This only available on OS X systems, on which it is the default. |
| 278 | .TP |
| 279 | .B oss |
| 280 | Use the OSS (/dev/dsp) API. |
| 281 | Not available on all platforms. |
| 282 | .TP |
| 283 | .B command |
| 284 | Execute a command. |
| 285 | This is the default if |
| 286 | .B speaker_command |
| 287 | is specified, or if no native is available. |
| 288 | .TP |
| 289 | .B network |
| 290 | Transmit audio over the network. |
| 291 | This is the default if \fBbroadcast\fR is specified. |
| 292 | You can use |
| 293 | .BR disorder-playrtp (1) |
| 294 | to receive and play the resulting stream on Linux and OS X. |
| 295 | .RE |
| 296 | .TP |
| 297 | .B authorization_algorithm \fIALGORITHM\fR |
| 298 | Defines the algorithm used to authenticate clients. |
| 299 | The valid options are sha1 (the default), sha256, sha384 and sha512. |
| 300 | See |
| 301 | .BR disorder_protocol (5) |
| 302 | for more details. |
| 303 | .TP |
| 304 | .B broadcast \fIADDRESS\fR \fIPORT\fR |
| 305 | Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. |
| 306 | This implies \fBapi network\fR. |
| 307 | .IP |
| 308 | See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR. |
| 309 | .TP |
| 310 | .B broadcast_from \fIADDRESS\fR \fIPORT\fR |
| 311 | Sets the (local) source address used by \fBbroadcast\fR. |
| 312 | .TP |
| 313 | .B channel \fICHANNEL\fR |
| 314 | The mixer channel that the volume control should use. |
| 315 | .IP |
| 316 | For \fBapi oss\fR the possible values are: |
| 317 | .RS |
| 318 | .TP 8 |
| 319 | .B pcm |
| 320 | Output level for the audio device. |
| 321 | This is probably what you want and is the default. |
| 322 | .TP |
| 323 | .B speaker |
| 324 | Output level for the PC speaker, if that is connected to the sound card. |
| 325 | .TP |
| 326 | .B pcm2 |
| 327 | Output level for alternative codec device. |
| 328 | .TP |
| 329 | .B vol |
| 330 | Master output level. |
| 331 | The OSS documentation recommends against using this, as it affects all |
| 332 | output devices. |
| 333 | .RE |
| 334 | .IP |
| 335 | You can also specify channels by number, if you know the right value. |
| 336 | .IP |
| 337 | For \fBapi alsa\fR, this is the name of the mixer control to use. |
| 338 | The default is \fBPCM\fR. |
| 339 | Use \fBamixer scontrols\fR or similar to get a full list. |
| 340 | .IP |
| 341 | For \fBapi coreaudio\fR, volume setting is not currently supported. |
| 342 | .TP |
| 343 | .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR |
| 344 | .TP |
| 345 | .B collection \fIMODULE\fR \fIROOT\fR |
| 346 | .TP |
| 347 | .B collection \fIROOT\fR |
| 348 | Define a collection of tracks. |
| 349 | .IP |
| 350 | \fIMODULE\fR defines which plugin module should be used for this |
| 351 | collection. |
| 352 | Use the supplied \fBfs\fR module for tracks that exist as ordinary |
| 353 | files in the filesystem. |
| 354 | If no \fIMODULE\fR is specified then \fBfs\fR is assumed. |
| 355 | .IP |
| 356 | \fIENCODING\fR defines the encoding of filenames in this collection. |
| 357 | For \fBfs\fR this would be the encoding you use for filenames. |
| 358 | Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR. |
| 359 | If no encoding is specified then the current locale's character encoding |
| 360 | is used. |
| 361 | .IP |
| 362 | NB that this default depends on the locale the server runs in, which is not |
| 363 | necessarily the same as that of ordinary users, depending how the system is |
| 364 | configured. |
| 365 | It's best to explicitly specify it to be certain. |
| 366 | .IP |
| 367 | \fIROOT\fR is the root in the filesystem of the filenames and is |
| 368 | passed to the plugin module. |
| 369 | It must be an absolute path and should not end with a "/". |
| 370 | .TP |
| 371 | .B cookie_key_lifetime \fISECONDS\fR |
| 372 | Lifetime of the signing key used in constructing cookies. The default is one |
| 373 | week. |
| 374 | .TP |
| 375 | .B cookie_login_lifetime \fISECONDS\fR |
| 376 | Lifetime of a cookie enforced by the server. When the cookie expires the user |
| 377 | will have to log in again even if their browser has remembered the cookie that |
| 378 | long. The default is one day. |
| 379 | .TP |
| 380 | .B default_rights \fIRIGHTS\fR |
| 381 | Defines the set of rights given to new users. |
| 382 | The argument is a comma-separated list of rights. |
| 383 | For the possible values see |
| 384 | .B "Users And Access Control" |
| 385 | above. |
| 386 | .IP |
| 387 | The default is to allow everything except \fBadmin\fR and \fBregister\fR |
| 388 | (modified in legacy configurations by the obsolete \fBrestrict\fR directive). |
| 389 | .TP |
| 390 | .B device \fINAME\fR |
| 391 | Sound output device. |
| 392 | .IP |
| 393 | For \fBapi oss\fR this is the path to the device to use. |
| 394 | If it is set to \fBdefault\fR then \fI/dev/dsp\fR and \fI/dev/audio\fR |
| 395 | will be tried. |
| 396 | .IP |
| 397 | For \fBapi alsa\fR this is the device name to use. |
| 398 | .IP |
| 399 | For \fBapi coreaudio\fR this is currently ignored. |
| 400 | .IP |
| 401 | The default is \fBdefault\fR, which is intended to map to whatever the system's |
| 402 | default is. |
| 403 | .TP |
| 404 | .B gap \fISECONDS\fR |
| 405 | Specifies the number of seconds to leave between tracks. |
| 406 | The default is 0. |
| 407 | .IP |
| 408 | NB this option currently DOES NOT WORK. If there is genuine demand it might be |
| 409 | reinstated. |
| 410 | .TP |
| 411 | .B history \fIINTEGER\fR |
| 412 | Specifies the number of recently played tracks to remember (including |
| 413 | failed tracks and scratches). |
| 414 | .TP |
| 415 | .B listen \fR[\fIHOST\fR] \fISERVICE\fR |
| 416 | Listen for connections on the address specified by \fIHOST\fR and port |
| 417 | specified by \fISERVICE\fR. |
| 418 | If \fIHOST\fR is omitted then listens on all local addresses. |
| 419 | .IP |
| 420 | Normally the server only listens on a UNIX domain socket. |
| 421 | .TP |
| 422 | .B lock yes\fR|\fBno |
| 423 | Determines whether the server locks against concurrent operation. |
| 424 | Default is \fByes\fR. |
| 425 | There is no good reason to set this to \fBno\fR and the option will |
| 426 | probably be removed in a future version. |
| 427 | .TP |
| 428 | .B mixer \fIDEVICE\fR |
| 429 | The mixer device name, if it needs to be specified separately from |
| 430 | \fBdevice\fR. |
| 431 | .IP |
| 432 | For \fBapi oss\fR this should be the path to the mixer device and the default |
| 433 | is \fI/dev/mixer\fR. |
| 434 | .IP |
| 435 | For \fBapi alsa\fR, this is the index of the mixer control to use. |
| 436 | The default is 0. |
| 437 | .IP |
| 438 | For \fBapi coreaudio\fR, volume setting is not currently supported. |
| 439 | .TP |
| 440 | .B multicast_loop yes\fR|\fBno |
| 441 | Determines whether multicast packets are loop backed to the sending host. |
| 442 | The default is \fByes\fR. |
| 443 | This only applies if \fBapi\fR is set to \fBnetwork\fR and \fBbroadcast\fR |
| 444 | is actually a multicast address. |
| 445 | .TP |
| 446 | .B multicast_ttl \fIHOPS\fR |
| 447 | Set the maximum number of hops to send multicast packets. |
| 448 | This only applies if \fBapi\fR is set to \fBnetwork\fR and |
| 449 | \fBbroadcast\fR is actually a multicast address. |
| 450 | The default is 1. |
| 451 | .TP |
| 452 | .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]] |
| 453 | Determines how to extract trackname part \fIPART\fR from a |
| 454 | track name (with the collection root part removed). |
| 455 | Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR. |
| 456 | .IP |
| 457 | Track names can be different in different contexts. |
| 458 | For instance the sort string might include an initial track number, |
| 459 | but this would be stripped for the display string. |
| 460 | \fICONTEXT\fR should be a glob pattern matching the |
| 461 | contexts in which this directive will be used. |
| 462 | .IP |
| 463 | Valid contexts are \fBsort\fR and \fBdisplay\fR. |
| 464 | .IP |
| 465 | All the \fBnamepart\fR directives are considered in order. |
| 466 | The first directive for the right part, that matches the desired context, |
| 467 | and with a \fIREGEXP\fR that |
| 468 | matches the track is used, and the value chosen is constructed from |
| 469 | \fISUBST\fR according to the substitution rules below. |
| 470 | .IP |
| 471 | Note that searches use the raw track name and \fBtrackname_\fR preferences but |
| 472 | not (currently) the results of \fBnamepart\fR, so generating words via this option |
| 473 | that aren't in the original track name will lead to confusing results. |
| 474 | .IP |
| 475 | If you supply no \fBnamepart\fR directives at all then a default set will be |
| 476 | supplied automatically. |
| 477 | But if you supply even one then you must supply all of them. |
| 478 | The defaults are equivalent to: |
| 479 | .PP |
| 480 | .nf |
| 481 | namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display |
| 482 | namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort |
| 483 | namepart album "/([^/]+)/[^/]+$" $1 * |
| 484 | namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 * |
| 485 | namepart ext "(\\.[a-zA-Z0-9]+)$" $1 * |
| 486 | .fi |
| 487 | .TP |
| 488 | .B new_max \fIMAX\fR |
| 489 | The maximum number of tracks to list when reporting newly noticed tracks. |
| 490 | The default is 100. |
| 491 | .TP |
| 492 | .B nice_rescan \fIPRIORITY\fR |
| 493 | Set the recan subprocess priority. |
| 494 | The default is 10. |
| 495 | .IP |
| 496 | (Note that higher values mean the process gets less CPU time; UNIX priority |
| 497 | values are backwards.) |
| 498 | .TP |
| 499 | .B nice_server \fIPRIORITY\fR |
| 500 | Set the server priority. |
| 501 | This is applied to the server at startup time (and not when you reload |
| 502 | configuration). |
| 503 | The server does not use much CPU itself but this value is inherited |
| 504 | by programs it executes. |
| 505 | If you have limited CPU then it might help to set this to a small |
| 506 | negative value. |
| 507 | The default is 0. |
| 508 | .TP |
| 509 | .B nice_speaker \fIPRIORITY\fR |
| 510 | Set the speaker process priority. |
| 511 | This is applied to the speaker process at startup time (and not when |
| 512 | you reload the configuration). |
| 513 | The speaker process is not massively CPU intensive by today's |
| 514 | standards but depends on reasonably timely scheduling. |
| 515 | If you have limited CPU then it might help to set this to a small |
| 516 | negative value. |
| 517 | The default is 0. |
| 518 | .TP |
| 519 | .B noticed_history |
| 520 | The maximum days that a track can survive in the database of newly added |
| 521 | tracks. |
| 522 | The default is 31. |
| 523 | .TP |
| 524 | .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR... |
| 525 | Specifies the player for files matching the glob \fIPATTERN\fR. |
| 526 | \fIMODULE\fR specifies which plugin module to use. |
| 527 | .IP |
| 528 | The following options are supported: |
| 529 | .RS |
| 530 | .TP |
| 531 | .B \-\-wait\-for\-device\fR[\fB=\fIDEVICE\fR] |
| 532 | Waits (for up to a couple of seconds) for the default, or specified, libao |
| 533 | device to become openable. |
| 534 | .TP |
| 535 | .B \-\- |
| 536 | Defines the end of the list of options. |
| 537 | Needed if the first argument to the plugin starts with a "\-". |
| 538 | .RE |
| 539 | .IP |
| 540 | The following are the standard modules: |
| 541 | .RS |
| 542 | .TP |
| 543 | .B exec \fICOMMAND\fR \fIARGS\fR... |
| 544 | The command is executed via \fBexecvp\fR(3), not via the shell. |
| 545 | The \fBPATH\fR environment variable is searched for the executable if it is not |
| 546 | an absolute path. |
| 547 | The command is expected to know how to open its own sound device. |
| 548 | .TP |
| 549 | .B execraw \fICOMMAND\fR \fIARGS\fR... |
| 550 | Identical to the \fBexec\fR except that the player is expected to use the |
| 551 | DisOrder raw player protocol. |
| 552 | .BR disorder-decode (8) |
| 553 | can decode several common audio file formats to this format. |
| 554 | If your favourite format is not supported, but you have a player |
| 555 | which uses libao, there is also a libao driver which supports this format; |
| 556 | see below for more information about this. |
| 557 | .TP |
| 558 | .B shell \fR[\fISHELL\fR] \fICOMMAND\fR |
| 559 | The command is executed using the shell. |
| 560 | If \fISHELL\fR is specified then that is used, otherwise \fBsh\fR will be used. |
| 561 | In either case the \fBPATH\fR environment variable is searched for the shell |
| 562 | executable if it is not an absolute path. |
| 563 | The track name is stored in the environment variable |
| 564 | \fBTRACK\fR. |
| 565 | .IP |
| 566 | Be careful of the interaction between the configuration file quoting rules and |
| 567 | the shell quoting rules. |
| 568 | .RE |
| 569 | .IP |
| 570 | If multiple player commands match a track then the first match is used. |
| 571 | .IP |
| 572 | For the server to be able to calculate track lengths, there should be a |
| 573 | .B tracklength |
| 574 | command corresponding to each |
| 575 | .B player |
| 576 | command. |
| 577 | .IP |
| 578 | If |
| 579 | .B player |
| 580 | is used without arguments, the list of players is cleared. |
| 581 | .TP |
| 582 | .B prefsync \fISECONDS\fR |
| 583 | The interval at which the preferences log file will be synchronised. |
| 584 | Defaults to 3600, i.e. one hour. |
| 585 | .TP |
| 586 | .B queue_pad \fICOUNT\fR |
| 587 | The target size of the queue. |
| 588 | If random play is enabled then randomly picked tracks will be added until |
| 589 | the queue is at least this big. |
| 590 | The default is 10. |
| 591 | .TP |
| 592 | .B reminder_interval \fISECONDS\fR |
| 593 | The minimum number of seconds that must elapse between password reminders. |
| 594 | The default is 600, i.e. 10 minutes. |
| 595 | .TP |
| 596 | .B replay_min \fISECONDS\fR |
| 597 | The minimum number of seconds that must elapse after a track has been played |
| 598 | before it can be picked at random. The default is 8 hours. If this is set to |
| 599 | 0 then there is no limit, though current \fBdisorder-choose\fR will not pick |
| 600 | anything currently listed in the recently-played list. |
| 601 | .TP |
| 602 | .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS |
| 603 | Describes the sample format expected by the \fBspeaker_command\fR (below). |
| 604 | The components of the format specification are as follows: |
| 605 | .RS |
| 606 | .TP 10 |
| 607 | .I BITS |
| 608 | The number of bits per sample. |
| 609 | Optionally, may be suffixed by \fBb\fR or \fBl\fR for big-endian and |
| 610 | little-endian words. |
| 611 | If neither is used the native byte order is assumed. |
| 612 | .TP |
| 613 | .I RATE |
| 614 | The number of samples per second. |
| 615 | .TP |
| 616 | .I CHANNELS |
| 617 | The number of channels. |
| 618 | .PP |
| 619 | The default is |
| 620 | .BR 16/44100/2 . |
| 621 | .PP |
| 622 | With the |
| 623 | .B network |
| 624 | backend the sample format is forced to |
| 625 | .B 16b/44100/2 |
| 626 | and with the |
| 627 | .B coreaudio |
| 628 | backend it is forced to |
| 629 | .BR 16/44100/2 , |
| 630 | in both cases regardless of what is specified in the configuration file. |
| 631 | .RE |
| 632 | .TP |
| 633 | .B signal \fINAME\fR |
| 634 | Defines the signal to be sent to track player process groups when tracks are |
| 635 | scratched. |
| 636 | The default is \fBSIGKILL\fR. |
| 637 | .IP |
| 638 | Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR |
| 639 | or \fBInterrupted\fR or whatever. |
| 640 | .TP |
| 641 | .B sox_generation \fB0\fR|\fB1 |
| 642 | Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if |
| 643 | the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1). |
| 644 | See the documentation for your installed copy of \fBsox\fR to determine |
| 645 | which you need. |
| 646 | The default is 0. |
| 647 | .TP |
| 648 | .B speaker_backend \fINAME |
| 649 | This is an alias for \fBapi\fR; see above. |
| 650 | .TP |
| 651 | .B speaker_command \fICOMMAND |
| 652 | Causes the speaker subprocess to pipe audio data into shell command |
| 653 | \fICOMMAND\fR, rather than writing to a local sound card. |
| 654 | The sample format is determine by |
| 655 | .B sample_format |
| 656 | above. |
| 657 | .IP |
| 658 | Note that if the sample format is wrong then |
| 659 | .BR sox (1) |
| 660 | is invoked to translate it. |
| 661 | If |
| 662 | .B sox |
| 663 | is not installed then this will not work. |
| 664 | .TP |
| 665 | .B scratch \fIPATH\fR |
| 666 | Specifies a scratch. |
| 667 | When a track is scratched, a scratch track is played at random. |
| 668 | Scratches are played using the same logic as other tracks. |
| 669 | .IP |
| 670 | At least for the time being, path names of scratches must be encoded using |
| 671 | UTF-8 (which means that ASCII will do). |
| 672 | .IP |
| 673 | If \fBscratch\fR is used without arguments then the list of scratches is |
| 674 | cleared. |
| 675 | .TP |
| 676 | .B stopword \fIWORD\fR ... |
| 677 | Specifies one or more stopwords that should not take part in searches |
| 678 | over track names. |
| 679 | .IP |
| 680 | If \fBstopword\fR is used without arguments then the list of stopwords is |
| 681 | cleared. |
| 682 | .IP |
| 683 | There is a default set of stopwords built in, but this option can be used to |
| 684 | augment or replace that list. |
| 685 | .TP |
| 686 | .B tracklength \fIPATTERN\fR \fIMODULE\fR |
| 687 | Specifies the module used to calculate the length of files matching |
| 688 | \fIPATTERN\fR. |
| 689 | \fIMODULE\fR specifies which plugin module to use. |
| 690 | .IP |
| 691 | If \fBtracklength\fR is used without arguments then the list of modules is |
| 692 | cleared. |
| 693 | .TP |
| 694 | .B user \fIUSER\fR |
| 695 | Specifies the user to run as. |
| 696 | Only makes sense if invoked as root (or the target user). |
| 697 | .SS "Client Configuration" |
| 698 | .TP |
| 699 | .B connect \fIHOST SERVICE\fR |
| 700 | Connect to the address specified by \fIHOST\fR and port specified by |
| 701 | \fISERVICE\fR. |
| 702 | .SS "Web Interface Configuration" |
| 703 | .TP |
| 704 | .B mail_sender \fIADDRESS\fR |
| 705 | The email address that appears in the From: field of any mail messages sent by |
| 706 | the web interface. |
| 707 | This must be set if you have online registration enabled. |
| 708 | .TP |
| 709 | .B refresh \fISECONDS\fR |
| 710 | Specifies the maximum refresh period in seconds. |
| 711 | Default 15. |
| 712 | .TP |
| 713 | .B short_display \fICHARACTERS\fR |
| 714 | Defines the maximum number of characters to include in a \fBshort\fR name |
| 715 | part. |
| 716 | Default 30. |
| 717 | .TP |
| 718 | .B smtp_server \fIHOSTNAME\fR |
| 719 | The hostname (or address) of the SMTP server to use for sending mail. |
| 720 | The default is 127.0.0.1. |
| 721 | .TP |
| 722 | .B templates \fIPATH\fR ... |
| 723 | Specifies the directory containing templates used by the web |
| 724 | interface. |
| 725 | If a template appears in more than one template directory |
| 726 | then the one in the earliest directory specified is chosen. |
| 727 | .IP |
| 728 | See below for further details. |
| 729 | .IP |
| 730 | If \fBtemplates\fR is used without arguments then the template path is cleared. |
| 731 | .TP |
| 732 | .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]] |
| 733 | Determines how names are sorted and displayed in track choice displays. |
| 734 | .IP |
| 735 | \fITYPE\fR is the type of transformation; usually \fBtrack\fR or |
| 736 | \fBdir\fR but you can define your own. |
| 737 | .IP |
| 738 | \fICONTEXT\fR is a glob pattern matching the context. |
| 739 | Standard contexts are \fBsort\fR (which determines how directory names |
| 740 | are sorted) and \fBdisplay\fR (which determines how they are displayed). |
| 741 | Again, you can define your own. |
| 742 | .IP |
| 743 | All the \fBtransform\fR directives are considered in order. |
| 744 | If the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match |
| 745 | then a new track name is constructed from |
| 746 | \fISUBST\fR according to the substitution rules below. |
| 747 | If several match then each is executed in order. |
| 748 | .IP |
| 749 | If you supply no \fBtransform\fR directives at all then a default set will be |
| 750 | supplied automatically. |
| 751 | But if you supply even one then you must supply all of them. |
| 752 | The defaults are: |
| 753 | .PP |
| 754 | .nf |
| 755 | transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display |
| 756 | transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort |
| 757 | transform dir "^.*/([^/]+)$" $1 * |
| 758 | transform dir "^(the) ([^/]*)" "$2 $1" sort i |
| 759 | transform dir "[[:punct:]]" "" sort g |
| 760 | .fi |
| 761 | .TP |
| 762 | .B url \fIURL\fR |
| 763 | Specifies the URL of the web interface. |
| 764 | This URL will be used in generated web pages. |
| 765 | The default is inferred at runtime, so this option no |
| 766 | longer needs to be specified. |
| 767 | .IP |
| 768 | This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not |
| 769 | \fB/cgi-bin/jukebox\fR. |
| 770 | .SS "Authentication Configuration" |
| 771 | These options would normally be used in \fI~\fRUSER\fI/.disorder/passwd\fR or |
| 772 | \fIpkgconfdir/config.\fRUSER. |
| 773 | .TP |
| 774 | .B password \fIPASSWORD\fR |
| 775 | Specify password. |
| 776 | .TP |
| 777 | .B username \fIUSERNAME\fR |
| 778 | Specify username. |
| 779 | The default is taken from the environment variable \fBLOGNAME\fR. |
| 780 | .SH "GLOBAL PREFERENCES" |
| 781 | These are the values set with \fBset\-global\fR. |
| 782 | .TP |
| 783 | .B required\-tags |
| 784 | If this is set an nonempty then randomly played tracks will always have at |
| 785 | least one of the listed tags. |
| 786 | .TP |
| 787 | .B prohibited\-tags |
| 788 | If this is set an nonempty then randomly played tracks will never have any of |
| 789 | the listed tags. |
| 790 | .TP |
| 791 | .B playing |
| 792 | If unset or \fByes\fR then play is enabled. |
| 793 | Otherwise it is disabled. |
| 794 | Use \fBdisable\fR rather than setting it directly. |
| 795 | .TP |
| 796 | .B random\-play |
| 797 | If unset or \fByes\fR then random play is enabled. |
| 798 | Otherwise it is disabled. |
| 799 | Use \fBdisable\fR rather than setting it directly. |
| 800 | .PP |
| 801 | Global preferences starting '_' are read-only (in the sense that you cannot |
| 802 | modify them; the server may modify them as part of its normal operation). |
| 803 | They are: |
| 804 | .TP |
| 805 | .B _dbversion |
| 806 | The database version string. |
| 807 | This is used by DisOrder to detect when it must |
| 808 | modify the database after an upgrade. |
| 809 | .SH "LIBAO DRIVER" |
| 810 | .SS "Raw Protocol Players" |
| 811 | Raw protocol players are expected to use the \fBdisorder\fR libao driver. |
| 812 | Programs that use libao generally have command line options to select the |
| 813 | driver and pass options to it. |
| 814 | .SS "Driver Options" |
| 815 | The known driver options are: |
| 816 | .TP |
| 817 | .B fd |
| 818 | The file descriptor to write to. |
| 819 | If this is not specified then the driver looks like the environment |
| 820 | variable \fBDISORDER_RAW_FD\fR. |
| 821 | If that is not set then the default is 1 (i.e. standard output). |
| 822 | .TP |
| 823 | .B fragile |
| 824 | If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a |
| 825 | write to the output file descriptor fails. |
| 826 | This is a workaround for buggy players such as \fBogg123\fR that ignore |
| 827 | write errors. |
| 828 | .SH "WEB TEMPLATES" |
| 829 | When \fBdisorder.cgi\fR wants to generate a page for an action it searches the |
| 830 | directories specified with \fBtemplates\fR for a matching file. |
| 831 | It is suggested that you leave the distributed templates unchanged and put |
| 832 | any customisations in an earlier entry in the template path. |
| 833 | .PP |
| 834 | The supplied templates are: |
| 835 | .TP |
| 836 | .B about.html |
| 837 | Display information about DisOrder. |
| 838 | .TP |
| 839 | .B choose.html |
| 840 | Navigates through the track database to choose a track to play. |
| 841 | The \fBdir\fR argument gives the directory to look in; if it is missing |
| 842 | then the root directory is used. |
| 843 | .TP |
| 844 | .B choosealpha.html |
| 845 | Provides a front end to \fBchoose.html\fR which allows subsets of the top level |
| 846 | directories to be selected by initial letter. |
| 847 | .TP |
| 848 | .B new.html |
| 849 | Lists newly added tracks. |
| 850 | .TP |
| 851 | .B playing.html |
| 852 | The "front page", which usually shows the currently playing tracks and |
| 853 | the queue. |
| 854 | Gets an HTTP \fBRefresh\fR header. |
| 855 | .IP |
| 856 | If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra |
| 857 | buttons for moving tracks up and down in the queue. |
| 858 | There is some logic in \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR |
| 859 | is preserved across refreshes and redirects back into itself, but |
| 860 | URLs embedded in web pages must include it explicitly. |
| 861 | .TP |
| 862 | .B prefs.html |
| 863 | Views preferences. |
| 864 | If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are |
| 865 | all set then that preference is modified; if \fBfile\fR and \fBname\fR are set |
| 866 | but not \fBvalue\fR then the preference is deleted. |
| 867 | .TP |
| 868 | .B recent.html |
| 869 | Lists recently played tracks. |
| 870 | .TP |
| 871 | .B search.html |
| 872 | Presents search results. |
| 873 | .TP |
| 874 | .B volume.html |
| 875 | Primitive volume control. |
| 876 | .PP |
| 877 | Additionally, other standard files are included by these: |
| 878 | .TP |
| 879 | .B credits.html |
| 880 | Included at the end of the main content \fB<DIV>\fR element. |
| 881 | .TP |
| 882 | .B topbar.html |
| 883 | Included at the start of the \fB<BODY>\fR element. |
| 884 | .TP |
| 885 | .B topbarend.html |
| 886 | Included at the end of the \fB<BODY>\fR element. |
| 887 | .TP |
| 888 | .B stdhead.html |
| 889 | Included in the \fB<HEAD>\fR element. |
| 890 | .TP |
| 891 | .B stylesheet.html |
| 892 | Contains the default DisOrder stylesheet. |
| 893 | You can override this by editing the CSS or by replacing it all with |
| 894 | a \fB<LINK>\fR to an external stylesheet. |
| 895 | .PP |
| 896 | Templates are ASCII files containing HTML documents, with an expansion |
| 897 | syntax to enable data supplied by the implementation to be inserted. |
| 898 | .PP |
| 899 | If you want to use characters outside the ASCII range, use either the |
| 900 | appropriate HTML entity, e.g. \fBé\fR, or an SGML numeric |
| 901 | character reference, e.g. \fBý\fR. |
| 902 | Use \fB@\fR to insert a literal \fB@\fR without falling foul of |
| 903 | the expansion syntax. |
| 904 | .SS "Expansion Syntax" |
| 905 | Expansions are surrounded by at ("@") symbols take the form of a keyword |
| 906 | followed by zero or more arguments. |
| 907 | Arguments may either be quoted by curly brackets ("{" and "}") or separated |
| 908 | by colons (":"). |
| 909 | Both kinds may be mixed in a single expansion, though doing so seems |
| 910 | likely to cause confusion. |
| 911 | The descriptions below contain suggested forms for each expansion. |
| 912 | .PP |
| 913 | Leading and trailing whitespace in unquoted arguments is ignored, as is |
| 914 | whitespace (including newlines) following a close bracket ("}"). |
| 915 | .PP |
| 916 | Arguments are recursively expanded before being interpreted, except for |
| 917 | \fITEMPLATE\fR arguments. |
| 918 | These are expanded (possibly more than once) to produce the final expansion. |
| 919 | (More than once means the same argument being expanded more than once |
| 920 | for different tracks or whatever, not the result of the first |
| 921 | expansion itself being re-expanded.) |
| 922 | .PP |
| 923 | Strings constructed by expansions (i.e. not literally copied from the template |
| 924 | text) are SGML-quoted: any character which does not stand for itself in #PCDATA |
| 925 | or a quoted attribute value is replaced by the appropriate numeric character |
| 926 | reference. |
| 927 | .PP |
| 928 | The exception to this is that such strings are \fInot\fR quoted when they are |
| 929 | generated in the expansion of a parameter. |
| 930 | .PP |
| 931 | In the descriptions below, the current track means the one set by |
| 932 | \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing. |
| 933 | If none of these expansions are in force then there is no current track. |
| 934 | \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR. |
| 935 | .SS "Expansions" |
| 936 | The following expansion keywords are defined: |
| 937 | .TP |
| 938 | .B @#{\fICOMMENT\fB}@ |
| 939 | Ignored. |
| 940 | .TP |
| 941 | .B @action@ |
| 942 | The current action. |
| 943 | This reports |
| 944 | .B manage |
| 945 | if the action is really |
| 946 | .B playing |
| 947 | but |
| 948 | .B mgmt=true |
| 949 | was set. |
| 950 | .TP |
| 951 | .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@ |
| 952 | If there are no arguments, or all the arguments are \fBtrue\fB, then expands to |
| 953 | \fBtrue\fR, otherwise to \fBfalse\fR. |
| 954 | .TP |
| 955 | .B @arg:\fINAME\fB@ |
| 956 | Expands to the value of CGI argument \fINAME\fR. |
| 957 | .TP |
| 958 | .B @basename@ |
| 959 | The basename of the current directory component, in \fB@navigate@\fR. |
| 960 | .TP |
| 961 | .B @basename{\fIPATH\fB}@ |
| 962 | The base name part of \fIPATH\fR. |
| 963 | .TP |
| 964 | .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@ |
| 965 | Expands \fITEMPLATE\fR repeatedly for each file or directory under |
| 966 | \fB@arg:directory@\fR. |
| 967 | \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR. |
| 968 | Use \fB@file@\fR to get the display name or filename of the file or |
| 969 | directory. |
| 970 | Usually used in \fBchoose.html\fR. |
| 971 | .TP |
| 972 | .B @dirname@ |
| 973 | The directory of the current directory component, in \fB@navigate@\fR. |
| 974 | .TP |
| 975 | .B @dirname{\fIPATH\fB}@ |
| 976 | The directory part of \fIPATH\fR. |
| 977 | .TP |
| 978 | .B @enabled@ |
| 979 | Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR. |
| 980 | .TP |
| 981 | .B @eq{\fIA\fB}{\fIB\fB} |
| 982 | Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to |
| 983 | \fBfalse\fR. |
| 984 | .TP |
| 985 | .B @file@ |
| 986 | Expands to the filename of the current file or directory, inside the template |
| 987 | argument to \fBchoose\fR. |
| 988 | .TP |
| 989 | .B @files{\fITEMPLATE\fB} |
| 990 | Expands \fITEMPLATE\fR once for each file indicated by the \fBdirectory\fR CGI |
| 991 | arg if it is present, or otherwise for the list of files counted by \fBfiles\fR |
| 992 | with names \fB0_file\fR, \fB1_file\fR etc. |
| 993 | .TP |
| 994 | .B @fullname@ |
| 995 | The full path of the current directory component, in \fB@navigate@\fR. |
| 996 | .TP |
| 997 | .B @id@ |
| 998 | The ID of the current track. |
| 999 | .TP |
| 1000 | .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@ |
| 1001 | If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise |
| 1002 | to \fIFALSEPART\fR (which may be omitted). |
| 1003 | .TP |
| 1004 | .B @image:\fINAME\fB@ |
| 1005 | Expands to the (possibly relative) URL for image \fINAME\fR. |
| 1006 | .IP |
| 1007 | If there is a label \fBimages.\fINAME\fR then that will be the image base name. |
| 1008 | Otherwise the image base name is \fINAME\fB.png\fR or just \fINAME\fR if it |
| 1009 | alraedy has an extension. |
| 1010 | Thus labels may be defined to give images role names. |
| 1011 | .IP |
| 1012 | If there is a label \fBurl.static\fR then that is the base URL for images. |
| 1013 | If it is not defined then \fB/disorder\fR is used as a default. |
| 1014 | .TP |
| 1015 | .B @include:\fIPATH\fB@ |
| 1016 | Include the named file as if it were a template file. |
| 1017 | If \fIPATH\fR starts with a \fB/\fR then it is used as-is; |
| 1018 | otherwise, ".html" is appended and the template path is searched. |
| 1019 | .TP |
| 1020 | .B @index@ |
| 1021 | Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or |
| 1022 | \fB@files@\fR. |
| 1023 | .TP |
| 1024 | .B @isdirectories@ |
| 1025 | Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR, |
| 1026 | otherwise to \fBfalse\fR. |
| 1027 | .TP |
| 1028 | .B @isfiles@ |
| 1029 | Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR, |
| 1030 | otherwise to \fBfalse\fR. |
| 1031 | .TP |
| 1032 | .B @isfirst@ |
| 1033 | Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR |
| 1034 | argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR. |
| 1035 | .TP |
| 1036 | .B @islast@ |
| 1037 | Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a |
| 1038 | loop, otherwise to \fBfalse\fR. |
| 1039 | .TP |
| 1040 | .B @isnew@ |
| 1041 | Expands to \fBtrue\fR if the newly added tracks list has any tracks in it, |
| 1042 | otherwise to \fBfalse\fR. |
| 1043 | .TP |
| 1044 | .B @isplaying@ |
| 1045 | Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR. |
| 1046 | .TP |
| 1047 | .B @isqueue@ |
| 1048 | Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to |
| 1049 | \fBfalse\fR. |
| 1050 | .TP |
| 1051 | .B @isrecent@ |
| 1052 | Expands to \fBtrue\fR if the recently played list has any tracks in it, |
| 1053 | otherwise to \fBfalse\fR. |
| 1054 | .TP |
| 1055 | .B @label:\fINAME\fR\fB@ |
| 1056 | Expands to the value of label \fINAME\fR. |
| 1057 | See the shipped \fIoptions.labels\fR file for full documentation of the |
| 1058 | labels used by the standard templates. |
| 1059 | .TP |
| 1060 | .B @length@ |
| 1061 | Expands to the length of the current track. |
| 1062 | .TP |
| 1063 | .B @movable@ |
| 1064 | Expands to \fBtrue\fR if the current track is movable, otherwise to |
| 1065 | \fBfalse\fR. |
| 1066 | .TP |
| 1067 | .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB} |
| 1068 | Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn. |
| 1069 | Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to |
| 1070 | each component. |
| 1071 | Usually used in \fBchoose.html\fR. |
| 1072 | .TP |
| 1073 | .B @ne{\fIA\fB}{\fIB\fB} |
| 1074 | Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR. |
| 1075 | .TP |
| 1076 | .B @new{\fITEMPLATE\fB} |
| 1077 | Expands \fITEMPLATE\fR for each track in the newly added tracks list, starting |
| 1078 | with the most recent. |
| 1079 | Used in \fBnew.html\fR. |
| 1080 | .TP |
| 1081 | .B @nfiles@ |
| 1082 | Expands to the number of files from \fB@files\fR (above). |
| 1083 | .TP |
| 1084 | .B @nonce@ |
| 1085 | Expands to a string including the time and process ID, intended to be |
| 1086 | unique across invocations. |
| 1087 | .TP |
| 1088 | .B @not{\fIBOOL\fB}@ |
| 1089 | Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to |
| 1090 | \fBfalse\fR. |
| 1091 | .TP |
| 1092 | .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@ |
| 1093 | If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise |
| 1094 | to \fBfalse\fR. |
| 1095 | .TP |
| 1096 | .B @parity@ |
| 1097 | Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at |
| 1098 | an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR. |
| 1099 | .TP |
| 1100 | .B @part{\fICONTEXT\fB}{\fIPART\fB}@ |
| 1101 | Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the |
| 1102 | current track. |
| 1103 | The context may be omitted and defaults to \fBdisplay\fR. |
| 1104 | .IP |
| 1105 | The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to |
| 1106 | the \fBshort_display\fR limit. |
| 1107 | .TP |
| 1108 | .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@ |
| 1109 | Expands to track name part \fIPART\fR using context \fICONTEXT\fR for |
| 1110 | \fITRACK\fR. |
| 1111 | In this usage the context may not be omitted. |
| 1112 | .IP |
| 1113 | The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to |
| 1114 | the \fBshort_display\fR limit. |
| 1115 | .TP |
| 1116 | .B @paused@ |
| 1117 | Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR. |
| 1118 | .TP |
| 1119 | .B @playing{\fITEMPLATE\fB}@ |
| 1120 | Expands \fITEMPLATE\fR using the playing track as the current track. |
| 1121 | .TP |
| 1122 | .B @pref{\fITRACK\fB}{\fIKEY\fB}@ |
| 1123 | Expand to the track preference, or the empty string if it is not set. |
| 1124 | .TP |
| 1125 | .B @prefname@ |
| 1126 | Expands to the name of the current preference, in the template |
| 1127 | argument of \fB@prefs@\fR. |
| 1128 | .TP |
| 1129 | .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@ |
| 1130 | Expands \fITEMPLATE\fR repeatedly, for each preference of track |
| 1131 | \fIFILE\fR. |
| 1132 | Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value. |
| 1133 | .TP |
| 1134 | .B @prefvalue@ |
| 1135 | Expands to the value of the current preference, in the template |
| 1136 | argument of \fB@prefs@\fR. |
| 1137 | .TP |
| 1138 | .B @queue{\fITEMPLATE\fB}@ |
| 1139 | Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as |
| 1140 | the current track. |
| 1141 | The track at the head of the queue comes first. |
| 1142 | .TP |
| 1143 | .B @random\-enabled@ |
| 1144 | Expands to \fBtrue\fR if random play is currently enabled, otherwise to |
| 1145 | \fBfalse\fR. |
| 1146 | .TP |
| 1147 | .B @recent{\fITEMPLATE\fB}@ |
| 1148 | Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn |
| 1149 | as the current track. |
| 1150 | The most recently played track comes first. |
| 1151 | .TP |
| 1152 | .B @removable@ |
| 1153 | Expands to \fBtrue\fR if the current track is removable, otherwise to |
| 1154 | \fBfalse\fR. |
| 1155 | .TP |
| 1156 | .B @resolve{\fITRACK\fB}@ |
| 1157 | Resolve aliases for \fITRACK\fR and expands to the result. |
| 1158 | .TP |
| 1159 | .B @right{\fIRIGHT\fB}@ |
| 1160 | Exapnds to \fBtrue\fR if the user has right \fIRIGHT\fR, otherwise to |
| 1161 | \fBfalse\fR. |
| 1162 | .TP |
| 1163 | .B @right{\fIRIGHT\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@ |
| 1164 | Expands to \fITRUEPART\fR if the user right \fIRIGHT\fR, otherwise to |
| 1165 | \fIFALSEPART\fR (which may be omitted). |
| 1166 | .TP |
| 1167 | .B @scratchable@ |
| 1168 | Expands to \fBtrue\fR if the currently playing track is scratchable, otherwise |
| 1169 | to \fBfalse\fR. |
| 1170 | .TP |
| 1171 | .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@ |
| 1172 | Expands \fITEMPLATE\fR once for each group of search results that have |
| 1173 | a common value of track part \fIPART\fR. |
| 1174 | The groups are sorted by the value of the part. |
| 1175 | .IP |
| 1176 | .B @part@ |
| 1177 | and |
| 1178 | .B @file@ |
| 1179 | within the template will apply to one of the tracks in the group. |
| 1180 | .IP |
| 1181 | If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR, |
| 1182 | and determines the context for \fIPART\fR. |
| 1183 | The default is \fBsort\fR. |
| 1184 | Usually you want \fBdisplay\fR for everything except the title and |
| 1185 | \fBsort\fR for the title. |
| 1186 | If you use \fBsort\fR for artist and album then you are likely to get |
| 1187 | strange effects. |
| 1188 | .TP |
| 1189 | .B @server\-version@ |
| 1190 | Expands to the server's version string. |
| 1191 | .TP |
| 1192 | .B @shell{\fICOMMAND\fB}@ |
| 1193 | Expands to the output of \fICOMMAND\fR executed via the shell. |
| 1194 | \fBsh\fR is searched for using \fBPATH\fR. |
| 1195 | If the command fails then this is logged but otherwise ignored. |
| 1196 | .TP |
| 1197 | .B @state@ |
| 1198 | In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current |
| 1199 | track. |
| 1200 | Otherwise the empty string. |
| 1201 | Known states are: |
| 1202 | .RS |
| 1203 | .TP 12 |
| 1204 | .B failed |
| 1205 | The player terminated with nonzero status, but not because the track was |
| 1206 | scratched. |
| 1207 | .TP |
| 1208 | .B isscratch |
| 1209 | A scratch, in the queue. |
| 1210 | .TP |
| 1211 | .B no_player |
| 1212 | No player could be found. |
| 1213 | .TP |
| 1214 | .B ok |
| 1215 | Played successfully. |
| 1216 | .TP |
| 1217 | .B random |
| 1218 | A randomly chosen track, in the queue. |
| 1219 | .TP |
| 1220 | .B scratched |
| 1221 | This track was scratched. |
| 1222 | .TP |
| 1223 | .B unplayed |
| 1224 | An explicitly queued track, in the queue. |
| 1225 | .RE |
| 1226 | .IP |
| 1227 | Some additional states only apply to playing tracks, so will never be seen in |
| 1228 | the queue or recently-played list: |
| 1229 | .RS |
| 1230 | .TP 12 |
| 1231 | .B paused |
| 1232 | The track has been paused. |
| 1233 | .TP |
| 1234 | .B quitting |
| 1235 | Interrupted because the server is shutting down. |
| 1236 | .TP |
| 1237 | .B started |
| 1238 | This track is currently playing. |
| 1239 | .RE |
| 1240 | .TP |
| 1241 | .B @stats@ |
| 1242 | Expands to the server statistics. |
| 1243 | .TP |
| 1244 | .B @thisurl@ |
| 1245 | Expands to the URL of the current page. |
| 1246 | Typically used in |
| 1247 | .B back |
| 1248 | arguments. |
| 1249 | If there is a |
| 1250 | .B nonce |
| 1251 | argument then it is changed to a fresh value. |
| 1252 | .TP |
| 1253 | .B @track@ |
| 1254 | The current track. |
| 1255 | .TP |
| 1256 | .B @trackstate{\fIPATH\fB}@ |
| 1257 | Expands to the current track state: \fBplaying\fR if the track is actually |
| 1258 | playing now, \fBqueued\fR if it is queued or the empty string otherwise. |
| 1259 | .TP |
| 1260 | .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@ |
| 1261 | Transform a path according to \fBtransform\fR (see above). |
| 1262 | \fIPATH\fR should be a raw filename (of a track or directory). |
| 1263 | \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR). |
| 1264 | \fICONTEXT\fR should be the context, and can be omitted (the default |
| 1265 | is \fBdisplay\fR). |
| 1266 | .TP |
| 1267 | .B @url@ |
| 1268 | Expands to the canonical URL as defined in \fIpkgconfdir/config\fR. |
| 1269 | .TP |
| 1270 | .B @urlquote{\fISTRING\fB}@ |
| 1271 | URL-quote \fISTRING\fR. |
| 1272 | .TP |
| 1273 | .B @user@ |
| 1274 | The current username. |
| 1275 | This will be "guest" if nobody is logged in. |
| 1276 | .TP |
| 1277 | .B @userinfo{\fIPROPERTY\fB}@ |
| 1278 | Look up a property of the logged-in user. |
| 1279 | .TP |
| 1280 | .B @version@ |
| 1281 | Expands to \fBdisorder.cgi\fR's version string. |
| 1282 | .TP |
| 1283 | .B @volume:\fISPEAKER\fB@ |
| 1284 | The volume on the left or right speaker. |
| 1285 | \fISPEAKER\fR must be \fBleft\fR or \fBright\fR. |
| 1286 | .TP |
| 1287 | .B @when@ |
| 1288 | When the current track was played (or when it is expected to be played, if it |
| 1289 | has not been played yet) |
| 1290 | .TP |
| 1291 | .B @who@ |
| 1292 | Who submitted the current track. |
| 1293 | .SH "WEB OPTIONS" |
| 1294 | This is a file called \fIoptions\fR, searched for in the same manner |
| 1295 | as templates. |
| 1296 | It includes numerous options for the control of the web interface. |
| 1297 | The general syntax is the same as the main configuration |
| 1298 | file, except that it should be encoded using UTF-8 (though this might |
| 1299 | change to the current locale's character encoding; stick to ASCII to |
| 1300 | be safe). |
| 1301 | .PP |
| 1302 | The shipped \fIoptions\fR file includes four standard options files. |
| 1303 | In order, they are: |
| 1304 | .TP |
| 1305 | .I options.labels |
| 1306 | The default labels file. |
| 1307 | You wouldn't normally edit this directly - instead supply your own commands |
| 1308 | in \fIoptions.user\fR. |
| 1309 | Have a look at the shipped version of the file for documentation of |
| 1310 | labels used by the standard templates. |
| 1311 | .TP |
| 1312 | .I options.user |
| 1313 | A user options file. |
| 1314 | Here you should put any overrides for the default labels and any |
| 1315 | extra labels required by your modified templates. |
| 1316 | .PP |
| 1317 | Valid directives are: |
| 1318 | .TP |
| 1319 | .B columns \fINAME\fR \fIHEADING\fR... |
| 1320 | Defines the columns used in \fB@playing@\fR and \fB@recent@\fB. |
| 1321 | \fINAME\fR must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR. |
| 1322 | \fIHEADING\fR... is a list of heading names. |
| 1323 | If a column is defined more than once then the last definitions is used. |
| 1324 | .IP |
| 1325 | The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR |
| 1326 | are built in. |
| 1327 | .TP |
| 1328 | .B include \fIPATH\fR |
| 1329 | Includes another file. |
| 1330 | If \fIPATH\fR starts with a \fB/\fR then it is taken as is, otherwise |
| 1331 | it is searched for in the template path. |
| 1332 | .TP |
| 1333 | .B label \fINAME\fR \fIVALUE\fR |
| 1334 | Define a label. |
| 1335 | If a label is defined more than once then the last definition is used. |
| 1336 | .SS Labels |
| 1337 | Some labels are defined inside \fBdisorder.cgi\fR and others by the |
| 1338 | default templates. |
| 1339 | You can define your own labels and use them inside a template. |
| 1340 | .PP |
| 1341 | When an undefined label is expanded, if it has a dot in its name then |
| 1342 | the part after the final dot is used as its value. |
| 1343 | Otherwise the whole name is used as the value. |
| 1344 | .PP |
| 1345 | Labels are no longer documented here, see the shipped \fIoptions.labels\fR file |
| 1346 | instead. |
| 1347 | .SH "REGEXP SUBSTITUTION RULES" |
| 1348 | Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3). |
| 1349 | The only option used is \fBPCRE_UTF8\fR. |
| 1350 | Remember that the configuration file syntax means you have to |
| 1351 | escape backslashes and quotes inside quoted strings. |
| 1352 | .PP |
| 1353 | In a \fISUBST\fR string the following sequences are interpreted |
| 1354 | specially: |
| 1355 | .TP |
| 1356 | .B $1 \fR... \fB$9 |
| 1357 | These expand to the first to ninth bracketed subexpression. |
| 1358 | .TP |
| 1359 | .B $& |
| 1360 | This expands to the matched part of the subject string. |
| 1361 | .TP |
| 1362 | .B $$ |
| 1363 | This expands to a single \fB$\fR symbol. |
| 1364 | .PP |
| 1365 | All other pairs starting with \fB$\fR are undefined (and might be used |
| 1366 | for something else in the future, so don't rely on the current |
| 1367 | behaviour.) |
| 1368 | .PP |
| 1369 | If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent. |
| 1370 | If \fBg\fR is present then all matches are replaced, otherwise only the first |
| 1371 | match is replaced. |
| 1372 | .SH "ACTIONS" |
| 1373 | What the web interface actually does is terminated by the \fBaction\fR CGI |
| 1374 | argument. |
| 1375 | The values listed below are supported. |
| 1376 | .PP |
| 1377 | Except as specified, all actions redirect back to the \fBplaying.html\fR |
| 1378 | template unless the \fBback\fR argument is present, in which case the URL it |
| 1379 | gives is used instead. |
| 1380 | .PP |
| 1381 | Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present. |
| 1382 | .TP 8 |
| 1383 | .B "move" |
| 1384 | Move track \fBid\fR by offset \fBdelta\fR. |
| 1385 | .TP |
| 1386 | .B "play" |
| 1387 | Play track \fBfile\fR, or if that is missing then play all the tracks in |
| 1388 | \fBdirectory\fR. |
| 1389 | .TP |
| 1390 | .B "playing" |
| 1391 | Don't change any state, but instead compute a suitable refresh time and include |
| 1392 | that in an HTTP header. |
| 1393 | Expands the \fBplaying.html\fR template rather than redirecting. |
| 1394 | .IP |
| 1395 | This is the default if \fBaction\fR is missing. |
| 1396 | .TP |
| 1397 | .B "random\-disable" |
| 1398 | Disables random play. |
| 1399 | .TP |
| 1400 | .B "random\-enable" |
| 1401 | Enables random play. |
| 1402 | .TP |
| 1403 | .B "disable" |
| 1404 | Disables play completely. |
| 1405 | .TP |
| 1406 | .B "enable" |
| 1407 | Enables play. |
| 1408 | .TP |
| 1409 | .B "pause" |
| 1410 | Pauses the current track. |
| 1411 | .TP |
| 1412 | .B "remove" |
| 1413 | Remove track \fBid\fR. |
| 1414 | .TP |
| 1415 | .B "resume" |
| 1416 | Resumes play after a pause. |
| 1417 | .TP |
| 1418 | .B "scratch" |
| 1419 | Scratch the playing track. |
| 1420 | If \fBid\fR is present it must match the playing track. |
| 1421 | .TP |
| 1422 | .B "volume" |
| 1423 | Change the volume by \fBdelta\fR, or if that is missing then set it to the |
| 1424 | values of \fBleft\fR and \fBright\fR. |
| 1425 | Expands to the \fBvolume.html\fR template rather than redirecting. |
| 1426 | .TP |
| 1427 | .B "prefs" |
| 1428 | Adjust preferences from the \fBprefs.html\fR template (which it then expands |
| 1429 | rather than redirecting). |
| 1430 | .IP |
| 1431 | If |
| 1432 | .B parts |
| 1433 | is set then the cooked interface is assumed. |
| 1434 | The value of |
| 1435 | .B parts |
| 1436 | is used to determine which trackname preferences are set. |
| 1437 | By default the |
| 1438 | .B display |
| 1439 | context is adjusted but this can be overridden with the |
| 1440 | .B context |
| 1441 | argument. |
| 1442 | Also the |
| 1443 | .B random |
| 1444 | argument is checked; if it is set then random play is enabled for that track, |
| 1445 | otherwise it is disabled. |
| 1446 | .IP |
| 1447 | Otherwise if the |
| 1448 | .B name |
| 1449 | and |
| 1450 | .B value |
| 1451 | arguments are set then they are used to set a single preference. |
| 1452 | .IP |
| 1453 | Otherwise if just the |
| 1454 | .B name |
| 1455 | argument is set then that preference is deleted. |
| 1456 | .IP |
| 1457 | It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to |
| 1458 | enure that the real track name is always used. |
| 1459 | Otherwise if the preferences page is used to adjust a trackname_ preference, |
| 1460 | the alias may change, leading to the URL going stale. |
| 1461 | .TP |
| 1462 | .B "error" |
| 1463 | This action is generated automatically when an error occurs connecting to the |
| 1464 | server. |
| 1465 | The \fBerror\fR label is set to an indication of what the error is. |
| 1466 | .SH "TRACK NAME PARTS" |
| 1467 | The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR, |
| 1468 | with the obvious intended meaning. |
| 1469 | These are controlled by configuration and by \fBtrackname_\fR preferences. |
| 1470 | .PP |
| 1471 | In addition there are two built-in parts, \fBpath\fR which is the whole path |
| 1472 | name and \fBext\fR which is the filename extension, including the initial dot |
| 1473 | (or the empty string if there is not extension). |
| 1474 | .SH "SEE ALSO" |
| 1475 | \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8), |
| 1476 | \fBpcrepattern\fR(3) |
| 1477 | .\" Local Variables: |
| 1478 | .\" mode:nroff |
| 1479 | .\" fill-column:79 |
| 1480 | .\" End: |