3 .\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
5 .\" This program is free software; you can redistribute it and/or modify
6 .\" it under the terms of the GNU General Public License as published by
7 .\" the Free Software Foundation; either version 2 of the License, or
8 .\" (at your option) any later version.
10 .\" This program is distributed in the hope that it will be useful, but
11 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 .\" General Public License for more details.
15 .\" You should have received a copy of the GNU General Public License
16 .\" along with this program; if not, write to the Free Software
17 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22 pkgconfdir/config - DisOrder jukebox configuration
24 The purpose of DisOrder is to organize and play digital audio files, under the
25 control of multiple users. \fIpkgconfdir/config\fR is the primary
26 configuration file but this man page currently documents all of its various
29 DisOrder can be configured with multiple collections of tracks, indexing them
30 by their filename, and picking players on the basis of filename patterns (for
33 Although the model is of filenames, it is not inherent that there are
34 corresponding real files - merely that they can be interpreted by the chosen
35 player. See \fBdisorder\fR(3) for more details about this.
37 Each track can have a set of preferences associated with it. These are simple
38 key-value pairs; they can be used for anything you like, but a number of keys
39 have specific meanings. See \fBdisorder\fR(1) for more details about these.
41 Track names are derived from filenames under the control of regular
42 expressions, rather than attempting to interpret format-specific embedded name
43 information. They can be overridden by setting preferences.
45 Names for display are distinguished from names for sorting, so with the right
46 underlying filenames an album can be displayed in its original order even if
47 the displayed track titles are not lexically sorted.
49 A collection of global preferences define various bits of server state: whether
50 random play is enabled, what tags to check for when picking at random, etc.
51 .SS "Users And Access Control"
52 DisOrder distinguishes between multiple users. This is for access control and
53 reporting, not to provide different views of the world: i.e. preferences and so
56 It's possible to restrict a small number of operations to a specific subset of
57 users. However, it is assumed that every user is supposed to be able to do
58 most operations - since the users are all sharing the same audio environment
59 they are expected to cooperate with each other.
61 Access control is entirely used-based. If you configure DisOrder to listen for
62 TCP/IP connections then it will accept a connection from anywhere provided the
63 right password is available. Passwords are never transmitted over TCP/IP
64 connections in clear, but everything else is. The expected model is that
65 host-based access control is imposed at the network layer.
67 The web interface is controlled by a collection of template files, one for each
68 kind of page, and a collection of option files. These are split up and
69 separate from the main configuration file to make it more convenient to
70 override specific bits.
72 The web interface connects to the DisOrder server like any other user, though
73 it is given a special privilege to "become" any other user. (Thus, any process
74 with the same UID as the web interface is very powerful as far as DisOrder
75 goes. This model will be changed in a future version.)
77 Access control to the web interface is (currently) separate from DisOrder's own
78 access control (HTTP authentication is required) but uses the same user
80 .SH "CONFIGURATION FILE"
82 Lines are split into fields separated by whitespace (space, tab, line
83 feed, carriage return, form feed). Comments are started by the number
86 Fields may be unquoted (in which case they may not contain spaces and
87 may not start with a quotation mark or apostrophe) or quoted by either
88 quotation marks or apostrophes. Inside quoted fields every character
89 stands for itself, except that a backslash can only appear as part of
90 one of the following escape sequences:
105 No other escape sequences are allowed.
107 Within any line the first field is a configuration command and any
108 further fields are parameters. Lines with no fields are ignored.
110 After editing the config file use \fBdisorder reconfigure\fR to make
111 it re-read it. If there is anything wrong with it the daemon will
112 record a log message and ignore the new config file. (You should fix
113 it before next terminating and restarting the daemon, as it cannot
114 start up without a valid config file.)
115 .SS "Global Configuration"
117 .B home \fIDIRECTORY\fR
118 The home directory for state files. Defaults to
120 The server will create this directory on startup if it does not exist.
122 .B plugins \fIPATH\fR
123 Adds a directory to the plugin path. (This is also used by the web
126 Plugins are opened the first time they are required and never after,
127 so after changing a plugin you must restart the server before it is
128 guaranteed to take effect.
132 is used without arguments the plugin path is cleared.
133 .SS "Server Configuration"
135 .B alias \fIPATTERN\fR
136 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
139 Most characters stand for themselves, the exception being \fB{\fR which is used
140 to insert a track name part in the form \fB{\fIname\fB}\fR or
143 The difference is that the first form just inserts the name part while the
144 second prefixes it with a \fB/\fR if it is nonempty.
146 The pattern should not attempt to include the collection root, which is
147 automatically included, but should include the proper extension.
149 The default is \fB{/artist}{/album}{/title}{ext}\fR.
151 .B authorization_algorithm \fIALGORITHM\fR
152 Defines the algorithm used to authenticate clients. The valid options
153 are sha1 (the default), sha256, sha384 and sha512. See
154 .BR disorder_protocol (5)
157 .B broadcast \fIADDRESS\fR \fIPORT\fR
158 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. This implies
159 \fBspeaker_backend network\fR.
161 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
163 .B broadcast_from \fIADDRESS\fR \fIPORT\fR
164 Sets the (local) source address used by \fBbroadcast\fR.
166 .B channel \fICHANNEL\fR
167 The mixer channel that the volume control should use. Valid names depend on
168 your operating system and hardware, but some standard ones that might be useful
173 Output level for the audio device. This is probably what you want and is the
177 Output level for the PC speaker, if that is connected to the sound card.
180 Output level for alternative codec device.
183 Master output level. The OSS documentation recommends against using this, as
184 it affects all output devices.
187 You can also specify channels by number, if you know the right value. NB that
188 volume setting only works on OSS systems (including ALSA, via emulation).
190 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
191 Define a collection of tracks.
193 \fIMODULE\fR defines which plugin module should be used for this
194 collection. Use the supplied \fBfs\fR module for tracks that exists
195 as ordinary files in the filesystem.
197 \fIENCODING\fR defines the encoding of filenames in this collection.
198 For \fBfs\fR this would be the encoding you use for filenames.
199 Examples might be \fBiso-8859-1\fR or \fButf-8\fR.
201 \fIROOT\fR is the root in the filesystem of the filenames and is
202 passed to the plugin module.
205 ALSA device to play raw-format audio. Default is \fBdefault\fR, i.e. to use
206 the whatever the ALSA configured default is.
209 Specifies the number of seconds to leave between tracks. The default
212 .B history \fIINTEGER\fR
213 Specifies the number of recently played tracks to remember (including
214 failed tracks and scratches).
216 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
217 Listen for connections on the address specified by \fIHOST\fR and port
218 specified by \fISERVICE\fR. If \fIHOST\fR is omitted then listens on all
221 Normally the server only listens on a UNIX domain socket.
224 Determines whether the server locks against concurrent operation. Default is
225 \fByes\fR. There is no good reason to set this to \fBno\fR and the option will
226 probably be removed in a future version.
229 The path to the mixer device, if you want access to the volume control,
230 e.g. \fB/dev/mixer\fR (the default).
232 .B multicast_loop yes\fR|\fBno
233 Determines whether multicast packets are loop backed to the sending host. The
234 default is \fByes\fR. This only applies if
235 \fBspeaker_backend\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
238 .B multicast_ttl \fIHOPS\fR
239 Set the maximum number of hops to send multicast packets. This only applies if
240 \fBspeaker_backend\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
241 multicast address. The default is 1.
243 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
244 Determines how to extract trackname part \fIPART\fR from a
245 track name (with the collection root part removed).
246 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
248 Track names can be different in different contexts. For instance the sort
249 string might include an initial track number, but this would be stripped for
250 the display string. \fICONTEXT\fR should be a glob pattern matching the
251 contexts in which this directive will be used.
253 Valid contexts are \fBsort\fR and \fBdisplay\fR.
255 All the \fBnamepart\fR directives are considered in order. The
256 first directive for the right part, that matches the desired context,
257 and with a \fIREGEXP\fR that
258 matches the track is used, and the value chosen is constructed from
259 \fISUBST\fR according to the substitution rules below.
261 Note that searches use the raw track name and \fBtrackname_\fR preferences but
262 not (currently) the results of \fBnamepart\fR, so generating words via this option
263 that aren't in the original track name will lead to confusing results.
265 If you supply no \fBnamepart\fR directives at all then a default set will be
266 supplied automatically. But if you supply even one then you must supply all of
267 them. The defaults are equivalent to:
270 namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
271 namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
272 namepart album "/([^/]+)/[^/]+$" $1 *
273 namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 *
274 namepart ext "(\\.[a-zA-Z0-9]+)$" $1 *
277 .B nice_rescan \fIPRIORITY\fR
278 Set the recan subprocess priority. The default is 10.
280 (Note that higher values mean the process gets less CPU time; UNIX priority
281 values are backwards.)
283 .B nice_server \fIPRIORITY\fR
284 Set the server priority. This is applied to the server at startup time (and
285 not when you reload configuration). The server does not use much CPU itself
286 but this value is inherited by programs it executes. If you have limited CPU
287 then it might help to set this to a small negative value. The default is 0.
289 .B nice_speaker \fIPRIORITY\fR
290 Set the speaker process priority. This is applied to the speaker process at
291 startup time (and not when you reload the configuration). The speaker process
292 is not massively CPU intensive by today's standards but depends on reasonably
293 timely scheduling. If you have limited CPU then it might help to set this to a
294 small negative value. The default is 0.
297 The maximum days that a track can survive in the database of newly added
298 tracks. The default is 31.
300 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
301 Specifies the player for files matching the glob \fIPATTERN\fR. \fIMODULE\fR
302 specifies which plugin module to use.
304 The following options are supported:
307 .B --wait-for-device\fR[\fB=\fIDEVICE\fR]
308 Waits (for up to a couple of seconds) for the default, or specified, libao
309 device to become openable.
312 Defines the end of the list of options. Needed if the first argument to the
313 plugin starts with a "-".
316 The following are the standard modules:
319 .B exec \fICOMMAND\fR \fIARGS\fR...
320 The command is executed via \fBexecvp\fR(3), not via the shell.
321 The \fBPATH\fR environment variable is searched for the executable if it is not
323 The command is expected to know how to open its own sound device.
325 .B execraw \fICOMMAND\fR \fIARGS\fR...
326 Identical to the \fBexec\fR except that the player is expected to use the
327 DisOrder raw player protocol.
328 .BR disorder-decode (8)
329 can decode several common audio file formats to this format. If your favourite
330 format is not supported, but you have a player which uses libao, there is also
331 a libao driver which supports this format; see below for more information about
334 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
335 The command is executed using the shell. If \fISHELL\fR is specified then that
336 is used, otherwise \fBsh\fR will be used. In either case the \fBPATH\fR
337 environment variable is searched for the shell executable if it is not an
338 absolute path. The track name is stored in the environment variable
341 Be careful of the interaction between the configuration file quoting rules and
342 the shell quoting rules.
345 If multiple player commands match a track then the first match is used.
347 For the server to be able to calculate track lengths, there should be a
349 command corresponding to each
355 is used without arguments, the list of players is cleared.
357 .B prefsync \fISECONDS\fR
358 The interval at which the preferences log file will be synchronised. Defaults
359 to 3600, i.e. one hour.
361 .B queue_pad \fICOUNT\fR
362 The target size of the queue. If random play is enabled then randomly picked
363 tracks will be added until the queue is at least this big. The default is 10.
365 .B restrict \fR[\fBscratch\fR] [\fBremove\fR] [\fBmove\fR]
366 Determine which operations are restricted to the submitter of a
367 track. By default, no operations are restricted, i.e. anyone can
368 scratch or remove anything.
370 If \fBrestrict scratch\fR or \fBrestrict remove\fR are set then only the user
371 that submitted a track can scratch or remove it, respectively.
373 If \fBrestrict move\fR is set then only trusted users can move tracks around in
376 If \fBrestrict\fR is used more than once then only the final use has any
379 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
380 Describes the sample format expected by the \fBspeaker_command\fR (below). The
381 components of the format specification are as follows:
385 The number of bits per sample. Optionally, may be suffixed by \fBb\fR or
386 \fBl\fR for big-endian and little-endian words. If neither is used the native
387 byte order is assumed.
390 The number of samples per second.
393 The number of channels.
400 backend the sample format is forced to
404 backend it is forced to
406 in both cases regardless of what is specified in the configuration file.
410 Defines the signal to be sent to track player process groups when tracks are
411 scratched. The default is \fBSIGKILL\fR.
413 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
414 or \fBInterrupted\fR or whatever.
416 .B speaker_backend \fINAME\fR
417 Selects the backend use by the speaker process. The following options are
422 Use the ALSA API. This is only available on Linux systems, on which it is the
426 Use Apple Core Audio. This only available on OS X systems, on which it is the
430 Use the OSS (/dev/dsp) API. Not available on all platforms.
433 Execute a command. This is the default if
435 is specified, or if no native is available.
438 Transmit audio over the network. This is the default if
439 \fBbroadcast\fR is specified. You can use
440 .BR disorder-playrtp (1)
441 to receive and play the resulting stream on Linux and OS X.
444 .B sox_generation \fB0\fR|\fB1
445 Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
446 the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1). See the
447 documentation for your installed copy of \fBsox\fR to determine which you need.
450 .B speaker_command \fICOMMAND
451 Causes the speaker subprocess to pipe audio data into shell command
452 \fICOMMAND\fR, rather than writing to a local sound card. The sample format is
457 Note that if the sample format is wrong then
459 is invoked to translate it. If
461 is not installed then this will not work.
463 .B scratch \fIPATH\fR
464 Specifies a scratch. When a track is scratched, a scratch track is
466 Scratches are played using the same logic as other tracks.
468 At least for the time being, path names of scratches must be encoded using
469 UTF-8 (which means that ASCII will do).
471 If \fBscratch\fR is used without arguments then the list of scratches is
474 .B stopword \fIWORD\fR ...
475 Specifies one or more stopwords that should not take part in searches
478 If \fBstopword\fR is used without arguments then the list of stopwords is
481 .B tracklength \fIPATTERN\fR \fIMODULE\fR
482 Specifies the module used to calculate the length of files matching
483 \fIPATTERN\fR. \fIMODULE\fR specifies which plugin module to use.
485 If \fBtracklength\fR is used without arguments then the list of modules is
487 .SS "Client Configuration"
489 .B connect \fIHOST SERVICE\fR
490 Connect to the address specified by \fIHOST\fR and port specified by
492 .SS "Web Interface Configuration"
494 .B refresh \fISECONDS\fR
495 Specifies the maximum refresh period in seconds. Default 15.
497 .B short_display \fICHARACTERS\fR
498 Defines the maximum number of characters to include in a \fBshort\fR name
501 .B templates \fIPATH\fR ...
502 Specifies the directory containing templates used by the web
503 interface. If a template appears in more than one template directory
504 then the one in the earliest directory specified is chosen.
506 See below for further details.
508 If \fBtemplates\fR is used without arguments then the template path is cleared.
510 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
511 Determines how names are sorted and displayed in track choice displays.
513 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
514 \fBdir\fR but you can define your own.
516 \fICONTEXT\fR is a glob pattern matching the context. Standard contexts are
517 \fBsort\fR (which determines how directory names are sorted) and \fBdisplay\fR
518 (which determines how they are displayed). Again, you can define your
521 All the \fBtransform\fR directives are considered in order. If
522 the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
523 then a new track name is constructed from
524 \fISUBST\fR according to the substitution rules below. If several
525 match then each is executed in order.
527 If you supply no \fBtransform\fR directives at all then a default set will be
528 supplied automatically. But if you supply even one then you must supply all of
529 them. The defaults are:
532 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
533 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
534 transform dir "^.*/([^/]+)$" $1 *
535 transform dir "^(the) ([^/]*)" "$2 $1" sort i
536 transform dir "[[:punct:]]" "" sort g
540 Specifies the URL of the web interface. This URL will be used in
543 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
544 \fB/cgi-bin/jukebox\fR.
545 .SS "Authentication Configuration"
547 .B allow \fIUSERNAME\fR \fIPASSWORD\fR
548 Specify a username/password pair.
552 is used without arguments, the list of allowed users is cleared.
554 .B password \fIPASSWORD\fR
557 .B trust \fIUSERNAME\fR
558 Allow \fIUSERNAME\fR to perform privileged operations such as shutting
559 down or reconfiguring the daemon, or becoming another user.
561 If \fBtrust\fR is used without arguments then the list of trusted users is
565 Specifies the user to run as. Only makes sense if invoked as root (or
568 .B username \fIUSERNAME\fR
569 Specify username. The default is taken from the environment variable
572 Configuration files are read in the following order:
576 .I pkgconfdir/config.private
577 Should be readable only by the jukebox group, and contain \fBallow\fR
578 commands for authorised users.
580 If this file does not exist at startup then the server will create it with a
581 randomly chosen password for the root user.
583 .I pkgconfdir/config.\fRUSER
584 Per-user system-controlled client configuration. Optional but if it
585 exists must be readable only by the relevant user. Would normally
586 contain a \fBpassword\fR directive.
588 .I ~\fRUSER\fI/.disorder/passwd
589 Per-user client configuration. Optional but if it exists must be
590 readable only by the relevant user. Would normally contain a
591 \fBpassword\fR directive.
592 .SH "GLOBAL PREFERENCES"
593 These are the values set with \fBset-global\fR.
596 If this is set an nonempty then randomly played tracks will always have at
597 least one of the listed tags.
599 Tags can contain any printing character except comma. Leading and trailing
600 spaces are not significant but internal spaces are. Tags in a list are
604 If this is set an nonempty then randomly played tracks will never have any of
608 If unset or \fByes\fR then play is enabled. Otherwise it is disabled. Use
609 \fBdisable\fR rather than setting it directly.
612 If unset or \fByes\fR then random play is enabled. Otherwise it is disabled.
613 Use \fBdisable\fR rather than setting it directly.
615 Global preferences starting '_' are read-only (in the sense that you cannot
616 modify them; the server may modify them as part of its normal operation). They
620 The database version string. This is used by DisOrder to detect when it must
621 modify the database after an upgrade.
623 .SS "Raw Protocol Players"
624 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
625 Programs that use libao generally have command line options to select the
626 driver and pass options to it.
628 The known driver options are:
631 The file descriptor to write to. If this is not specified then the driver
632 looks like the environment variable \fBDISORDER_RAW_FD\fR. If that is not set
633 then the default is 1 (i.e. standard output).
636 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
637 write to the output file descriptor fails. This is a workaround for buggy
638 players such as \fBogg123\fR that ignore write errors.
640 When \fBdisorder.cgi\fR wants to generate a page for an action it searches the
641 directories specified with \fBtemplates\fR for a matching file. It is
642 suggested that you leave the distributed templates unchanged and put
643 any customisations in an earlier entry in the template path.
645 The supplied templates are:
648 Display information about DisOrder.
651 Navigates through the track database to choose a track to play. The
652 \fBdir\fR argument gives the directory to look in; if it is missing
653 then the root directory is used.
656 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
657 directories to be selected by initial letter.
660 Lists newly added tracks.
663 The "front page", which usually shows the currently playing tracks and
665 Gets an HTTP \fBRefresh\fR header.
667 If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra
668 buttons for moving tracks up and down in the queue. There is some logic in
669 \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR is preserved across refreshes
670 and redirects back into itself, but URLs embedded in web pages must include it
674 Views preferences. If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are
675 all set then that preference is modified; if \fBfile\fR and \fBname\fR are set
676 but not \fBvalue\fR then the preference is deleted.
679 Lists recently played tracks.
682 Presents search results.
685 Primitive volume control.
687 Additionally, other standard files are included by these:
690 Included at the end of the main content \fB<DIV>\fR element.
693 Included at the start of the \fB<BODY>\fR element. (This supplants
694 \fBsidebar.html\fR, though the latter is still available; override label
695 \fBmenu\fR to choose between them.)
698 Included in the \fB<HEAD>\fR element.
701 Contains the default DisOrder stylesheet. You can override this by editing the
702 CSS or by replacing it all with a \fB<LINK>\fR to an external stylesheet.
704 Templates are ASCII files containing HTML documents, with an expansion
705 syntax to enable data supplied by the implementation to be inserted.
707 If you want to use characters outside the ASCII range, use either the
708 appropriate HTML entity, e.g. \fBé\fR, or an SGML numeric
709 character reference, e.g. \fBý\fR. Use \fB@\fR to insert a
710 literal \fB@\fR without falling foul of the expansion syntax.
711 .SS "Expansion Syntax"
712 Expansions are surrounded by at ("@") symbols take the form of a keyword
713 followed by zero or more arguments. Arguments may either be quoted by curly
714 brackets ("{" and "}") or separated by colons (":"). Both kinds may be mixed
715 in a single expansion, though doing so seems likely to cause confusion.
716 The descriptions below contain suggested forms for each
719 Leading and trailing whitespace in unquoted arguments is ignored, as is
720 whitespace (including newlines) following a close bracket ("}").
722 Arguments are recursively expanded before being interpreted, except for
723 \fITEMPLATE\fR arguments. These are expanded (possibly more than once) to
724 produce the final expansion.
725 (More than once means the same argument being expanded more than once
726 for different tracks or whatever, not the result of the first
727 expansion itself being re-expanded.)
729 Strings constructed by expansions (i.e. not literally copied from the template
730 text) are SGML-quoted: any character which does not stand for itself in #PCDATA
731 or a quoted attribute value is replaced by the appropriate numeric character
734 The exception to this is that such strings are \fInot\fR quoted when they are
735 generated in the expansion of a parameter.
737 In the descriptions below, the current track means the one set by
738 \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing.
739 If none of these expansions are in force then there is no current track.
740 \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR.
742 The following expansion keywords are defined:
744 .B @#{\fICOMMENT\fB}@
748 The current action. This reports
750 if the action is really
756 .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
757 If there are no arguments, or all the arguments are \fBtrue\fB, then expands to
758 \fBtrue\fR, otherwise to \fBfalse\fR.
761 Expands to the value of CGI argument \fINAME\fR.
764 The basename of the current directory component, in \fB@navigate@\fR.
766 .B @basename{\fIPATH\fB}@
767 The base name part of \fIPATH\fR.
769 .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@
770 Expands \fITEMPLATE\fR repeatedly for each file or directory under
771 \fB@arg:directory@\fR.
772 \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR.
773 Use \fB@file@\fR to get the display name or filename of the file or
775 Usually used in \fBchoose.html\fR.
778 The directory of the current directory component, in \fB@navigate@\fR.
780 .B @dirname{\fIPATH\fB}@
781 The directory part of \fIPATH\fR.
784 Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR.
786 .B @eq{\fIA\fB}{\fIB\fB}
787 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to
791 Expands to the filename of the current file or directory, inside the template
792 argument to \fBchoose\fR.
794 .B @files{\fITEMPLATE\fB}
795 Expands \fITEMPLATE\fR once for each file indicated by the \fBdirectory\fR CGI
796 arg if it is present, or otherwise for the list of files counted by \fBfiles\fR
797 with names \fB0_file\fR, \fB1_file\fR etc.
800 The full path of the current directory component, in \fB@navigate@\fR.
803 The ID of the current track.
805 .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
806 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
807 to \fIFALSEPART\fR (which may be omitted).
809 .B @include:\fIPATH\fR@
810 Include the named file as if it were a template file. If \fIPATH\fR
811 starts with a \fB/\fR then it is used as-is; otherwise, ".html" is
812 appended and the template path is searched.
815 Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or
819 Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR,
820 otherwise to \fBfalse\fR.
823 Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR,
824 otherwise to \fBfalse\fR.
827 Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR
828 argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
831 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
832 loop, otherwise to \fBfalse\fR.
835 Expands to \fBtrue\fR if the newly added tracks list has any tracks in it,
836 otherwise to \fBfalse\fR.
839 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
842 Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to
846 Expands to \fBtrue\fR if the recently played list has any tracks in it,
847 otherwise to \fBfalse\fR.
849 .B @label:\fINAME\fR\fB@
850 Expands to the value of label \fINAME\fR. See the shipped \fIoptions.labels\fR
851 file for full documentation of the labels used by the standard templates.
854 Expands to the length of the current track.
856 .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB}
857 Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn.
858 Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to
860 Usually used in \fBchoose.html\fR.
862 .B @ne{\fIA\fB}{\fIB\fB}
863 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
865 .B @new{\fITEMPLATE\fB}
866 Expands \fITEMPLATE\fR for each track in the newly added tracks list, starting
867 with the most recent. Used in \fBnew.html\fR.
870 Expands to the number of files from \fB@files\fR (above).
873 Expands to a string including the time and process ID, intended to be
874 unique across invocations.
877 Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to
880 .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
881 If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise
885 Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at
886 an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR.
888 .B @part{\fICONTEXT\fB}{\fIPART\fB}@
889 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the
890 current track. The context may be omitted and defaults
893 The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to
894 the \fBshort_display\fR limit.
896 .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@
897 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for
898 \fITRACK\fR. In this usage the context may not be omitted.
900 The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to
901 the \fBshort_display\fR limit.
904 Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.
906 .B @playing{\fITEMPLATE\fB}@
907 Expands \fITEMPLATE\fR using the playing track as the current track.
909 .B @pref{\fITRACK\fB}{\fIKEY\fB}@
910 Expand to the track preference, or the empty string if it is not set.
913 Expands to the name of the current preference, in the template
914 argument of \fB@prefs@\fR.
916 .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@
917 Expands \fITEMPLATE\fR repeatedly, for each preference of track
919 Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value.
922 Expands to the value of the current preference, in the template
923 argument of \fB@prefs@\fR.
925 .B @queue{\fITEMPLATE\fB}@
926 Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as
927 the current track. The track at the head of the queue comes first.
930 Expands to \fBtrue\fR if random play is currently enabled, otherwise to
933 .B @recent{\fITEMPLATE\fB}@
934 Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn
935 as the current track. The most recently played track comes first.
937 .B @resolve{\fITRACK\fB}@
938 Resolve aliases for \fITRACK\fR and expands to the result.
940 .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@
941 Expands \fITEMPLATE\fR once for each group of search results that have
942 a common value of track part \fIPART\fR.
943 The groups are sorted by the value of the part.
948 within the template will apply to one of the tracks in the group.
950 If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR,
951 and determines the context for \fIPART\fR. The default is \fBsort\fR. Usually
952 you want \fBdisplay\fR for everything except the title and \fBsort\fR for the
953 title. If you use \fBsort\fR for artist and album then you are likely to get
957 Expands to the server's version string.
959 .B @shell{\fICOMMAND\fB}@
960 Expands to the output of \fICOMMAND\fR executed via the shell. \fBsh\fR is
961 searched for using \fBPATH\fR. If the command fails then this is logged but
965 In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current
966 track. Otherwise the empty string. Known states are:
970 The player terminated with nonzero status, but not because the track was
974 A scratch, in the queue.
977 No player could be found.
983 A randomly chosen track, in the queue.
986 This track was scratched.
989 An explicitly queued track, in the queue.
992 Some additional states only apply to playing tracks, so will never be seen in
993 the queue or recently-played list:
997 The track has been paused.
1000 Interrupted because the server is shutting down.
1003 This track is currently playing.
1007 Expands to the server statistics.
1010 Expands to the URL of the current page. Typically used in
1012 arguments. If there is a
1014 argument then it is changed to a fresh value.
1019 .B @trackstate{\fIPATH\fB}@
1020 Expands to the current track state: \fBplaying\fR if the track is actually
1021 playing now, \fBqueued\fR if it is queued or the empty string otherwise.
1023 .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@
1024 Transform a path according to \fBtransform\fR (see above).
1025 \fIPATH\fR should be a raw filename (of a track or directory).
1026 \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR).
1027 \fICONTEXT\fR should be the context, and can be omitted (the default
1031 Expands to the canonical URL as defined in \fIpkgconfdir/config\fR.
1033 .B @urlquote{\fISTRING\fB}@
1034 URL-quote \fISTRING\fR.
1037 Expands to \fBdisorder.cgi\fR's version string.
1039 .B @volume:\fISPEAKER\fB@
1040 The volume on the left or right speaker. \fISPEAKER\fR must be \fBleft\fR or
1044 When the current track was played (or when it is expected to be played, if it
1045 has not been played yet)
1048 Who submitted the current track.
1050 This is a file called \fIoptions\fR, searched for in the same manner
1051 as templates. It includes numerous options for the control of the web
1052 interface. The general syntax is the same as the main configuration
1053 file, except that it should be encoded using UTF-8 (though this might
1054 change to the current locale's character encoding; stick to ASCII to
1057 The shipped \fIoptions\fR file includes four standard options files.
1061 The default labels file. You wouldn't normally edit this directly - instead
1062 supply your own commands in \fIoptions.user\fR. Have a look at the shipped
1063 version of the file for documentation of labels used by the standard templates.
1066 A user options file. Here you should put any overrides for the default
1067 labels and any extra labels required by your modified templates.
1069 Valid directives are:
1071 .B columns \fINAME\fR \fIHEADING\fR...
1072 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB. \fINAME\fR
1073 must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
1074 \fIHEADING\fR... is a list of
1075 heading names. If a column is defined more than once then the last definitions
1078 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
1081 .B include \fIPATH\fR
1082 Includes another file. If \fIPATH\fR starts with a \fB/\fR then it is
1083 taken as is, otherwise it is searched for in the template path.
1085 .B label \fINAME\fR \fIVALUE\fR
1086 Define a label. If a label is defined more than once then the last definition
1089 Some labels are defined inside \fBdisorder.cgi\fR and others by the
1090 default templates. You can define your own labels and use them inside
1093 When an undefined label is expanded, if it has a dot in its name then
1094 the part after the final dot is used as its value. Otherwise the
1095 whole name is used as the value.
1097 Labels are no longer documented here, see the shipped \fIoptions.labels\fR file
1099 .SH "REGEXP SUBSTITUTION RULES"
1100 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3). The
1101 only option used is \fBPCRE_UTF8\fR. Remember that the configuration
1102 file syntax means you have to escape backslashes and quotes inside
1105 In a \fISUBST\fR string the following sequences are interpreted
1109 These expand to the first to ninth bracketed subexpression.
1112 This expands to the matched part of the subject string.
1115 This expands to a single \fB$\fR symbol.
1117 All other pairs starting with \fB$\fR are undefined (and might be used
1118 for something else in the future, so don't rely on the current
1121 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent. If
1122 \fBg\fR is present then all matches are replaced, otherwise only the first
1125 What the web interface actually does is terminated by the \fBaction\fR CGI
1126 argument. The values listed below are supported.
1128 Except as specified, all actions redirect back to the \fBplaying.html\fR
1129 template unless the \fBback\fR argument is present, in which case the URL it
1130 gives is used instead.
1132 Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present.
1135 Move track \fBid\fR by offset \fBdelta\fR.
1138 Play track \fBfile\fR, or if that is missing then play all the tracks in
1142 Don't change any state, but instead compute a suitable refresh time and include
1143 that in an HTTP header. Expands the \fBplaying.html\fR template rather than
1146 This is the default if \fBaction\fR is missing.
1149 Disables random play.
1152 Enables random play.
1155 Disables play completely.
1161 Pauses the current track.
1164 Remove track \fBid\fR.
1167 Resumes play after a pause.
1170 Scratch the playing track. If \fBid\fR is present it must match the playing
1174 Change the volume by \fBdelta\fR, or if that is missing then set it to the
1175 values of \fBleft\fR and \fBright\fR. Expands to the \fBvolume.html\fR template
1176 rather than redirecting.
1179 Adjust preferences from the \fBprefs.html\fR template (which it then expands
1180 rather than redirecting).
1184 is set then the cooked interface is assumed. The value of
1186 is used to determine which trackname preferences are set. By default the
1188 context is adjusted but this can be overridden with the
1192 argument is checked; if it is set then random play is enabled for that track,
1193 otherwise it is disabled.
1199 arguments are set then they are used to set a single preference.
1201 Otherwise if just the
1203 argument is set then that preference is deleted.
1205 It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to
1206 enure that the real track name is always used. Otherwise if the preferences
1207 page is used to adjust a trackname_ preference, the alias may change, leading
1208 to the URL going stale.
1211 This action is generated automatically when an error occurs connecting to the
1212 server. The \fBerror\fR label is set to an indication of what the error is.
1213 .SH "TRACK NAME PARTS"
1214 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1215 with the obvious intended meaning. These are controlled by configuration and
1216 by \fBtrackname_\fR preferences.
1218 In addition there are two built-in parts, \fBpath\fR which is the whole path
1219 name and \fBext\fR which is the filename extension, including the initial dot
1220 (or the empty string if there is not extension).
1222 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
1223 \fBpcrepattern\fR(3)
1224 .\" Local Variables:
~mdw / disorder / blob