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
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.
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.
129 .SS "Server Configuration"
131 .B alias \fIPATTERN\fR
132 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
135 Most characters stand for themselves, the exception being \fB{\fR which is used
136 to insert a track name part in the form \fB{\fIname\fB}\fR or
139 The difference is that the first form just inserts the name part while the
140 second prefixes it with a \fB/\fR if it is nonempty.
142 The pattern should not attempt to include the collection root, which is
143 automatically included, but should include the proper extension.
145 The default is \fB{/artist}{/album}{/title}{ext}\fR.
147 .B authorization_algorthm \fIALGORITHM\fR
148 Defines the algorithm used to authenticate clients. The valid options
149 are sha1 (the default), sha256, sha384 and sha512. See
150 .BR disorder_protocol (5)
153 .B broadcast \fIADDRESS\fR \fIPORT\fR
154 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. This implies
155 \fBspeaker_backend network\fR.
157 .B broadcast_from \fIADDRESS\fR \fIPORT\fR
158 Sets the (local) source address used by \fBbroadcast\fR.
160 .B channel \fICHANNEL\fR
161 The mixer channel that the volume control should use. Valid names depend on
162 your operating system and hardware, but some standard ones that might be useful
167 Output level for the audio device. This is probably what you want.
170 Output level for the PC speaker, if that is connected to the sound card.
173 Output level for alternative codec device.
176 Master output level. The OSS documentation recommends against using this, as
177 it affects all output devices.
180 You can also specify channels by number, if you know the right value.
182 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
183 Define a collection of tracks.
185 \fIMODULE\fR defines which plugin module should be used for this
186 collection. Use the supplied \fBfs\fR module for tracks that exists
187 as ordinary files in the filesystem.
189 \fIENCODING\fR defines the encoding of filenames in this collection.
190 For \fBfs\fR this would be the encoding you use for filenames.
191 Examples might be \fBiso-8859-1\fR or \fButf-8\fR.
193 \fIROOT\fR is the root in the filesystem of the filenames and is
194 passed to the plugin module.
197 ALSA device to play raw-format audio. Default is \fBdefault\fR, i.e. to use
198 the whatever the ALSA configured default is.
201 Specifies the number of seconds to leave between tracks. The default
204 .B history \fIINTEGER\fR
205 Specifies the number of recently played tracks to remember (including
206 failed tracks and scratches).
208 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
209 Listen for connections on the address specified by \fIHOST\fR and port
210 specified by \fISERVICE\fR. If \fIHOST\fR is omitted then listens on all
213 Normally the server only listens on a UNIX domain socket.
216 Determines whether the server locks against concurrent operation. Default is
220 The path to the mixer device, if you want access to the volume control,
221 e.g. \fB/dev/mixer\fR.
223 .B multicast_ttl \fIHOPS\fR
224 Set the maximum number of hops to send multicast packets. This only applies is
225 \fBspeaker_backend\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
228 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
229 Determines how to extract trackname part \fIPART\fR from a
230 track name (with the collection root part removed).
231 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
233 Track names can be different in different contexts. For instance the sort
234 string might include an initial track number, but this would be stripped for
235 the display string. \fICONTEXT\fR should be a glob pattern matching the
236 contexts in which this directive will be used.
238 Valid contexts are \fBsort\fR and \fBdisplay\fR.
240 All the \fBnamepart\fR directives are considered in order. The
241 first directive for the right part, that matches the desired context,
242 and with a \fIREGEXP\fR that
243 matches the track is used, and the value chosen is constructed from
244 \fISUBST\fR according to the substitution rules below.
246 Note that searches use the raw track name and \fBtrackname_\fR preferences but
247 not (currently) the results of \fBnamepart\fR, so generating words via this option
248 that aren't in the original track name will lead to confusing results.
250 If you supply no \fBnamepart\fR directives at all then a default set will be
251 supplied automatically. But if you supply even one then you must supply all of
252 them. See the example config file for the defaults.
254 .B nice_rescan \fIPRIORITY\fR
255 Set the recan subprocess priority. The default is 10.
257 (Note that higher values mean the process gets less CPU time; UNIX priority
258 values are backwards.)
260 .B nice_server \fIPRIORITY\fR
261 Set the server priority. This is applied to the server at startup time (and
262 not when you reload configuration). The server does not use much CPU itself
263 but this value is inherited by programs it executes. If you have limited CPU
264 then it might help to set this to a small negative value. The default is 0.
266 .B nice_speaker \fIPRIORITY\fR
267 Set the speaker process priority. This is applied to the speaker process at
268 startup time (and not when you reload the configuration). The speaker process
269 is not massively CPU intensive by today's standards but depends on reasonably
270 timely scheduling. If you have limited CPU then it might help to set this to a
271 small negative value. The default is 0.
274 The maximum days that a track can survive in the database of newly added
275 tracks. The default is 31.
277 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
278 Specifies the player for files matching the glob \fIPATTERN\fR. \fIMODULE\fR
279 specifies which plugin module to use.
281 The following options are supported:
284 .B --wait-for-device\fR[\fB=\fIDEVICE\fR]
285 Waits (for up to a couple of seconds) for the default, or specified, libao
286 device to become openable.
289 Defines the end of the list of options. Needed if the first argument to the
290 plugin starts with a "-".
293 The following are the standard modules:
296 .B exec \fICOMMAND\fR \fIARGS\fR...
297 The command is executed via \fBexecvp\fR(3), not via the shell.
298 The \fBPATH\fR environment variable is searched for the executable if it is not
300 The command is expected to know how to open its own sound device.
302 .B execraw \fICOMMAND\fR \fIARGS\fR...
303 Identical to the \fBexec\fR except that the player is expected to use the
304 DisOrder raw player protocol.
305 .BR disorder-decode (8)
306 can decode several common audio file formats to this format. If your favourite
307 format is not supported, but you have a player which uses libao, there is also
308 a libao driver which supports this format; see below for more information about
311 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
312 The command is executed using the shell. If \fISHELL\fR is specified then that
313 is used, otherwise \fBsh\fR will be used. In either case the \fBPATH\fR
314 environment variable is searched for the shell executable if it is not an
315 absolute path. The track name is stored in the environment variable
318 Be careful of the interaction between the configuration file quoting rules and
319 the shell quoting rules.
322 If multiple player commands match a track then the first match is used.
324 .B prefsync \fISECONDS\fR
325 The interval at which the preferences log file will be synchronised. Defaults
326 to 3600, i.e. one hour.
328 .B queue_pad \fICOUNT\fR
329 The target size of the queue. If random play is enabled then randomly picked
330 tracks will be added until the queue is at least this big.
332 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
333 Describes the sample format expected by the \fBspeaker_command\fR (below). The
334 components of the format specification are as follows:
338 The number of bits per sample. Optionally, may be suffixed by \fBb\fR or
339 \fBl\fR for big-endian and little-endian words. If neither is used the native
340 byte order is assumed.
343 The number of samples per second.
346 The number of channels.
353 backend the sample format is forced to
357 backend it is forced to
359 in both cases regardless of what is specified in the configuration file.
363 Defines the signal to be sent to track player process groups when tracks are
364 scratched. The default is \fBSIGKILL\fR.
366 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
367 or \fBInterrupted\fR or whatever.
369 .B speaker_backend \fINAME\fR
370 Selects the backend use by the speaker process. The following options are
375 Use the ALSA API. This is only available on Linux systems, on which it is the
379 Use Apple Core Audio. This only available on OS X systems, on which it is the
383 Use the OSS (/dev/dsp) API. Not available on all platforms. Not well
384 maintained at the moment.
387 Execute a command. This is the default if
389 is specified, or if no native is available.
392 Transmit audio over the network. This is the default if
393 \fBbroadcast\fR is specified. You can use
394 .BR disorder-playrtp (1)
395 to receive and play the resulting stream on Linux and OS X.
398 .B sox_generation \fB0\fR|\fB1
399 Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
400 the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1). The default
403 .B speaker_command \fICOMMAND
404 Causes the speaker subprocess to pipe audio data into shell command
405 \fICOMMAND\fR, rather than writing to a local sound card. The sample format is
410 Note that if the sample format is wrong then
412 is invoked to translate it. If
414 is not installed then this will not work.
416 .B restrict \fR[\fBscratch\fR] [\fBremove\fR] [\fBmove\fR]
417 Determine which operations are restricted to the submitter of a
418 track. By default, no operations are restricted, i.e. anyone can
419 scratch or remove anything.
421 If \fBrestrict scratch\fR or \fBrestrict remove\fR are set then only the user
422 that submitted a track can scratch or remove it, respectively.
424 If \fBrestrict move\fR is set then only trusted users can move tracks around in
427 If \fBrestrict\fR is used more than once then only the final use has any
430 .B scratch \fIPATH\fR
431 Specifies a scratch. When a track is scratched, a scratch track is
433 Scratches are played using the same logic as other tracks.
435 At least for the time being, path names of scratches must be encoded using
436 UTF-8 (which means that ASCII will do).
438 .B stopword \fIWORD\fR ...
439 Specifies one or more stopwords that should not take part in searches
441 .SS "Client Configuration"
443 .B connect \fIHOST SERVICE\fR
444 Connect to the address specified by \fIHOST\fR and port specified by
446 .SS "Web Interface Configuration"
448 .B refresh \fISECONDS\fR
449 Specifies the maximum refresh period in seconds. Default 15.
451 .B templates \fIPATH\fR ...
452 Specifies the directory containing templates used by the web
453 interface. If a template appears in more than one template directory
454 then the one in the earliest directory specified is chosen.
456 See below for further details.
458 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
459 Determines how names are sorted and displayed in track choice displays.
461 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
462 \fBdir\fR but you can define your own.
464 \fICONTEXT\fR is a glob pattern matching the context. Standard contexts are
465 \fBsort\fR (which determines how directory names are sorted) and \fBdisplay\fR
466 (which determines how they are displayed). Again, you can define your
469 All the \fBtransform\fR directives are considered in order. If
470 the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
471 then a new track name is constructed from
472 \fISUBST\fR according to the substitution rules below. If several
473 match then each is executed in order.
475 If you supply no \fBtransform\fR directives at all then a default set will be
476 supplied automatically. But if you supply even one then you must supply all of
477 them. See the example config file for the defaults.
480 Specifies the URL of the web interface. This URL will be used in
483 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
484 \fB/cgi-bin/jukebox\fR.
485 .SS "Authentication Configuration"
487 .B allow \fIUSERNAME\fR \fIPASSWORD\fR
488 Specify a username/password pair.
490 .B password \fIPASSWORD\fR
493 .B trust \fIUSERNAME\fR
494 Allow \fIUSERNAME\fR to perform privileged operations such as shutting
495 down or reconfiguring the daemon, or becoming another user.
498 Specifies the user to run as. Only makes sense if invoked as root (or
501 .B username \fIUSERNAME\fR
502 Specify username. The default is taken from the environment variable
505 Configuration files are read in the following order:
509 .I pkgconfdir/config.private
510 Should be readable only by the jukebox group, and contain \fBallow\fR
511 commands for authorised users.
513 .I pkgconfdir/config.\fRUSER
514 Per-user system-controlled client configuration. Optional but if it
515 exists must be readable only by the relevant user. Would normally
516 contain a \fBpassword\fR directive.
518 .I ~\fRUSER\fI/.disorder/passwd
519 Per-user client configuration. Optional but if it exists must be
520 readable only by the relevant user. Would normally contain a
521 \fBpassword\fR directive.
522 .SH "GLOBAL PREFERENCES"
523 These are the values set with \fBset-global\fR.
526 If this is set an nonempty then randomly played tracks will always have at
527 least one of the listed tags.
529 Tags can contain any printing character except comma. Leading and trailing
530 spaces are not significant but internal spaces are. Tags in a list are
534 If this is set an nonempty then randomly played tracks will never have any of
538 If unset or \fByes\fR then play is enabled. Otherwise it is disabled. Use
539 \fBdisable\fR rather than setting it directly.
542 If unset or \fByes\fR then random play is enabled. Otherwise it is disabled.
543 Use \fBdisable\fR rather than setting it directly.
545 .SS "Raw Protocol Players"
546 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
547 Programs that use libao generally have command line options to select the
548 driver and pass options to it.
550 The known driver options are:
553 The file descriptor to write to. If this is not specified then the driver
554 looks like the environment variable \fBDISORDER_RAW_FD\fR. If that is not set
555 then the default is 1 (i.e. standard output).
558 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
559 write to the output file descriptor fails. This is a workaround for buggy
560 players such as \fBogg123\fR that ignore write errors.
562 When \fBdisorder.cgi\fR wants to generate a page for an action it searches the
563 directories specified with \fBtemplates\fR for a matching file. It is
564 suggested that you leave the distributed templates unchanged and put
565 any customisations in an earlier entry in the template path.
567 The supplied templates are:
570 Display information about DisOrder.
573 Navigates through the track database to choose a track to play. The
574 \fBdir\fR argument gives the directory to look in; if it is missing
575 then the root directory is used.
578 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
579 directories to be selected by initial letter.
582 Lists newly added tracks.
585 The "front page", which usually shows the currently playing tracks and
587 Gets an HTTP \fBRefresh\fR header.
589 If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra
590 buttons for moving tracks up and down in the queue. There is some logic in
591 \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR is preserved across refreshes
592 and redirects back into itself, but URLs embedded in web pages must include it
596 Views preferences. If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are
597 all set then that preference is modified; if \fBfile\fR and \fBname\fR are set
598 but not \fBvalue\fR then the preference is deleted.
601 Lists recently played tracks.
604 Presents search results.
607 Primitive volume control.
609 Additionally, other standard files are included by these:
612 Included at the end of the main content \fB<DIV>\fR element.
615 Included at the start of the \fB<BODY>\fR element. (This supplants
616 \fBsidebar.html\fR, though the latter is still available; override label
617 \fBmenu\fR to choose between them.)
620 Included in the \fB<HEAD>\fR element.
623 Contains the default DisOrder stylesheet. You can override this by editing the
624 CSS or by replacing it all with a \fB<LINK>\fR to an external stylesheet.
626 Templates are ASCII files containing HTML documents, with an expansion
627 syntax to enable data supplied by the implementation to be inserted.
629 If you want to use characters outside the ASCII range, use either the
630 appropriate HTML entity, e.g. \fBé\fR, or an SGML numeric
631 character reference, e.g. \fBý\fR. Use \fB@\fR to insert a
632 literal \fB@\fR without falling foul of the expansion syntax.
633 .SS "Expansion Syntax"
634 Expansions are surrounded by at ("@") symbols take the form of a keyword
635 followed by zero or more arguments. Arguments may either be quoted by curly
636 brackets ("{" and "}") or separated by colons (":"). Both kinds may be mixed
637 in a single expansion, though doing so seems likely to cause confusion.
638 The descriptions below contain suggested forms for each
641 Leading and trailing whitespace in unquoted arguments is ignored, as is
642 whitespace (including newlines) following a close bracket ("}").
644 Arguments are recursively expanded before being interpreted, except for
645 \fITEMPLATE\fR arguments. These are expanded (possibly more than once) to
646 produce the final expansion.
647 (More than once means the same argument being expanded more than once
648 for different tracks or whatever, not the result of the first
649 expansion itself being re-expanded.)
651 Strings constructed by expansions (i.e. not literally copied from the template
652 text) are SGML-quoted: any character which does not stand for itself in #PCDATA
653 or a quoted attribute value is replaced by the appropriate numeric character
656 The exception to this is that such strings are \fInot\fR quoted when they are
657 generated in the expansion of a parameter.
659 In the descriptions below, the current track means the one set by
660 \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing.
661 If none of these expansions are in force then there is no current track.
662 \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR.
664 The following expansion keywords are defined:
666 .B @#{\fICOMMENT\fB}@
670 The current action. This reports
672 if the action is really
678 .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
679 If there are no arguments, or all the arguments are \fBtrue\fB, then expands to
680 \fBtrue\fR, otherwise to \fBfalse\fR.
683 Expands to the value of CGI script argument \fINAME\fR.
686 The basename of the current directory component, in \fB@navigate@\fR.
688 .B @basename{\fIPATH\fB}@
689 The base name part of \fIPATH\fR.
691 .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@
692 Expands \fITEMPLATE\fR repeatedly for each file or directory under
693 \fB@arg:directory@\fR.
694 \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR.
695 Use \fB@file@\fR to get the display name or filename of the file or
697 Usually used in \fBchoose.html\fR.
700 The directory of the current directory component, in \fB@navigate@\fR.
702 .B @dirname{\fIPATH\fB}@
703 The directory part of \fIPATH\fR.
706 Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR.
708 .B @eq{\fIA\fB}{\fIB\fB}
709 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to
713 Expands to the filename of the current file or directory, inside the template
714 argument to \fBchoose\fR.
716 .B @files{\fITEMPLATE\fB}
717 Expands \fITEMPLATE\fB once for each file indicated by the \fBdirectory\fR CGI
718 arg if it is present, or otherwise for the list of files counted by \fBfiles\fR
719 with names \fB0_file\fR, \fB1_file\fR etc.
722 The full path of the current directory component, in \fB@navigate@\fR.
725 The ID of the current track.
727 .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
728 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
729 to \fIFALSEPART\fR (which may be omitted).
731 .B @include:\fIPATH\fR@
732 Include the named file as if it were a template file. If \fIPATH\fR
733 starts with a \fB/\fR then it is used as-is; otherwise, ".html" is
734 appended and the template path is searched.
737 Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or
741 Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR,
742 otherwise to \fBfalse\fR.
745 Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR,
746 otherwise to \fBfalse\fR.
749 Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR
750 argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
753 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
754 loop, otherwise to \fBfalse\fR.
757 Expands to \fBtrue\fR if the newly added tracks list has any tracks in it,
758 otherwise to \fBfalse\fR.
761 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
764 Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to
768 Expands to \fBtrue\fR if the recently played list has any tracks in it,
769 otherwise to \fBfalse\fR.
771 .B @label:\fINAME\fR\fB@
772 Expands to the value of label \fINAME\fR. See the shipped \fIoptions.labels\fR
773 file for full documentation of the labels used by the standard templates.
776 Expands to the length of the current track.
778 .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB}
779 Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn.
780 Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to
782 Usually used in \fBchoose.html\fR.
784 .B @ne{\fIA\fB}{\fIB\fB}
785 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
787 .B @new{\fITEMPLATE\fB}
788 Expands \fITEMPLATE\fR for each track in the newly added tracks list, starting
789 with the most recent. Used in \fBnew.html\fR.
792 Expands to the number of files from \fB@files\fR (above).
795 Expands to a string including the time and process ID, intended to be
796 unique across invocations.
799 Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to
802 .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
803 If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise
807 Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at
808 an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR.
810 .B @part{\fICONTEXT\fB}{\fIPART\fB}@
811 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the
812 current track. The context may be omitted (and normally would be) and defaults
815 .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@
816 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for
817 \fITRACK\fR. In this usage the context may not be omitted.
820 Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.
822 .B @playing{\fITEMPLATE\fB}@
823 Expands \fITEMPLATE\fR using the playing track as the current track.
825 .B @pref{\fITRACK\fB}{\fIKEY\fB}@
826 Expand to the track preference, or the empty string if it is not set.
829 Expands to the name of the current preference, in the template
830 argument of \fB@prefs@\fR.
832 .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@
833 Expands \fITEMPLATE\fR repeatedly, for each preference of track
835 Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value.
838 Expands to the value of the current preference, in the template
839 argument of \fB@prefs@\fR.
841 .B @queue{\fITEMPLATE\fB}@
842 Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as
843 the current track. The track at the head of the queue comes first.
846 Expands to \fBtrue\fR if random play is currently enabled, otherwise to
849 .B @recent{\fITEMPLATE\fB}@
850 Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn
851 as the current track. The most recently played track comes first.
853 .B @resolve{\fITRACK\fB}@
854 Resolve aliases for \fITRACK\fR and expands to the result.
856 .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@
857 Expands \fITEMPLATE\fR once for each group of search results that have
858 a common value of track part \fIPART\fR.
859 The groups are sorted by the value of the part.
864 within the template will apply to one of the tracks in the group.
866 If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR,
867 and determines the context for \fIPART\fR. The default is \fBsort\fR. Usually
868 you want \fBdisplay\fR for everything except the title and \fBsort\fR for the
869 title. If you use \fBsort\fR for artist and album then you are likely to get
873 Expands to the server's version string.
875 .B @shell{\fICOMMAND\fB}@
876 Expands to the output of \fICOMMAND\fR executed via the shell. \fBsh\fR is
877 searched for using \fBPATH\fR. If the command fails then this is logged but
881 In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current
882 track. Otherwise the empty string. Known states are:
886 The player terminated with nonzero status, but not because the track was
890 A scratch, in the queue.
893 No player could be found.
899 A randomly chosen track, in the queue.
902 This track was scratched.
905 An explicitly queued track, in the queue.
908 Some additional states only apply to playing tracks, so will never be seen in
909 the queue or recently-played list:
913 The track has been paused.
916 Interrupted because the server is shutting down.
919 This track is currently playing.
923 Expands to the server statistics.
926 Expands to the URL of the current page. Typically used in
928 arguments. If there is a
930 argument then it is changed to a fresh value.
935 .B @trackstate{\fIPATH\fB}@
936 Expands to the current track state: \fBplaying\fR if the track is actually
937 playing now, \fBqueued\fR if it is queued or the empty string otherwise.
939 .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@
940 Transform a path according to \fBtransform\fR (see above).
941 \fIPATH\fR should be a raw filename (of a track or directory).
942 \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR).
943 \fICONTEXT\fR should be the context, and can be omitted (the default
947 Expands to the canonical URL as defined in \fIpkgconfdir/config\fR.
949 .B @urlquote{\fISTRING\fB}@
950 URL-quote \fISTRING\fR.
953 Expands to \fBdisorder.cgi\fR's version string.
955 .B @volume:\fISPEAKER\fB@
956 The volume on the left or right speaker. \fISPEAKER\fR must be \fBleft\fB or
960 When the current track was played (or when it is expected to be played, if it
961 has not been played yet)
964 Who submitted the current track.
966 This is a file called \fIoptions\fR, searched for in the same manner
967 as templates. It includes numerous options for the control of the web
968 interface. The general syntax is the same as the main configuration
969 file, except that it should be encoded using UTF-8 (though this might
970 change to the current locale's character encoding; stick to ASCII to
973 The shipped \fIoptions\fR file includes four standard options files.
977 The default labels file. You wouldn't normally edit this directly - instead
978 supply your own commands in \fIoptions.user\fR. Have a look at the shipped
979 version of the file for documentation of labels used by the standard templates.
982 A user options file. Here you should put any overrides for the default
983 labels and any extra labels required by your modified templates.
985 Valid directives are:
987 .B columns \fINAME\fR \fIHEADING\fR...
988 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB. \fINAME\fR
989 must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
990 \fIHEADING\fR... is a list of
991 heading names. If a column is defined more than once then the last definitions
994 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
997 .B include \fIPATH\fR
998 Includes another file. If \fIPATH\fR starts with a \fB/\fR then it is
999 taken as is, otherwise it is searched for in the template path.
1001 .B label \fINAME\fR \fIVALUE\fR
1002 Define a label. If a label is defined more than once then the last definition
1005 Some labels are defined inside \fBdisorder.cgi\fR and others by the
1006 default templates. You can define your own labels and use them inside
1009 When an undefined label is expanded, if it has a dot in its name then
1010 the part after the final dot is used as its value. Otherwise the
1011 whole name is used as the value.
1013 Labels are no longer documented here, see the shipped \fIoptions.labels\fR file
1015 .SH "REGEXP SUBSTITUTION RULES"
1016 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3). The
1017 only option used is \fBPCRE_UTF8\fR. Remember that the configuration
1018 file syntax means you have to escape backslashes and quotes inside
1021 In a \fISUBST\fR string the following sequences are interpreted
1025 These expand to the first to ninth bracketed subexpression.
1028 This expands to the matched part of the subject string.
1031 This expands to a single \fB$\fR symbol.
1033 All other pairs starting with \fB$\fR are undefined (and might be used
1034 for something else in the future, so don't rely on the current
1037 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent. If
1038 \fBg\fR is present then all matches are replaced, otherwise only the first
1041 What the web interface actually does is terminated by the \fBaction\fR CGI
1042 argument. The values listed below are supported.
1044 Except as specified, all actions redirect back to the \fBplaying.html\fR
1045 template unless the \fBback\fR argument is present, in which case the URL it
1046 gives is used instead.
1048 Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present.
1051 Move track \fBid\fR by offset \fBdelta\fR.
1054 Play track \fBfile\fR, or if that is missing then play all the tracks in
1058 Don't change any state, but instead compute a suitable refresh time and include
1059 that in an HTTP header. Expands the \fBplaying.html\fR template rather than
1062 This is the default if \fBaction\fR is missing.
1065 Disables random play.
1068 Enables random play.
1071 Disables play completely.
1077 Pauses the current track.
1080 Remove track \fBid\fR.
1083 Resumes play after a pause.
1086 Scratch the playing track. If \fBid\fR is present it must match the playing
1090 Change the volume by \fBdelta\fR, or if that is missing then set it to the
1091 values of \fBleft\fR and \fBright\fR. Expands to the \fBvolume.html\fR template
1092 rather than redirecting.
1095 Adjust preferences from the \fBprefs.html\fR template (which it then expands
1096 rather than redirecting).
1100 is set then the cooked interface is assumed. The value of
1102 is used to determine which trackname preferences are set. By default the
1104 context is adjusted but this can be overridden with the
1108 argument is checked; if it is set then random play is enabled for that track,
1109 otherwise it is disabled.
1115 arguments are set then they are used to set a single preference.
1117 Otherwise if just the
1119 argument is set then that preference is deleted.
1121 It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to
1122 enure that the real track name is always used. Otherwise if the preferences
1123 page is used to adjust a trackname_ preference, the alias may change, leading
1124 to the URL going stale.
1127 This action is generated automatically when an error occurs connecting to the
1128 server. The \fBerror\fR label is set to an indication of what the error is.
1129 .SH "TRACK NAME PARTS"
1130 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1131 with the obvious intended meaning. These are controlled by configuration and
1132 by \fBtrackname_\fR preferences.
1134 In addition there are two built-in parts, \fBpath\fR which is the whole path
1135 name and \fBext\fR which is the filename extension, including the initial dot
1136 (or the empty string if there is not extension).
1138 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
1139 \fBpcrepattern\fR(3)
1140 .\" Local Variables:
~mdw / disorder / blob