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 Each user has an associated set of rights which contorl which commands they may
56 execute. Normally you would give all users most rights, and expect them to
57 cooperate (they are after all presumed to be in a shared sound environment).
59 The full set of rights are:
62 User can perform read-only operations
65 User can add tracks to the queue
68 User can move any track
71 User can move their own tracks
74 User can move randomly chosen tracks
77 User can remove any track
80 User can remove their own tracks
83 User can remove randomly chosen tracks
86 User can scratch any track
89 User can scratch their own tracks
92 User can scratch randomly chosen tracks
95 User can change the volume
98 User can perform admin operations
101 User can initiate a rescan
104 User can register new users. Normally only the
106 user would have this right.
109 User can edit their own userinfo
112 User can modify track preferences
115 User can modify global preferences
118 User can pause/resume
120 Access control is entirely used-based. If you configure DisOrder to listen for
121 TCP/IP connections then it will accept a connection from anywhere provided the
122 right password is available. Passwords are never transmitted over TCP/IP
123 connections in clear, but everything else is. The expected model is that
124 host-based access control is imposed at the network layer.
126 The web interface is controlled by a collection of template files, one for each
127 kind of page, and a collection of option files. These are split up and
128 separate from the main configuration file to make it more convenient to
129 override specific bits.
131 The web interface connects to the DisOrder server like any other user, though
132 it is given a special privilege to "become" any other user. (Thus, any process
133 with the same UID as the web interface is very powerful as far as DisOrder
134 goes. This model will be changed in a future version.)
136 Access control to the web interface is (currently) separate from DisOrder's own
137 access control (HTTP authentication is required) but uses the same user
139 .SS "Searching And Tags"
140 Search strings contain a list of search terms separated by spaces. A search
141 term can either be a single word or a tag, prefixed with "tag:".
143 Search words are compared without regard to letter case or accents; thus, all
144 of the following will be considered to be equal to one another:
147 LATIN CAPITAL LETTER E
149 LATIN CAPITAL LETTER E WITH GRAVE
150 LATIN SMALL LETTER E WITH GRAVE
151 LATIN CAPITAL LETTER E plus COMBINING GRAVE ACCENT
152 LATIN SMALL LETTER E plus COMBINING GRAVE ACCENT
155 The same rules apply to tags but in addition leading and trailing whitespace is
156 disregarded and all whitespace sequences are treated as equal when they appear
157 as internal whitespace.
159 Where several tags are listed, for instance the tags preference for a track,
160 the tags are separated by commas. Therefore tags may not contain commas.
161 .SH "CONFIGURATION FILE"
163 Lines are split into fields separated by whitespace (space, tab, line
164 feed, carriage return, form feed). Comments are started by the number
167 Fields may be unquoted (in which case they may not contain spaces and
168 may not start with a quotation mark or apostrophe) or quoted by either
169 quotation marks or apostrophes. Inside quoted fields every character
170 stands for itself, except that a backslash can only appear as part of
171 one of the following escape sequences:
186 No other escape sequences are allowed.
188 Within any line the first field is a configuration command and any
189 further fields are parameters. Lines with no fields are ignored.
191 After editing the config file use \fBdisorder reconfigure\fR to make
192 it re-read it. If there is anything wrong with it the daemon will
193 record a log message and ignore the new config file. (You should fix
194 it before next terminating and restarting the daemon, as it cannot
195 start up without a valid config file.)
196 .SS "Configuration Files"
197 Configuration files are read in the following order:
201 .I pkgconfdir/config.private
202 Should be readable only by the jukebox group. Not really useful any more and
203 may be abolished in future.
205 .I pkgconfdir/config.\fRUSER
206 Per-user system-controlled client configuration. Optional but if it
207 exists must be readable only by the relevant user. Would normally
208 contain a \fBpassword\fR directive.
210 .I ~\fRUSER\fI/.disorder/passwd
211 Per-user client configuration. Optional but if it exists must be
212 readable only by the relevant user. Would normally contain a
213 \fBpassword\fR directive.
214 .SS "Global Configuration"
216 .B home \fIDIRECTORY\fR
217 The home directory for state files. Defaults to
219 The server will create this directory on startup if it does not exist.
221 .B plugins \fIPATH\fR
222 Adds a directory to the plugin path. (This is also used by the web
225 Plugins are opened the first time they are required and never after,
226 so after changing a plugin you must restart the server before it is
227 guaranteed to take effect.
231 is used without arguments the plugin path is cleared.
232 .SS "Server Configuration"
234 .B alias \fIPATTERN\fR
235 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
238 Most characters stand for themselves, the exception being \fB{\fR which is used
239 to insert a track name part in the form \fB{\fIname\fB}\fR or
242 The difference is that the first form just inserts the name part while the
243 second prefixes it with a \fB/\fR if it is nonempty.
245 The pattern should not attempt to include the collection root, which is
246 automatically included, but should include the proper extension.
248 The default is \fB{/artist}{/album}{/title}{ext}\fR.
250 .B authorization_algorithm \fIALGORITHM\fR
251 Defines the algorithm used to authenticate clients. The valid options
252 are sha1 (the default), sha256, sha384 and sha512. See
253 .BR disorder_protocol (5)
256 .B broadcast \fIADDRESS\fR \fIPORT\fR
257 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. This implies
258 \fBspeaker_backend network\fR.
260 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
262 .B broadcast_from \fIADDRESS\fR \fIPORT\fR
263 Sets the (local) source address used by \fBbroadcast\fR.
265 .B channel \fICHANNEL\fR
266 The mixer channel that the volume control should use. Valid names depend on
267 your operating system and hardware, but some standard ones that might be useful
272 Output level for the audio device. This is probably what you want and is the
276 Output level for the PC speaker, if that is connected to the sound card.
279 Output level for alternative codec device.
282 Master output level. The OSS documentation recommends against using this, as
283 it affects all output devices.
286 You can also specify channels by number, if you know the right value. NB that
287 volume setting only works on OSS systems (including ALSA, via emulation).
289 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
290 Define a collection of tracks.
292 \fIMODULE\fR defines which plugin module should be used for this
293 collection. Use the supplied \fBfs\fR module for tracks that exists
294 as ordinary files in the filesystem.
296 \fIENCODING\fR defines the encoding of filenames in this collection.
297 For \fBfs\fR this would be the encoding you use for filenames.
298 Examples might be \fBiso-8859-1\fR or \fButf-8\fR.
300 \fIROOT\fR is the root in the filesystem of the filenames and is
301 passed to the plugin module.
303 .B default_rights \fIRIGHTS\fR
304 Defines the set of rights given to new users. The argument is a
305 comma-separated list of rights. For the possible values see
306 .B "Users And Access Control"
309 The default is to allow everything except \fBadmin\fR and \fBregister\fR
310 (modified in legacy configurations by the obsolete \fBrestrict\fR directive).
313 ALSA device to play raw-format audio. Default is \fBdefault\fR, i.e. to use
314 the whatever the ALSA configured default is.
317 Specifies the number of seconds to leave between tracks. The default
320 .B history \fIINTEGER\fR
321 Specifies the number of recently played tracks to remember (including
322 failed tracks and scratches).
324 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
325 Listen for connections on the address specified by \fIHOST\fR and port
326 specified by \fISERVICE\fR. If \fIHOST\fR is omitted then listens on all
329 Normally the server only listens on a UNIX domain socket.
332 Determines whether the server locks against concurrent operation. Default is
333 \fByes\fR. There is no good reason to set this to \fBno\fR and the option will
334 probably be removed in a future version.
337 The path to the mixer device, if you want access to the volume control,
338 e.g. \fB/dev/mixer\fR (the default).
340 .B multicast_loop yes\fR|\fBno
341 Determines whether multicast packets are loop backed to the sending host. The
342 default is \fByes\fR. This only applies if
343 \fBspeaker_backend\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
346 .B multicast_ttl \fIHOPS\fR
347 Set the maximum number of hops to send multicast packets. This only applies if
348 \fBspeaker_backend\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
349 multicast address. The default is 1.
351 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
352 Determines how to extract trackname part \fIPART\fR from a
353 track name (with the collection root part removed).
354 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
356 Track names can be different in different contexts. For instance the sort
357 string might include an initial track number, but this would be stripped for
358 the display string. \fICONTEXT\fR should be a glob pattern matching the
359 contexts in which this directive will be used.
361 Valid contexts are \fBsort\fR and \fBdisplay\fR.
363 All the \fBnamepart\fR directives are considered in order. The
364 first directive for the right part, that matches the desired context,
365 and with a \fIREGEXP\fR that
366 matches the track is used, and the value chosen is constructed from
367 \fISUBST\fR according to the substitution rules below.
369 Note that searches use the raw track name and \fBtrackname_\fR preferences but
370 not (currently) the results of \fBnamepart\fR, so generating words via this option
371 that aren't in the original track name will lead to confusing results.
373 If you supply no \fBnamepart\fR directives at all then a default set will be
374 supplied automatically. But if you supply even one then you must supply all of
375 them. The defaults are equivalent to:
378 namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
379 namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
380 namepart album "/([^/]+)/[^/]+$" $1 *
381 namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 *
382 namepart ext "(\\.[a-zA-Z0-9]+)$" $1 *
385 .B nice_rescan \fIPRIORITY\fR
386 Set the recan subprocess priority. The default is 10.
388 (Note that higher values mean the process gets less CPU time; UNIX priority
389 values are backwards.)
391 .B nice_server \fIPRIORITY\fR
392 Set the server priority. This is applied to the server at startup time (and
393 not when you reload configuration). The server does not use much CPU itself
394 but this value is inherited by programs it executes. If you have limited CPU
395 then it might help to set this to a small negative value. The default is 0.
397 .B nice_speaker \fIPRIORITY\fR
398 Set the speaker process priority. This is applied to the speaker process at
399 startup time (and not when you reload the configuration). The speaker process
400 is not massively CPU intensive by today's standards but depends on reasonably
401 timely scheduling. If you have limited CPU then it might help to set this to a
402 small negative value. The default is 0.
405 The maximum days that a track can survive in the database of newly added
406 tracks. The default is 31.
408 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
409 Specifies the player for files matching the glob \fIPATTERN\fR. \fIMODULE\fR
410 specifies which plugin module to use.
412 The following options are supported:
415 .B --wait-for-device\fR[\fB=\fIDEVICE\fR]
416 Waits (for up to a couple of seconds) for the default, or specified, libao
417 device to become openable.
420 Defines the end of the list of options. Needed if the first argument to the
421 plugin starts with a "-".
424 The following are the standard modules:
427 .B exec \fICOMMAND\fR \fIARGS\fR...
428 The command is executed via \fBexecvp\fR(3), not via the shell.
429 The \fBPATH\fR environment variable is searched for the executable if it is not
431 The command is expected to know how to open its own sound device.
433 .B execraw \fICOMMAND\fR \fIARGS\fR...
434 Identical to the \fBexec\fR except that the player is expected to use the
435 DisOrder raw player protocol.
436 .BR disorder-decode (8)
437 can decode several common audio file formats to this format. If your favourite
438 format is not supported, but you have a player which uses libao, there is also
439 a libao driver which supports this format; see below for more information about
442 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
443 The command is executed using the shell. If \fISHELL\fR is specified then that
444 is used, otherwise \fBsh\fR will be used. In either case the \fBPATH\fR
445 environment variable is searched for the shell executable if it is not an
446 absolute path. The track name is stored in the environment variable
449 Be careful of the interaction between the configuration file quoting rules and
450 the shell quoting rules.
453 If multiple player commands match a track then the first match is used.
455 For the server to be able to calculate track lengths, there should be a
457 command corresponding to each
463 is used without arguments, the list of players is cleared.
465 .B prefsync \fISECONDS\fR
466 The interval at which the preferences log file will be synchronised. Defaults
467 to 3600, i.e. one hour.
469 .B queue_pad \fICOUNT\fR
470 The target size of the queue. If random play is enabled then randomly picked
471 tracks will be added until the queue is at least this big. The default is 10.
473 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
474 Describes the sample format expected by the \fBspeaker_command\fR (below). The
475 components of the format specification are as follows:
479 The number of bits per sample. Optionally, may be suffixed by \fBb\fR or
480 \fBl\fR for big-endian and little-endian words. If neither is used the native
481 byte order is assumed.
484 The number of samples per second.
487 The number of channels.
494 backend the sample format is forced to
498 backend it is forced to
500 in both cases regardless of what is specified in the configuration file.
504 Defines the signal to be sent to track player process groups when tracks are
505 scratched. The default is \fBSIGKILL\fR.
507 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
508 or \fBInterrupted\fR or whatever.
510 .B speaker_backend \fINAME\fR
511 Selects the backend use by the speaker process. The following options are
516 Use the ALSA API. This is only available on Linux systems, on which it is the
520 Use Apple Core Audio. This only available on OS X systems, on which it is the
524 Use the OSS (/dev/dsp) API. Not available on all platforms.
527 Execute a command. This is the default if
529 is specified, or if no native is available.
532 Transmit audio over the network. This is the default if
533 \fBbroadcast\fR is specified. You can use
534 .BR disorder-playrtp (1)
535 to receive and play the resulting stream on Linux and OS X.
538 .B sox_generation \fB0\fR|\fB1
539 Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
540 the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1). See the
541 documentation for your installed copy of \fBsox\fR to determine which you need.
544 .B speaker_command \fICOMMAND
545 Causes the speaker subprocess to pipe audio data into shell command
546 \fICOMMAND\fR, rather than writing to a local sound card. The sample format is
551 Note that if the sample format is wrong then
553 is invoked to translate it. If
555 is not installed then this will not work.
557 .B scratch \fIPATH\fR
558 Specifies a scratch. When a track is scratched, a scratch track is
560 Scratches are played using the same logic as other tracks.
562 At least for the time being, path names of scratches must be encoded using
563 UTF-8 (which means that ASCII will do).
565 If \fBscratch\fR is used without arguments then the list of scratches is
568 .B stopword \fIWORD\fR ...
569 Specifies one or more stopwords that should not take part in searches
572 If \fBstopword\fR is used without arguments then the list of stopwords is
575 .B tracklength \fIPATTERN\fR \fIMODULE\fR
576 Specifies the module used to calculate the length of files matching
577 \fIPATTERN\fR. \fIMODULE\fR specifies which plugin module to use.
579 If \fBtracklength\fR is used without arguments then the list of modules is
583 Specifies the user to run as. Only makes sense if invoked as root (or
585 .SS "Client Configuration"
587 .B connect \fIHOST SERVICE\fR
588 Connect to the address specified by \fIHOST\fR and port specified by
590 .SS "Web Interface Configuration"
592 .B refresh \fISECONDS\fR
593 Specifies the maximum refresh period in seconds. Default 15.
595 .B short_display \fICHARACTERS\fR
596 Defines the maximum number of characters to include in a \fBshort\fR name
599 .B templates \fIPATH\fR ...
600 Specifies the directory containing templates used by the web
601 interface. If a template appears in more than one template directory
602 then the one in the earliest directory specified is chosen.
604 See below for further details.
606 If \fBtemplates\fR is used without arguments then the template path is cleared.
608 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
609 Determines how names are sorted and displayed in track choice displays.
611 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
612 \fBdir\fR but you can define your own.
614 \fICONTEXT\fR is a glob pattern matching the context. Standard contexts are
615 \fBsort\fR (which determines how directory names are sorted) and \fBdisplay\fR
616 (which determines how they are displayed). Again, you can define your
619 All the \fBtransform\fR directives are considered in order. If
620 the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
621 then a new track name is constructed from
622 \fISUBST\fR according to the substitution rules below. If several
623 match then each is executed in order.
625 If you supply no \fBtransform\fR directives at all then a default set will be
626 supplied automatically. But if you supply even one then you must supply all of
627 them. The defaults are:
630 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
631 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
632 transform dir "^.*/([^/]+)$" $1 *
633 transform dir "^(the) ([^/]*)" "$2 $1" sort i
634 transform dir "[[:punct:]]" "" sort g
638 Specifies the URL of the web interface. This URL will be used in
639 generated web pages. The default is inferred at runtime, so this option no
640 longer needs to be specified.
642 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
643 \fB/cgi-bin/jukebox\fR.
644 .SS "Authentication Configuration"
645 These options would normally be used in \fI~\fRUSER\fI/.disorder/passwd\fR or
646 \fIpkgconfdir/config.\fRUSER.
648 .B password \fIPASSWORD\fR
651 .B username \fIUSERNAME\fR
652 Specify username. The default is taken from the environment variable
654 .SH "GLOBAL PREFERENCES"
655 These are the values set with \fBset-global\fR.
658 If this is set an nonempty then randomly played tracks will always have at
659 least one of the listed tags.
662 If this is set an nonempty then randomly played tracks will never have any of
666 If unset or \fByes\fR then play is enabled. Otherwise it is disabled. Use
667 \fBdisable\fR rather than setting it directly.
670 If unset or \fByes\fR then random play is enabled. Otherwise it is disabled.
671 Use \fBdisable\fR rather than setting it directly.
673 Global preferences starting '_' are read-only (in the sense that you cannot
674 modify them; the server may modify them as part of its normal operation). They
678 The database version string. This is used by DisOrder to detect when it must
679 modify the database after an upgrade.
681 .SS "Raw Protocol Players"
682 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
683 Programs that use libao generally have command line options to select the
684 driver and pass options to it.
686 The known driver options are:
689 The file descriptor to write to. If this is not specified then the driver
690 looks like the environment variable \fBDISORDER_RAW_FD\fR. If that is not set
691 then the default is 1 (i.e. standard output).
694 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
695 write to the output file descriptor fails. This is a workaround for buggy
696 players such as \fBogg123\fR that ignore write errors.
698 When \fBdisorder.cgi\fR wants to generate a page for an action it searches the
699 directories specified with \fBtemplates\fR for a matching file. It is
700 suggested that you leave the distributed templates unchanged and put
701 any customisations in an earlier entry in the template path.
703 The supplied templates are:
706 Display information about DisOrder.
709 Navigates through the track database to choose a track to play. The
710 \fBdir\fR argument gives the directory to look in; if it is missing
711 then the root directory is used.
714 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
715 directories to be selected by initial letter.
718 Lists newly added tracks.
721 The "front page", which usually shows the currently playing tracks and
723 Gets an HTTP \fBRefresh\fR header.
725 If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra
726 buttons for moving tracks up and down in the queue. There is some logic in
727 \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR is preserved across refreshes
728 and redirects back into itself, but URLs embedded in web pages must include it
732 Views preferences. If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are
733 all set then that preference is modified; if \fBfile\fR and \fBname\fR are set
734 but not \fBvalue\fR then the preference is deleted.
737 Lists recently played tracks.
740 Presents search results.
743 Primitive volume control.
745 Additionally, other standard files are included by these:
748 Included at the end of the main content \fB<DIV>\fR element.
751 Included at the start of the \fB<BODY>\fR element. (This supplants
752 \fBsidebar.html\fR, though the latter is still available; override label
753 \fBmenu\fR to choose between them.)
756 Included in the \fB<HEAD>\fR element.
759 Contains the default DisOrder stylesheet. You can override this by editing the
760 CSS or by replacing it all with a \fB<LINK>\fR to an external stylesheet.
762 Templates are ASCII files containing HTML documents, with an expansion
763 syntax to enable data supplied by the implementation to be inserted.
765 If you want to use characters outside the ASCII range, use either the
766 appropriate HTML entity, e.g. \fBé\fR, or an SGML numeric
767 character reference, e.g. \fBý\fR. Use \fB@\fR to insert a
768 literal \fB@\fR without falling foul of the expansion syntax.
769 .SS "Expansion Syntax"
770 Expansions are surrounded by at ("@") symbols take the form of a keyword
771 followed by zero or more arguments. Arguments may either be quoted by curly
772 brackets ("{" and "}") or separated by colons (":"). Both kinds may be mixed
773 in a single expansion, though doing so seems likely to cause confusion.
774 The descriptions below contain suggested forms for each
777 Leading and trailing whitespace in unquoted arguments is ignored, as is
778 whitespace (including newlines) following a close bracket ("}").
780 Arguments are recursively expanded before being interpreted, except for
781 \fITEMPLATE\fR arguments. These are expanded (possibly more than once) to
782 produce the final expansion.
783 (More than once means the same argument being expanded more than once
784 for different tracks or whatever, not the result of the first
785 expansion itself being re-expanded.)
787 Strings constructed by expansions (i.e. not literally copied from the template
788 text) are SGML-quoted: any character which does not stand for itself in #PCDATA
789 or a quoted attribute value is replaced by the appropriate numeric character
792 The exception to this is that such strings are \fInot\fR quoted when they are
793 generated in the expansion of a parameter.
795 In the descriptions below, the current track means the one set by
796 \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing.
797 If none of these expansions are in force then there is no current track.
798 \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR.
800 The following expansion keywords are defined:
802 .B @#{\fICOMMENT\fB}@
806 The current action. This reports
808 if the action is really
814 .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
815 If there are no arguments, or all the arguments are \fBtrue\fB, then expands to
816 \fBtrue\fR, otherwise to \fBfalse\fR.
819 Expands to the value of CGI argument \fINAME\fR.
822 The basename of the current directory component, in \fB@navigate@\fR.
824 .B @basename{\fIPATH\fB}@
825 The base name part of \fIPATH\fR.
827 .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@
828 Expands \fITEMPLATE\fR repeatedly for each file or directory under
829 \fB@arg:directory@\fR.
830 \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR.
831 Use \fB@file@\fR to get the display name or filename of the file or
833 Usually used in \fBchoose.html\fR.
836 The directory of the current directory component, in \fB@navigate@\fR.
838 .B @dirname{\fIPATH\fB}@
839 The directory part of \fIPATH\fR.
842 Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR.
844 .B @eq{\fIA\fB}{\fIB\fB}
845 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to
849 Expands to the filename of the current file or directory, inside the template
850 argument to \fBchoose\fR.
852 .B @files{\fITEMPLATE\fB}
853 Expands \fITEMPLATE\fR once for each file indicated by the \fBdirectory\fR CGI
854 arg if it is present, or otherwise for the list of files counted by \fBfiles\fR
855 with names \fB0_file\fR, \fB1_file\fR etc.
858 The full path of the current directory component, in \fB@navigate@\fR.
861 The ID of the current track.
863 .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
864 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
865 to \fIFALSEPART\fR (which may be omitted).
867 .B @include:\fIPATH\fR@
868 Include the named file as if it were a template file. If \fIPATH\fR
869 starts with a \fB/\fR then it is used as-is; otherwise, ".html" is
870 appended and the template path is searched.
873 Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or
877 Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR,
878 otherwise to \fBfalse\fR.
881 Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR,
882 otherwise to \fBfalse\fR.
885 Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR
886 argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
889 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
890 loop, otherwise to \fBfalse\fR.
893 Expands to \fBtrue\fR if the newly added tracks list has any tracks in it,
894 otherwise to \fBfalse\fR.
897 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
900 Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to
904 Expands to \fBtrue\fR if the recently played list has any tracks in it,
905 otherwise to \fBfalse\fR.
907 .B @label:\fINAME\fR\fB@
908 Expands to the value of label \fINAME\fR. See the shipped \fIoptions.labels\fR
909 file for full documentation of the labels used by the standard templates.
912 Expands to the length of the current track.
915 Expands to \fBtrue\fR if the current track is movable, otherwise to
918 .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB}
919 Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn.
920 Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to
922 Usually used in \fBchoose.html\fR.
924 .B @ne{\fIA\fB}{\fIB\fB}
925 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
927 .B @new{\fITEMPLATE\fB}
928 Expands \fITEMPLATE\fR for each track in the newly added tracks list, starting
929 with the most recent. Used in \fBnew.html\fR.
932 Expands to the number of files from \fB@files\fR (above).
935 Expands to a string including the time and process ID, intended to be
936 unique across invocations.
939 Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to
942 .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
943 If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise
947 Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at
948 an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR.
950 .B @part{\fICONTEXT\fB}{\fIPART\fB}@
951 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the
952 current track. The context may be omitted and defaults
955 The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to
956 the \fBshort_display\fR limit.
958 .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@
959 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for
960 \fITRACK\fR. In this usage the context may not be omitted.
962 The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to
963 the \fBshort_display\fR limit.
966 Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.
968 .B @playing{\fITEMPLATE\fB}@
969 Expands \fITEMPLATE\fR using the playing track as the current track.
971 .B @pref{\fITRACK\fB}{\fIKEY\fB}@
972 Expand to the track preference, or the empty string if it is not set.
975 Expands to the name of the current preference, in the template
976 argument of \fB@prefs@\fR.
978 .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@
979 Expands \fITEMPLATE\fR repeatedly, for each preference of track
981 Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value.
984 Expands to the value of the current preference, in the template
985 argument of \fB@prefs@\fR.
987 .B @queue{\fITEMPLATE\fB}@
988 Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as
989 the current track. The track at the head of the queue comes first.
992 Expands to \fBtrue\fR if random play is currently enabled, otherwise to
995 .B @recent{\fITEMPLATE\fB}@
996 Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn
997 as the current track. The most recently played track comes first.
1000 Expands to \fBtrue\fR if the current track is removable, otherwise to
1003 .B @resolve{\fITRACK\fB}@
1004 Resolve aliases for \fITRACK\fR and expands to the result.
1006 .B @right{\fIRIGHT\fB}@
1007 Exapnds to \fBtrue\fR if the user has right \fIRIGHT\fR, otherwise to
1010 .B @right{\fIRIGHT\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
1011 Expands to \fITRUEPART\fR if the user right \fIRIGHT\fR, otherwise to
1012 \fIFALSEPART\fR (which may be omitted).
1015 Expands to \fBtrue\fR if the currently playing track is scratchable, otherwise
1018 .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@
1019 Expands \fITEMPLATE\fR once for each group of search results that have
1020 a common value of track part \fIPART\fR.
1021 The groups are sorted by the value of the part.
1026 within the template will apply to one of the tracks in the group.
1028 If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR,
1029 and determines the context for \fIPART\fR. The default is \fBsort\fR. Usually
1030 you want \fBdisplay\fR for everything except the title and \fBsort\fR for the
1031 title. If you use \fBsort\fR for artist and album then you are likely to get
1035 Expands to the server's version string.
1037 .B @shell{\fICOMMAND\fB}@
1038 Expands to the output of \fICOMMAND\fR executed via the shell. \fBsh\fR is
1039 searched for using \fBPATH\fR. If the command fails then this is logged but
1043 In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current
1044 track. Otherwise the empty string. Known states are:
1048 The player terminated with nonzero status, but not because the track was
1052 A scratch, in the queue.
1055 No player could be found.
1058 Played successfully.
1061 A randomly chosen track, in the queue.
1064 This track was scratched.
1067 An explicitly queued track, in the queue.
1070 Some additional states only apply to playing tracks, so will never be seen in
1071 the queue or recently-played list:
1075 The track has been paused.
1078 Interrupted because the server is shutting down.
1081 This track is currently playing.
1085 Expands to the server statistics.
1088 Expands to the URL of the current page. Typically used in
1090 arguments. If there is a
1092 argument then it is changed to a fresh value.
1097 .B @trackstate{\fIPATH\fB}@
1098 Expands to the current track state: \fBplaying\fR if the track is actually
1099 playing now, \fBqueued\fR if it is queued or the empty string otherwise.
1101 .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@
1102 Transform a path according to \fBtransform\fR (see above).
1103 \fIPATH\fR should be a raw filename (of a track or directory).
1104 \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR).
1105 \fICONTEXT\fR should be the context, and can be omitted (the default
1109 Expands to the canonical URL as defined in \fIpkgconfdir/config\fR.
1111 .B @urlquote{\fISTRING\fB}@
1112 URL-quote \fISTRING\fR.
1115 The current username. This will be "guest" if nobody is logged in.
1118 Expands to \fBdisorder.cgi\fR's version string.
1120 .B @volume:\fISPEAKER\fB@
1121 The volume on the left or right speaker. \fISPEAKER\fR must be \fBleft\fR or
1125 When the current track was played (or when it is expected to be played, if it
1126 has not been played yet)
1129 Who submitted the current track.
1131 This is a file called \fIoptions\fR, searched for in the same manner
1132 as templates. It includes numerous options for the control of the web
1133 interface. The general syntax is the same as the main configuration
1134 file, except that it should be encoded using UTF-8 (though this might
1135 change to the current locale's character encoding; stick to ASCII to
1138 The shipped \fIoptions\fR file includes four standard options files.
1142 The default labels file. You wouldn't normally edit this directly - instead
1143 supply your own commands in \fIoptions.user\fR. Have a look at the shipped
1144 version of the file for documentation of labels used by the standard templates.
1147 A user options file. Here you should put any overrides for the default
1148 labels and any extra labels required by your modified templates.
1150 Valid directives are:
1152 .B columns \fINAME\fR \fIHEADING\fR...
1153 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB. \fINAME\fR
1154 must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
1155 \fIHEADING\fR... is a list of
1156 heading names. If a column is defined more than once then the last definitions
1159 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
1162 .B include \fIPATH\fR
1163 Includes another file. If \fIPATH\fR starts with a \fB/\fR then it is
1164 taken as is, otherwise it is searched for in the template path.
1166 .B label \fINAME\fR \fIVALUE\fR
1167 Define a label. If a label is defined more than once then the last definition
1170 Some labels are defined inside \fBdisorder.cgi\fR and others by the
1171 default templates. You can define your own labels and use them inside
1174 When an undefined label is expanded, if it has a dot in its name then
1175 the part after the final dot is used as its value. Otherwise the
1176 whole name is used as the value.
1178 Labels are no longer documented here, see the shipped \fIoptions.labels\fR file
1180 .SH "REGEXP SUBSTITUTION RULES"
1181 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3). The
1182 only option used is \fBPCRE_UTF8\fR. Remember that the configuration
1183 file syntax means you have to escape backslashes and quotes inside
1186 In a \fISUBST\fR string the following sequences are interpreted
1190 These expand to the first to ninth bracketed subexpression.
1193 This expands to the matched part of the subject string.
1196 This expands to a single \fB$\fR symbol.
1198 All other pairs starting with \fB$\fR are undefined (and might be used
1199 for something else in the future, so don't rely on the current
1202 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent. If
1203 \fBg\fR is present then all matches are replaced, otherwise only the first
1206 What the web interface actually does is terminated by the \fBaction\fR CGI
1207 argument. The values listed below are supported.
1209 Except as specified, all actions redirect back to the \fBplaying.html\fR
1210 template unless the \fBback\fR argument is present, in which case the URL it
1211 gives is used instead.
1213 Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present.
1216 Move track \fBid\fR by offset \fBdelta\fR.
1219 Play track \fBfile\fR, or if that is missing then play all the tracks in
1223 Don't change any state, but instead compute a suitable refresh time and include
1224 that in an HTTP header. Expands the \fBplaying.html\fR template rather than
1227 This is the default if \fBaction\fR is missing.
1230 Disables random play.
1233 Enables random play.
1236 Disables play completely.
1242 Pauses the current track.
1245 Remove track \fBid\fR.
1248 Resumes play after a pause.
1251 Scratch the playing track. If \fBid\fR is present it must match the playing
1255 Change the volume by \fBdelta\fR, or if that is missing then set it to the
1256 values of \fBleft\fR and \fBright\fR. Expands to the \fBvolume.html\fR template
1257 rather than redirecting.
1260 Adjust preferences from the \fBprefs.html\fR template (which it then expands
1261 rather than redirecting).
1265 is set then the cooked interface is assumed. The value of
1267 is used to determine which trackname preferences are set. By default the
1269 context is adjusted but this can be overridden with the
1273 argument is checked; if it is set then random play is enabled for that track,
1274 otherwise it is disabled.
1280 arguments are set then they are used to set a single preference.
1282 Otherwise if just the
1284 argument is set then that preference is deleted.
1286 It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to
1287 enure that the real track name is always used. Otherwise if the preferences
1288 page is used to adjust a trackname_ preference, the alias may change, leading
1289 to the URL going stale.
1292 This action is generated automatically when an error occurs connecting to the
1293 server. The \fBerror\fR label is set to an indication of what the error is.
1294 .SH "TRACK NAME PARTS"
1295 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1296 with the obvious intended meaning. These are controlled by configuration and
1297 by \fBtrackname_\fR preferences.
1299 In addition there are two built-in parts, \fBpath\fR which is the whole path
1300 name and \fBext\fR which is the filename extension, including the initial dot
1301 (or the empty string if there is not extension).
1303 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
1304 \fBpcrepattern\fR(3)
1305 .\" Local Variables:
~mdw / disorder / blob