2 .\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
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.
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.
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
21 pkgconfdir/config - DisOrder jukebox configuration
23 The purpose of DisOrder is to organize and play digital audio files, under the
24 control of multiple users. \fIpkgconfdir/config\fR is the primary
25 configuration file but this man page currently documents all of its various
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
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. See \fBdisorder\fR(3) for more details about this.
36 Each track can have a set of preferences associated with it. These are simple
37 key-value pairs; they can be used for anything you like, but a number of keys
38 have specific meanings. See \fBdisorder\fR(1) for more details about these.
40 Track names are derived from filenames under the control of regular
41 expressions, rather than attempting to interpret format-specific embedded name
42 information. They can be overridden by setting preferences.
44 Names for display are distinguished from names for sorting, so with the right
45 underlying filenames an album can be displayed in its original order even if
46 the displayed track titles are not lexically sorted.
48 A collection of global preferences define various bits of server state: whether
49 random play is enabled, what tags to check for when picking at random, etc.
50 .SS "Users And Access Control"
51 DisOrder distinguishes between multiple users. This is for access control and
52 reporting, not to provide different views of the world: i.e. preferences and so
55 It's possible to restrict a small number of operations to a specific subset of
56 users. However, it is assumed that every user is supposed to be able to do
57 most operations - since the users are all sharing the same audio environment
58 they are expected to cooperate with each other.
60 Access control is entirely used-based. If you configure DisOrder to listen for
61 TCP/IP connections then it will accept a connection from anywhere provided the
62 right password is available. Passwords are never transmitted over TCP/IP
63 connections in clear, but everything else is. The expected model is that
64 host-based access control is imposed at the network layer.
66 The web interface is controlled by a collection of template files, one for each
67 kind of page, and a collection of option files. These are split up and
68 separate from the main configuration file to make it more convenient to
69 override specific bits.
71 The web interface connects to the DisOrder server like any other user, though
72 it is given a special privilege to "become" any other user. (Thus, any process
73 with the same UID as the web interface is very powerful as far as DisOrder
76 Access control to the web interface is (currently) separate from DisOrder's own
77 access control (HTTP authentication is required) but uses the same user
79 .SH "CONFIGURATION FILE"
81 Lines are split into fields separated by whitespace (space, tab, line
82 feed, carriage return, form feed). Comments are started by the number
85 Fields may be unquoted (in which case they may not contain spaces and
86 may not start with a quotation mark or apostrophe) or quoted by either
87 quotation marks or apostrophes. Inside quoted fields every character
88 stands for itself, except that a backslash can only appear as part of
89 one of the following escape sequences:
104 No other escape sequences are allowed.
106 Within any line the first field is a configuration command and any
107 further fields are parameters. Lines with no fields are ignored.
109 After editing the config file use \fBdisorder reconfigure\fR to make
110 it re-read it. If there is anything wrong with it the daemon will
111 record a log message and ignore the new config file. (You should fix
112 it before next terminating and restarting the daemon, as it cannot
113 start up without a valid config file.)
114 .SS "Global Configuration"
116 .B home \fIDIRECTORY\fR
117 The home directory for state files. Defaults to
121 Adds a directory to the plugin path. (This is also used by the web
124 Plugins are opened the first time they are required and never after,
125 so after changing a plugin you must restart the server before it is
126 guaranteed to take effect.
127 .SS "Server Configuration"
129 .B alias \fIPATTERN\fR
130 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
133 Most characters stand for themselves, the exception being \fB{\fR which is used
134 to insert a track name part in the form \fB{\fIname\fB}\fR or
137 The difference is that the first form just inserts the name part while the
138 second prefixes it with a \fB/\fR if it is nonempty.
140 The pattern should not attempt to include the collection root, which is
141 automatically included, but should include the proper extension.
143 The default is \fB{/artist}{/album}{/title}{ext}\fR.
145 .B broadcast \fIADDRESS\fR \fIPORT\fR
146 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. This implies
147 \fBspeaker_backend network\fR.
149 .B broadcast_from \fIADDRESS\fR \fIPORT\fR
150 Sets the (local) source address used by \fBbroadcast\fR.
152 .B channel \fICHANNEL\fR
153 The mixer channel that the volume control should use. Valid names depend on
154 your operating system and hardware, but some standard ones that might be useful
159 Output level for the audio device. This is probably what you want.
162 Output level for the PC speaker, if that is connected to the sound card.
165 Output level for alternative codec device.
168 Master output level. The OSS documentation recommends against using this, as
169 it affects all output devices.
172 You can also specify channels by number, if you know the right value.
174 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
175 Define a collection of tracks.
177 \fIMODULE\fR defines which plugin module should be used for this
178 collection. Use the supplied \fBfs\fR module for tracks that exists
179 as ordinary files in the filesystem.
181 \fIENCODING\fR defines the encoding of filenames in this collection.
182 For \fBfs\fR this would be the encoding you use for filenames.
183 Examples might be \fBiso-8859-1\fR or \fButf-8\fR.
185 \fIROOT\fR is the root in the filesystem of the filenames and is
186 passed to the plugin module.
189 ALSA device to play raw-format audio. Default is \fBdefault\fR, i.e. to use
190 the whatever the ALSA configured default is.
193 Specifies the number of seconds to leave between tracks. The default
196 .B history \fIINTEGER\fR
197 Specifies the number of recently played tracks to remember (including
198 failed tracks and scratches).
200 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
201 Listen for connections on the address specified by \fIHOST\fR and port
202 specified by \fISERVICE\fR. If \fIHOST\fR is omitted then listens on all
205 Normally the server only listens on a UNIX domain socket.
208 Determines whether the server locks against concurrent operation. Default is
212 The path to the mixer device, if you want access to the volume control,
213 e.g. \fB/dev/mixer\fR.
215 .B multicast_ttl \fIHOPS\fR
216 Set the maximum number of hops to send multicast packets. This only applies is
217 \fBspeaker_backend\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
220 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
221 Determines how to extract trackname part \fIPART\fR from a
222 track name (with the collection root part removed).
223 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
225 Track names can be different in different contexts. For instance the sort
226 string might include an initial track number, but this would be stripped for
227 the display string. \fICONTEXT\fR should be a glob pattern matching the
228 contexts in which this directive will be used.
230 Valid contexts are \fBsort\fR and \fBdisplay\fR.
232 All the \fBnamepart\fR directives are considered in order. The
233 first directive for the right part, that matches the desired context,
234 and with a \fIREGEXP\fR that
235 matches the track is used, and the value chosen is constructed from
236 \fISUBST\fR according to the substitution rules below.
238 Note that searches use the raw track name and \fBtrackname_\fR preferences but
239 not (currently) the results of \fBnamepart\fR, so generating words via this option
240 that aren't in the original track name will lead to confusing results.
242 If you supply no \fBnamepart\fR directives at all then a default set will be
243 supplied automatically. But if you supply even one then you must supply all of
244 them. See the example config file for the defaults.
246 .B nice_rescan \fIPRIORITY\fR
247 Set the recan subprocess priority. The default is 10.
249 (Note that higher values mean the process gets less CPU time; UNIX priority
250 values are the backwards.)
252 .B nice_server \fIPRIORITY\fR
253 Set the server priority. This is applied to the server at startup time (and
254 not when you reload configuration). The server does not use much CPU itself
255 but this value is inherited by programs it executes. If you have limited CPU
256 then it might help to set this to a small negative value. The default is 0.
258 .B nice_speaker \fIPRIORITY\fR
259 Set the speaker process priority. This is applied to the speaker process at
260 startup time (and not when you reload the configuration). The speaker process
261 is not massively CPU intensive by today's standards but depends on reasonably
262 timely scheduling. If you have limited CPU then it might help to set this to a
263 small negative value. The default is 0.
265 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
266 Specifies the player for files matching the glob \fIPATTERN\fR. \fIMODULE\fR
267 specifies which plugin module to use.
269 The following options are supported:
272 .B --wait-for-device\fR[\fB=\fIDEVICE\fR]
273 Waits (for up to a couple of seconds) for the default, or specified, libao
274 device to become openable.
277 Defines the end of the list of options. Needed if the first argument to the
278 plugin starts with a "-".
281 The following are the standard modules:
284 .B exec \fICOMMAND\fR \fIARGS\fR...
285 The command is executed via \fBexecvp\fR(3), not via the shell.
286 The \fBPATH\fR environment variable is searched for the executable if it is not
288 The command is expected to know how to open its own sound device.
290 .B execraw \fICOMMAND\fR \fIARGS\fR...
291 Identical to the \fBexec\fR except that the player is expected to use the
292 DisOrder raw player protocol (see notes below).
294 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
295 The command is executed using the shell. If \fISHELL\fR is specified then that
296 is used, otherwise \fBsh\fR will be used. In either case the \fBPATH\fR
297 environment variable is searched for the shell executable if it is not an
298 absolute path. The track name is stored in the environment variable
301 Be careful of the interaction between the configuration file quoting rules and
302 the shell quoting rules.
305 If multiple player commands match a track then the first match is used.
307 .B prefsync \fISECONDS\fR
308 The interval at which the preferences log file will be synchronised. Defaults
309 to 3600, i.e. one hour.
311 .B queue_pad \fICOUNT\fR
312 The target size of the queue. If random play is enabled then randomly picked
313 tracks will be added until the queue is at least this big.
315 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
316 Describes the sample format expected by the \fBspeaker_command\fR (below). The
317 components of the format specification are as follows:
321 The number of bits per sample. Optionally, may be suffixed by \fBb\fR or
322 \fBl\fR for big-endian and little-endian words. If neither is used the native
323 byte order is assumed.
326 The number of samples per second.
329 The number of channels.
336 Defines the signal to be sent to track player process groups when tracks are
337 scratched. The default is \fBSIGKILL\fR.
339 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
340 or \fBInterrupted\fR or whatever.
342 .B speaker_backend \fINAME\fR
343 Selects the backend use by the speaker process. The following options are
348 Use the ALSA API. This is only available on Linux systems, on which it is the
352 Execute a command. This is the default if
354 is specified, or (currently) on non-Linux systems.
357 Transmit audio over the network. This is the default if
358 \fBbroadcast\fR is specified. You can use
359 .BR disorder-playrtp (1)
360 to receive and play the resulting stream on Linux and OS X.
363 .B sox_generation \fB0\fR|\fB1
364 Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
365 the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1). The default
368 .B speaker_command \fICOMMAND
369 Causes the speaker subprocess to pipe audio data into shell command
370 \fICOMMAND\fR, rather than writing to a local sound card. The sample format is
375 Note that if the sample format is wrong then
377 is invoked to translate it. If
379 is not installed then this will not work.
381 .B restrict \fR[\fBscratch\fR] [\fBremove\fR] [\fBmove\fR]
382 Determine which operations are restricted to the submitter of a
383 track. By default, no operations are restricted, i.e. anyone can
384 scratch or remove anything.
386 If \fBrestrict scratch\fR or \fBrestrict remove\fR are set then only the user
387 that submitted a track can scratch or remove it, respectively.
389 If \fBrestrict move\fR is set then only trusted users can move tracks around in
392 If \fBrestrict\fR is used more than once then only the final use has any
395 .B scratch \fIPATH\fR
396 Specifies a scratch. When a track is scratched, a scratch track is
398 Scratches are played using the same logic as other tracks.
400 At least for the time being, path names of scratches must be encoded using
401 UTF-8 (which means that ASCII will do).
403 .B stopword \fIWORD\fR ...
404 Specifies one or more stopwords that should not take part in searches
406 .SS "Client Configuration"
408 .B connect \fR[\fIHOST\fR] \fISERVICE\fR
409 Connect to the address specified by \fIHOST\fR and port specified by
410 \fISERVICE\fR. If \fIHOST\fR is omitted then connects to the local host.
411 Normally the UNIX domain socket is used instead.
412 .SS "Web Interface Configuration"
414 .B refresh \fISECONDS\fR
415 Specifies the maximum refresh period in seconds. Default 15.
417 .B templates \fIPATH\fR ...
418 Specifies the directory containing templates used by the web
419 interface. If a template appears in more than one template directory
420 then the one in the earliest directory specified is chosen.
422 See below for further details.
424 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
425 Determines how names are sorted and displayed in track choice displays.
427 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
428 \fBdir\fR but you can define your own.
430 \fICONTEXT\fR is a glob pattern matching the context. Standard contexts are
431 \fBsort\fR (which determines how directory names are sorted) and \fBdisplay\fR
432 (which determines how they are displayed). Again, you can define your
435 All the \fBtransform\fR directives are considered in order. If
436 the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
437 then a new track name is constructed from
438 \fISUBST\fR according to the substitution rules below. If several
439 match then each is executed in order.
441 If you supply no \fBtransform\fR directives at all then a default set will be
442 supplied automatically. But if you supply even one then you must supply all of
443 them. See the example config file for the defaults.
446 Specifies the URL of the web interface. This URL will be used in
449 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
450 \fB/cgi-bin/jukebox\fR.
451 .SS "Authentication Configuration"
453 .B allow \fIUSERNAME\fR \fIPASSWORD\fR
454 Specify a username/password pair.
456 .B password \fIPASSWORD\fR
459 .B trust \fIUSERNAME\fR
460 Allow \fIUSERNAME\fR to perform privileged operations such as shutting
461 down or reconfiguring the daemon, or becoming another user.
464 Specifies the user to run as. Only makes sense if invoked as root (or
467 .B username \fIUSERNAME\fR
468 Specify username. The default is taken from the environment variable
471 Configuration files are read in the following order:
475 .I pkgconfdir/config.private
476 Should be readable only by the jukebox group, and contain \fBallow\fR
477 commands for authorised users.
479 .I pkgconfdir/config.\fRUSER
480 Per-user system-controlled client configuration. Optional but if it
481 exists must be readable only by the relevant user. Would normally
482 contain a \fBpassword\fR directive.
484 .I ~\fRUSER\fI/.disorder/passwd
485 Per-user client configuration. Optional but if it exists must be
486 readable only by the relevant user. Would normally contain a
487 \fBpassword\fR directive.
488 .SH "GLOBAL PREFERENCES"
489 These are the values set with \fBset-global\fR.
492 If this is set an nonempty then randomly played tracks will always have at
493 least one of the listed tags.
495 Tags can contain any printing character except comma. Leading and trailing
496 spaces are not significant but internal spaces are. Tags in a list are
500 If this is set an nonempty then randomly played tracks will never have any of
504 If unset or \fByes\fR then play is enabled. Otherwise it is disabled. Use
505 \fBdisable\fR rather than setting it directly.
508 If unset or \fByes\fR then random play is enabled. Otherwise it is disabled.
509 Use \fBdisable\fR rather than setting it directly.
511 .SS "Raw Protocol Players"
512 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
513 Programs that use libao generally have command line options to select the
514 driver and pass options to it.
516 The known driver options are:
519 The file descriptor to write to. If this is not specified then the driver
520 looks like the environment variable \fBDISORDER_RAW_FD\fR. If that is not set
521 then the default is 1 (i.e. standard output).
524 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
525 write to the output file descriptor fails. This is a workaround for buggy
526 players such as \fBogg123\fR that ignore write errors.
528 When \fBdisorder.cgi\fR wants to generate a page for an action it searches the
529 directories specified with \fBtemplates\fR for a matching file. It is
530 suggested that you leave the distributed templates unchanged and put
531 any customisations in an earlier entry in the template path.
533 The supplied templates are:
536 Display information about DisOrder.
539 Navigates through the track database to choose a track to play. The
540 \fBdir\fR argument gives the directory to look in; if it is missing
541 then the root directory is used.
544 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
545 directories to be selected by initial letter.
548 The "front page", which usually shows the currently playing tracks and
550 Gets an HTTP \fBRefresh\fR header.
552 If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra
553 buttons for moving tracks up and down in the queue. There is some logic in
554 \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR is preserved across refreshes
555 and redirects back into itself, but URLs embedded in web pages must include it
559 Views preferences. If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are
560 all set then that preference is modified; if \fBfile\fR and \fBname\fR are set
561 but not \fBvalue\fR then the preference is deleted.
564 Lists recently played tracks.
567 Presents search results.
570 Primitive volume control.
572 Additionally, other standard files are included by these:
575 Included at the end of the main content \fB<DIV>\fR element.
578 Included at the start of the \fB<BODY>\fR element.
581 Included in the \fB<HEAD>\fR element.
584 Contains the default DisOrder stylesheet. You can override this by editing the
585 CSS or by replacing it all with a \fB<LINK>\fR to an external stylesheet.
587 Templates are ASCII files containing HTML documents, with an expansion
588 syntax to enable data supplied by the implementation to be inserted.
590 If you want to use characters outside the ASCII range, use either the
591 appropriate HTML entity, e.g. \fBé\fR, or an SGML numeric
592 character reference, e.g. \fBý\fR. Use \fB@\fR to insert a
593 literal \fB@\fR without falling foul of the expansion syntax.
594 .SS "Expansion Syntax"
595 Expansions are surrounded by at ("@") symbols take the form of a keyword
596 followed by zero or more arguments. Arguments may either be quoted by curly
597 brackets ("{" and "}") or separated by colons (":"). Both kinds may be mixed
598 in a single expansion, though doing so seems likely to cause confusion.
599 The descriptions below contain suggested forms for each
602 Leading and trailing whitespace in unquoted arguments is ignored, as is
603 whitespace (including newlines) following a close bracket ("}").
605 Arguments are recursively expanded before being interpreted, except for
606 \fITEMPLATE\fR arguments. These are expanded (possibly more than once) to
607 produce the final expansion.
608 (More than once means the same argument being expanded more than once
609 for different tracks or whatever, not the result of the first
610 expansion itself being re-expanded.)
612 Strings constructed by expansions (i.e. not literally copied from the template
613 text) are SGML-quoted: any character which does not stand for itself in #PCDATA
614 or a quoted attribute value is replaced by the appropriate numeric character
617 The exception to this is that such strings are \fInot\fR quoted when they are
618 generated in the expansion of a parameter.
620 In the descriptions below, the current track means the one set by
621 \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing.
622 If none of these expansions are in force then there is no current track.
623 \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR.
625 The following expansion keywords are defined:
627 .B @#{\fICOMMENT\fB}@
631 The current action. This reports
633 if the action is really
639 .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
640 If there are no arguments, or all the arguments are \fBtrue\fB, then expands to
641 \fBtrue\fR, otherwise to \fBfalse\fR.
644 Expands to the value of CGI script argument \fINAME\fR.
647 The basename of the current directory component, in \fB@navigate@\fR.
649 .B @basename{\fIPATH\fB}@
650 The base name part of \fIPATH\fR.
652 .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@
653 Expands \fITEMPLATE\fR repeatedly for each file or directory under
654 \fB@arg:directory@\fR.
655 \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR.
656 Use \fB@file@\fR to get the display name or filename of the file or
658 Usually used in \fBchoose.html\fR.
661 The directory of the current directory component, in \fB@navigate@\fR.
663 .B @dirname{\fIPATH\fB}@
664 The directory part of \fIPATH\fR.
667 Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR.
669 .B @eq{\fIA\fB}{\fIB\fB}
670 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to
674 Expands to the filename of the current file or directory, inside the template
675 argument to \fBchoose\fR.
677 .B @files{\fITEMPLATE\fB}
678 Expands \fITEMPLATE\fB once for each file indicated by the \fBdirectory\fR CGI
679 arg if it is present, or otherwise for the list of files counted by \fBfiles\fR
680 with names \fB0_file\fR, \fB1_file\fR etc.
683 The full path of the current directory component, in \fB@navigate@\fR.
686 The ID of the current track.
688 .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
689 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
690 to \fIFALSEPART\fR (which may be omitted).
692 .B @include:\fIPATH\fR@
693 Include the named file as if it were a template file. If \fIPATH\fR
694 starts with a \fB/\fR then it is used as-is; otherwise, ".html" is
695 appended and the template path is searched.
698 Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or
702 Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR,
703 otherwise to \fBfalse\fR.
706 Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR,
707 otherwise to \fBfalse\fR.
710 Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR
711 argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
714 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
715 loop, otherwise to \fBfalse\fR.
718 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
721 Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to
725 Expands to \fBtrue\fR if the recently played list has any tracks in it,
726 otherwise to \fBfalse\fR.
728 .B @label:\fINAME\fR\fB@
729 Expands to the value of label \fINAME\fR. See the shipped \fIoptions.labels\fR
730 file for full documentation of the labels used by the standard templates.
733 Expands to the length of the current track.
735 .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB}
736 Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn.
737 Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to
739 Usually used in \fBchoose.html\fR.
741 .B @ne{\fIA\fB}{\fIB\fB}
742 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
745 Expands to the number of files from \fB@files\fR (above).
748 Expands to a string including the time and process ID, intended to be
749 unique across invocations.
752 Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to
755 .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
756 If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise
760 Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at
761 an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR.
763 .B @part{\fICONTEXT\fB}{\fIPART\fB}@
764 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the
765 current track. The context may be omitted (and normally would be) and defaults
768 .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@
769 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for
770 \fITRACK\fR. In this usage the context may not be omitted.
773 Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.
775 .B @playing{\fITEMPLATE\fB}@
776 Expands \fITEMPLATE\fR using the playing track as the current track.
778 .B @pref{\fITRACK\fB}{\fIKEY\fB}@
779 Expand to the track preference, or the empty string if it is not set.
782 Expands to the name of the current preference, in the template
783 argument of \fB@prefs@\fR.
785 .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@
786 Expands \fITEMPLATE\fR repeatedly, for each preference of track
788 Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value.
791 Expands to the value of the current preference, in the template
792 argument of \fB@prefs@\fR.
794 .B @queue{\fITEMPLATE\fB}@
795 Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as
796 the current track. The track at the head of the queue comes first.
799 Expands to \fBtrue\fR if random play is currently enabled, otherwise to
802 .B @recent{\fITEMPLATE\fB}@
803 Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn
804 as the current track. The most recently played track comes first.
806 .B @resolve{\fITRACK\fB}@
807 Resolve aliases for \fITRACK\fR and expands to the result.
809 .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@
810 Expands \fITEMPLATE\fR once for each group of search results that have
811 a common value of track part \fIPART\fR.
812 The groups are sorted by the value of the part.
817 within the template will apply to one of the tracks in the group.
819 If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR,
820 and determines the context for \fIPART\fR. The default is \fBsort\fR. Usually
821 you want \fBdisplay\fR for everything except the title and \fBsort\fR for the
822 title. If you use \fBsort\fR for artist and album then you are likely to get
826 Expands to the server's version string.
828 .B @shell{\fICOMMAND\fB}@
829 Expands to the output of \fICOMMAND\fR executed via the shell. \fBsh\fR is
830 searched for using \fBPATH\fR. If the command fails then this is logged but
834 In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current
835 track. Otherwise the empty string. Known states are:
839 The player terminated with nonzero status, but not because the track was
843 A scratch, in the queue.
846 No player could be found.
852 A randomly chosen track, in the queue.
855 This track was scratched.
858 An explicitly queued track, in the queue.
861 Some additional states only apply to playing tracks, so will never be seen in
862 the queue or recently-played list:
866 The track has been paused.
869 Interrupted because the server is shutting down.
872 This track is currently playing.
876 Expands to the server statistics.
879 Expands to the URL of the current page. Typically used in
881 arguments. If there is a
883 argument then it is changed to a fresh value.
888 .B @trackstate{\fIPATH\fB}@
889 Expands to the current track state: \fBplaying\fR if the track is actually
890 playing now, \fBqueued\fR if it is queued or the empty string otherwise.
892 .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@
893 Transform a path according to \fBtransform\fR (see above).
894 \fIPATH\fR should be a raw filename (of a track or directory).
895 \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR).
896 \fICONTEXT\fR should be the context, and can be omitted (the default
900 Expands to the canonical URL as defined in \fIpkgconfdir/config\fR.
902 .B @urlquote{\fISTRING\fB}@
903 URL-quote \fISTRING\fR.
906 Expands to \fBdisorder.cgi\fR's version string.
908 .B @volume:\fISPEAKER\fB@
909 The volume on the left or right speaker. \fISPEAKER\fR must be \fBleft\fB or
913 When the current track was played (or when it is expected to be played, if it
914 has not been played yet)
917 Who submitted the current track.
919 This is a file called \fIoptions\fR, searched for in the same manner
920 as templates. It includes numerous options for the control of the web
921 interface. The general syntax is the same as the main configuration
922 file, except that it should be encoded using UTF-8 (though this might
923 change to the current locale's character encoding; stick to ASCII to
926 The shipped \fIoptions\fR file includes four standard options files.
930 The default labels file. You wouldn't normally edit this directly - instead
931 supply your own commands in \fIoptions.user\fR. Have a look at the shipped
932 version of the file for documentation of labels used by the standard templates.
935 A user options file. Here you should put any overrides for the default
936 labels and any extra labels required by your modified templates.
938 Valid directives are:
940 .B columns \fINAME\fR \fIHEADING\fR...
941 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB. \fINAME\fR
942 must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
943 \fIHEADING\fR... is a list of
944 heading names. If a column is defined more than once then the last definitions
947 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
950 .B include \fIPATH\fR
951 Includes another file. If \fIPATH\fR starts with a \fB/\fR then it is
952 taken as is, otherwise it is searched for in the template path.
954 .B label \fINAME\fR \fIVALUE\fR
955 Define a label. If a label is defined more than once then the last definition
958 Some labels are defined inside \fBdisorder.cgi\fR and others by the
959 default templates. You can define your own labels and use them inside
962 When an undefined label is expanded, if it has a dot in its name then
963 the part after the final dot is used as its value. Otherwise the
964 whole name is used as the value.
966 Labels are no longer documented here, see the shipped \fIoptions.labels\fR file
968 .SH "REGEXP SUBSTITUTION RULES"
969 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3). The
970 only option used is \fBPCRE_UTF8\fR. Remember that the configuration
971 file syntax means you have to escape backslashes and quotes inside
974 In a \fISUBST\fR string the following sequences are interpreted
978 These expand to the first to ninth bracketed subexpression.
981 This expands to the matched part of the subject string.
984 This expands to a single \fB$\fR symbol.
986 All other pairs starting with \fB$\fR are undefined (and might be used
987 for something else in the future, so don't rely on the current
990 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent. If
991 \fBg\fR is present then all matches are replaced, otherwise only the first
994 What the web interface actually does is terminated by the \fBaction\fR CGI
995 argument. The values listed below are supported.
997 Except as specified, all actions redirect back to the \fBplaying.html\fR
998 template unless the \fBback\fR argument is present, in which case the URL it
999 gives is used instead.
1001 Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present.
1004 Move track \fBid\fR by offset \fBdelta\fR.
1007 Play track \fBfile\fR, or if that is missing then play all the tracks in
1011 Don't change any state, but instead compute a suitable refresh time and include
1012 that in an HTTP header. Expands the \fBplaying.html\fR template rather than
1015 This is the default if \fBaction\fR is missing.
1018 Disables random play.
1021 Enables random play.
1024 Disables play completely.
1030 Pauses the current track.
1033 Remove track \fBid\fR.
1036 Resumes play after a pause.
1039 Scratch the playing track. If \fBid\fR is present it must match the playing
1043 Change the volume by \fBdelta\fR, or if that is missing then set it to the
1044 values of \fBleft\fR and \fBright\fR. Expands to the \fBvolume.html\fR template
1045 rather than redirecting.
1048 Adjust preferences from the \fBprefs.html\fR template (which it then expands
1049 rather than redirecting).
1053 is set then the cooked interface is assumed. The value of
1055 is used to determine which trackname preferences are set. By default the
1057 context is adjusted but this can be overridden with the
1061 argument is checked; if it is set then random play is enabled for that track,
1062 otherwise it is disabled.
1068 arguments are set then they are used to set a single preference.
1070 Otherwise if just the
1072 argument is set then that preference is deleted.
1074 It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to
1075 enure that the real track name is always used. Otherwise if the preferences
1076 page is used to adjust a trackname_ preference, the alias may change, leading
1077 to the URL going stale.
1080 This action is generated automatically when an error occurs connecting to the
1081 server. The \fBerror\fR label is set to an indication of what the error is.
1082 .SH "TRACK NAME PARTS"
1083 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1084 with the obvious intended meaning. These are controlled by configuration and
1085 by \fBtrackname_\fR preferences.
1087 In addition there are two built-in parts, \fBpath\fR which is the whole path
1088 name and \fBext\fR which is the filename extension, including the initial dot
1089 (or the empty string if there is not extension).
1091 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
1092 \fBpcrepattern\fR(3)
1093 .\" Local Variables:
~mdw / disorder / blob