2 .\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
4 .\" This program is free software; you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation; either version 2 of the License, or
7 .\" (at your option) any later version.
9 .\" This program is distributed in the hope that it will be useful, but
10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 .\" General Public License for more details.
14 .\" You should have received a copy of the GNU General Public License
15 .\" along with this program; if not, write to the Free Software
16 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 pkgconfdir/config - DisOrder jukebox configuration
23 The purpose of DisOrder is to organize and play digital audio files, under the
24 control of multiple users. \fIpkgconfdir/config\fR is the primary
25 configuration file but this man page currently documents all of its various
28 DisOrder can be configured with multiple collections of tracks, indexing them
29 by their filename, and picking players on the basis of filename patterns (for
32 Although the model is of filenames, it is not inherent that there are
33 corresponding real files - merely that they can be interpreted by the chosen
34 player. See \fBdisorder\fR(3) for more details about this.
36 Each track can have a set of preferences associated with it. These are simple
37 key-value pairs; they can be used for anything you like, but a number of keys
38 have specific meanings. See \fBdisorder\fR(1) for more details about these.
40 Track names are derived from filenames under the control of regular
41 expressions, rather than attempting to interpret format-specific embedded name
42 information. They can be overridden by setting preferences.
44 Names for display are distinguished from names for sorting, so with the right
45 underlying filenames an album can be displayed in its original order even if
46 the displayed track titles are not lexically sorted.
48 A collection of global preferences define various bits of server state: whether
49 random play is enabled, what tags to check for when picking at random, etc.
50 .SS "Users And Access Control"
51 DisOrder distinguishes between multiple users. This is for access control and
52 reporting, not to provide different views of the world: i.e. preferences and so
55 It's possible to restrict a small number of operations to a specific subset of
56 users. However, it is assumed that every user is supposed to be able to do
57 most operations - since the users are all sharing the same audio environment
58 they are expected to cooperate with each other.
60 Access control is entirely used-based. If you configure DisOrder to listen for
61 TCP/IP connections then it will accept a connection from anywhere provided the
62 right password is available. Passwords are never transmitted over TCP/IP
63 connections in clear, but everything else is. The expected model is that
64 host-based access control is imposed at the network layer.
66 The web interface is controlled by a collection of template files, one for each
67 kind of page, and a collection of option files. These are split up and
68 separate from the main configuration file to make it more convenient to
69 override specific bits.
71 The web interface connects to the DisOrder server like any other user, though
72 it is given a special privilege to "become" any other user. (Thus, any process
73 with the same UID as the web interface is very powerful as far as DisOrder
76 Access control to the web interface is (currently) separate from DisOrder's own
77 access control (HTTP authentication is required) but uses the same user
79 .SH "CONFIGURATION FILE"
81 Lines are split into fields separated by whitespace (space, tab, line
82 feed, carriage return, form feed). Comments are started by the number
85 Fields may be unquoted (in which case they may not contain spaces and
86 may not start with a quotation mark or apostrophe) or quoted by either
87 quotation marks or apostrophes. Inside quoted fields every character
88 stands for itself, except that a backslash can only appear as part of
89 one of the following escape sequences:
104 No other escape sequences are allowed.
106 Within any line the first field is a configuration command and any
107 further fields are parameters. Lines with no fields are ignored.
109 After editing the config file use \fBdisorder reconfigure\fR to make
110 it re-read it. If there is anything wrong with it the daemon will
111 record a log message and ignore the new config file. (You should fix
112 it before next terminating and restarting the daemon, as it cannot
113 start up without a valid config file.)
114 .SS "Global Configuration"
116 .B home \fIDIRECTORY\fR
117 The home directory for state files. Defaults to
121 Adds a directory to the plugin path. (This is also used by the web
124 Plugins are opened the first time they are required and never after,
125 so after changing a plugin you must restart the server before it is
126 guaranteed to take effect.
127 .SS "Server Configuration"
129 .B alias \fIPATTERN\fR
130 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
133 Most characters stand for themselves, the exception being \fB{\fR which is used
134 to insert a track name part in the form \fB{\fIname\fB}\fR or
137 The difference is that the first form just inserts the name part while the
138 second prefixes it with a \fB/\fR if it is nonempty.
140 The pattern should not attempt to include the collection root, which is
141 automatically included, but should include the proper extension.
143 The default is \fB{/artist}{/album}{/title}{ext}\fR.
145 .B authorization_algorthm \fIALGORITHM\fR
146 Defines the algorithm used to authenticate clients. The valid options
147 are sha1 (the default), sha256, sha384 and sha512. See
148 .BR disorder_protocol (5)
151 .B broadcast \fIADDRESS\fR \fIPORT\fR
152 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. This implies
153 \fBspeaker_backend network\fR.
155 .B broadcast_from \fIADDRESS\fR \fIPORT\fR
156 Sets the (local) source address used by \fBbroadcast\fR.
158 .B channel \fICHANNEL\fR
159 The mixer channel that the volume control should use. Valid names depend on
160 your operating system and hardware, but some standard ones that might be useful
165 Output level for the audio device. This is probably what you want.
168 Output level for the PC speaker, if that is connected to the sound card.
171 Output level for alternative codec device.
174 Master output level. The OSS documentation recommends against using this, as
175 it affects all output devices.
178 You can also specify channels by number, if you know the right value.
180 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
181 Define a collection of tracks.
183 \fIMODULE\fR defines which plugin module should be used for this
184 collection. Use the supplied \fBfs\fR module for tracks that exists
185 as ordinary files in the filesystem.
187 \fIENCODING\fR defines the encoding of filenames in this collection.
188 For \fBfs\fR this would be the encoding you use for filenames.
189 Examples might be \fBiso-8859-1\fR or \fButf-8\fR.
191 \fIROOT\fR is the root in the filesystem of the filenames and is
192 passed to the plugin module.
195 ALSA device to play raw-format audio. Default is \fBdefault\fR, i.e. to use
196 the whatever the ALSA configured default is.
199 Specifies the number of seconds to leave between tracks. The default
202 .B history \fIINTEGER\fR
203 Specifies the number of recently played tracks to remember (including
204 failed tracks and scratches).
206 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
207 Listen for connections on the address specified by \fIHOST\fR and port
208 specified by \fISERVICE\fR. If \fIHOST\fR is omitted then listens on all
211 Normally the server only listens on a UNIX domain socket.
214 Determines whether the server locks against concurrent operation. Default is
218 The path to the mixer device, if you want access to the volume control,
219 e.g. \fB/dev/mixer\fR.
221 .B multicast_ttl \fIHOPS\fR
222 Set the maximum number of hops to send multicast packets. This only applies is
223 \fBspeaker_backend\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
226 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
227 Determines how to extract trackname part \fIPART\fR from a
228 track name (with the collection root part removed).
229 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
231 Track names can be different in different contexts. For instance the sort
232 string might include an initial track number, but this would be stripped for
233 the display string. \fICONTEXT\fR should be a glob pattern matching the
234 contexts in which this directive will be used.
236 Valid contexts are \fBsort\fR and \fBdisplay\fR.
238 All the \fBnamepart\fR directives are considered in order. The
239 first directive for the right part, that matches the desired context,
240 and with a \fIREGEXP\fR that
241 matches the track is used, and the value chosen is constructed from
242 \fISUBST\fR according to the substitution rules below.
244 Note that searches use the raw track name and \fBtrackname_\fR preferences but
245 not (currently) the results of \fBnamepart\fR, so generating words via this option
246 that aren't in the original track name will lead to confusing results.
248 If you supply no \fBnamepart\fR directives at all then a default set will be
249 supplied automatically. But if you supply even one then you must supply all of
250 them. See the example config file for the defaults.
252 .B nice_rescan \fIPRIORITY\fR
253 Set the recan subprocess priority. The default is 10.
255 (Note that higher values mean the process gets less CPU time; UNIX priority
256 values are backwards.)
258 .B nice_server \fIPRIORITY\fR
259 Set the server priority. This is applied to the server at startup time (and
260 not when you reload configuration). The server does not use much CPU itself
261 but this value is inherited by programs it executes. If you have limited CPU
262 then it might help to set this to a small negative value. The default is 0.
264 .B nice_speaker \fIPRIORITY\fR
265 Set the speaker process priority. This is applied to the speaker process at
266 startup time (and not when you reload the configuration). The speaker process
267 is not massively CPU intensive by today's standards but depends on reasonably
268 timely scheduling. If you have limited CPU then it might help to set this to a
269 small negative value. The default is 0.
272 The maximum days that a track can survive in the database of newly added
273 tracks. The default is 31.
275 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
276 Specifies the player for files matching the glob \fIPATTERN\fR. \fIMODULE\fR
277 specifies which plugin module to use.
279 The following options are supported:
282 .B --wait-for-device\fR[\fB=\fIDEVICE\fR]
283 Waits (for up to a couple of seconds) for the default, or specified, libao
284 device to become openable.
287 Defines the end of the list of options. Needed if the first argument to the
288 plugin starts with a "-".
291 The following are the standard modules:
294 .B exec \fICOMMAND\fR \fIARGS\fR...
295 The command is executed via \fBexecvp\fR(3), not via the shell.
296 The \fBPATH\fR environment variable is searched for the executable if it is not
298 The command is expected to know how to open its own sound device.
300 .B execraw \fICOMMAND\fR \fIARGS\fR...
301 Identical to the \fBexec\fR except that the player is expected to use the
302 DisOrder raw player protocol.
303 .BR disorder-decode (8)
304 can decode several common audio file formats to this format. If your favourite
305 format is not supported, but you have a player which uses libao, there is also
306 a libao driver which supports this format; see below for more information about
309 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
310 The command is executed using the shell. If \fISHELL\fR is specified then that
311 is used, otherwise \fBsh\fR will be used. In either case the \fBPATH\fR
312 environment variable is searched for the shell executable if it is not an
313 absolute path. The track name is stored in the environment variable
316 Be careful of the interaction between the configuration file quoting rules and
317 the shell quoting rules.
320 If multiple player commands match a track then the first match is used.
322 .B prefsync \fISECONDS\fR
323 The interval at which the preferences log file will be synchronised. Defaults
324 to 3600, i.e. one hour.
326 .B queue_pad \fICOUNT\fR
327 The target size of the queue. If random play is enabled then randomly picked
328 tracks will be added until the queue is at least this big.
330 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
331 Describes the sample format expected by the \fBspeaker_command\fR (below). The
332 components of the format specification are as follows:
336 The number of bits per sample. Optionally, may be suffixed by \fBb\fR or
337 \fBl\fR for big-endian and little-endian words. If neither is used the native
338 byte order is assumed.
341 The number of samples per second.
344 The number of channels.
351 backend the sample format is forced to
355 backend it is forced to
357 in both cases regardless of what is specified in the configuration file.
361 Defines the signal to be sent to track player process groups when tracks are
362 scratched. The default is \fBSIGKILL\fR.
364 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
365 or \fBInterrupted\fR or whatever.
367 .B speaker_backend \fINAME\fR
368 Selects the backend use by the speaker process. The following options are
373 Use the ALSA API. This is only available on Linux systems, on which it is the
377 Use Apple Core Audio. This only available on OS X systems, on which it is the
381 Execute a command. This is the default if
383 is specified, or if no native is available.
386 Transmit audio over the network. This is the default if
387 \fBbroadcast\fR is specified. You can use
388 .BR disorder-playrtp (1)
389 to receive and play the resulting stream on Linux and OS X.
392 .B sox_generation \fB0\fR|\fB1
393 Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
394 the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1). The default
397 .B speaker_command \fICOMMAND
398 Causes the speaker subprocess to pipe audio data into shell command
399 \fICOMMAND\fR, rather than writing to a local sound card. The sample format is
404 Note that if the sample format is wrong then
406 is invoked to translate it. If
408 is not installed then this will not work.
410 .B restrict \fR[\fBscratch\fR] [\fBremove\fR] [\fBmove\fR]
411 Determine which operations are restricted to the submitter of a
412 track. By default, no operations are restricted, i.e. anyone can
413 scratch or remove anything.
415 If \fBrestrict scratch\fR or \fBrestrict remove\fR are set then only the user
416 that submitted a track can scratch or remove it, respectively.
418 If \fBrestrict move\fR is set then only trusted users can move tracks around in
421 If \fBrestrict\fR is used more than once then only the final use has any
424 .B scratch \fIPATH\fR
425 Specifies a scratch. When a track is scratched, a scratch track is
427 Scratches are played using the same logic as other tracks.
429 At least for the time being, path names of scratches must be encoded using
430 UTF-8 (which means that ASCII will do).
432 .B stopword \fIWORD\fR ...
433 Specifies one or more stopwords that should not take part in searches
435 .SS "Client Configuration"
437 .B connect \fIHOST SERVICE\fR
438 Connect to the address specified by \fIHOST\fR and port specified by
440 .SS "Web Interface Configuration"
442 .B refresh \fISECONDS\fR
443 Specifies the maximum refresh period in seconds. Default 15.
445 .B templates \fIPATH\fR ...
446 Specifies the directory containing templates used by the web
447 interface. If a template appears in more than one template directory
448 then the one in the earliest directory specified is chosen.
450 See below for further details.
452 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
453 Determines how names are sorted and displayed in track choice displays.
455 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
456 \fBdir\fR but you can define your own.
458 \fICONTEXT\fR is a glob pattern matching the context. Standard contexts are
459 \fBsort\fR (which determines how directory names are sorted) and \fBdisplay\fR
460 (which determines how they are displayed). Again, you can define your
463 All the \fBtransform\fR directives are considered in order. If
464 the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
465 then a new track name is constructed from
466 \fISUBST\fR according to the substitution rules below. If several
467 match then each is executed in order.
469 If you supply no \fBtransform\fR directives at all then a default set will be
470 supplied automatically. But if you supply even one then you must supply all of
471 them. See the example config file for the defaults.
474 Specifies the URL of the web interface. This URL will be used in
477 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
478 \fB/cgi-bin/jukebox\fR.
479 .SS "Authentication Configuration"
481 .B allow \fIUSERNAME\fR \fIPASSWORD\fR
482 Specify a username/password pair.
484 .B password \fIPASSWORD\fR
487 .B trust \fIUSERNAME\fR
488 Allow \fIUSERNAME\fR to perform privileged operations such as shutting
489 down or reconfiguring the daemon, or becoming another user.
492 Specifies the user to run as. Only makes sense if invoked as root (or
495 .B username \fIUSERNAME\fR
496 Specify username. The default is taken from the environment variable
499 Configuration files are read in the following order:
503 .I pkgconfdir/config.private
504 Should be readable only by the jukebox group, and contain \fBallow\fR
505 commands for authorised users.
507 .I pkgconfdir/config.\fRUSER
508 Per-user system-controlled client configuration. Optional but if it
509 exists must be readable only by the relevant user. Would normally
510 contain a \fBpassword\fR directive.
512 .I ~\fRUSER\fI/.disorder/passwd
513 Per-user client configuration. Optional but if it exists must be
514 readable only by the relevant user. Would normally contain a
515 \fBpassword\fR directive.
516 .SH "GLOBAL PREFERENCES"
517 These are the values set with \fBset-global\fR.
520 If this is set an nonempty then randomly played tracks will always have at
521 least one of the listed tags.
523 Tags can contain any printing character except comma. Leading and trailing
524 spaces are not significant but internal spaces are. Tags in a list are
528 If this is set an nonempty then randomly played tracks will never have any of
532 If unset or \fByes\fR then play is enabled. Otherwise it is disabled. Use
533 \fBdisable\fR rather than setting it directly.
536 If unset or \fByes\fR then random play is enabled. Otherwise it is disabled.
537 Use \fBdisable\fR rather than setting it directly.
539 .SS "Raw Protocol Players"
540 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
541 Programs that use libao generally have command line options to select the
542 driver and pass options to it.
544 The known driver options are:
547 The file descriptor to write to. If this is not specified then the driver
548 looks like the environment variable \fBDISORDER_RAW_FD\fR. If that is not set
549 then the default is 1 (i.e. standard output).
552 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
553 write to the output file descriptor fails. This is a workaround for buggy
554 players such as \fBogg123\fR that ignore write errors.
556 When \fBdisorder.cgi\fR wants to generate a page for an action it searches the
557 directories specified with \fBtemplates\fR for a matching file. It is
558 suggested that you leave the distributed templates unchanged and put
559 any customisations in an earlier entry in the template path.
561 The supplied templates are:
564 Display information about DisOrder.
567 Navigates through the track database to choose a track to play. The
568 \fBdir\fR argument gives the directory to look in; if it is missing
569 then the root directory is used.
572 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
573 directories to be selected by initial letter.
576 Lists newly added tracks.
579 The "front page", which usually shows the currently playing tracks and
581 Gets an HTTP \fBRefresh\fR header.
583 If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra
584 buttons for moving tracks up and down in the queue. There is some logic in
585 \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR is preserved across refreshes
586 and redirects back into itself, but URLs embedded in web pages must include it
590 Views preferences. If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are
591 all set then that preference is modified; if \fBfile\fR and \fBname\fR are set
592 but not \fBvalue\fR then the preference is deleted.
595 Lists recently played tracks.
598 Presents search results.
601 Primitive volume control.
603 Additionally, other standard files are included by these:
606 Included at the end of the main content \fB<DIV>\fR element.
609 Included at the start of the \fB<BODY>\fR element. (This supplants
610 \fBsidebar.html\fR, though the latter is still available; override label
611 \fBmenu\fR to choose between them.)
614 Included in the \fB<HEAD>\fR element.
617 Contains the default DisOrder stylesheet. You can override this by editing the
618 CSS or by replacing it all with a \fB<LINK>\fR to an external stylesheet.
620 Templates are ASCII files containing HTML documents, with an expansion
621 syntax to enable data supplied by the implementation to be inserted.
623 If you want to use characters outside the ASCII range, use either the
624 appropriate HTML entity, e.g. \fBé\fR, or an SGML numeric
625 character reference, e.g. \fBý\fR. Use \fB@\fR to insert a
626 literal \fB@\fR without falling foul of the expansion syntax.
627 .SS "Expansion Syntax"
628 Expansions are surrounded by at ("@") symbols take the form of a keyword
629 followed by zero or more arguments. Arguments may either be quoted by curly
630 brackets ("{" and "}") or separated by colons (":"). Both kinds may be mixed
631 in a single expansion, though doing so seems likely to cause confusion.
632 The descriptions below contain suggested forms for each
635 Leading and trailing whitespace in unquoted arguments is ignored, as is
636 whitespace (including newlines) following a close bracket ("}").
638 Arguments are recursively expanded before being interpreted, except for
639 \fITEMPLATE\fR arguments. These are expanded (possibly more than once) to
640 produce the final expansion.
641 (More than once means the same argument being expanded more than once
642 for different tracks or whatever, not the result of the first
643 expansion itself being re-expanded.)
645 Strings constructed by expansions (i.e. not literally copied from the template
646 text) are SGML-quoted: any character which does not stand for itself in #PCDATA
647 or a quoted attribute value is replaced by the appropriate numeric character
650 The exception to this is that such strings are \fInot\fR quoted when they are
651 generated in the expansion of a parameter.
653 In the descriptions below, the current track means the one set by
654 \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing.
655 If none of these expansions are in force then there is no current track.
656 \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR.
658 The following expansion keywords are defined:
660 .B @#{\fICOMMENT\fB}@
664 The current action. This reports
666 if the action is really
672 .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
673 If there are no arguments, or all the arguments are \fBtrue\fB, then expands to
674 \fBtrue\fR, otherwise to \fBfalse\fR.
677 Expands to the value of CGI script argument \fINAME\fR.
680 The basename of the current directory component, in \fB@navigate@\fR.
682 .B @basename{\fIPATH\fB}@
683 The base name part of \fIPATH\fR.
685 .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@
686 Expands \fITEMPLATE\fR repeatedly for each file or directory under
687 \fB@arg:directory@\fR.
688 \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR.
689 Use \fB@file@\fR to get the display name or filename of the file or
691 Usually used in \fBchoose.html\fR.
694 The directory of the current directory component, in \fB@navigate@\fR.
696 .B @dirname{\fIPATH\fB}@
697 The directory part of \fIPATH\fR.
700 Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR.
702 .B @eq{\fIA\fB}{\fIB\fB}
703 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to
707 Expands to the filename of the current file or directory, inside the template
708 argument to \fBchoose\fR.
710 .B @files{\fITEMPLATE\fB}
711 Expands \fITEMPLATE\fB once for each file indicated by the \fBdirectory\fR CGI
712 arg if it is present, or otherwise for the list of files counted by \fBfiles\fR
713 with names \fB0_file\fR, \fB1_file\fR etc.
716 The full path of the current directory component, in \fB@navigate@\fR.
719 The ID of the current track.
721 .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
722 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
723 to \fIFALSEPART\fR (which may be omitted).
725 .B @include:\fIPATH\fR@
726 Include the named file as if it were a template file. If \fIPATH\fR
727 starts with a \fB/\fR then it is used as-is; otherwise, ".html" is
728 appended and the template path is searched.
731 Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or
735 Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR,
736 otherwise to \fBfalse\fR.
739 Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR,
740 otherwise to \fBfalse\fR.
743 Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR
744 argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
747 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
748 loop, otherwise to \fBfalse\fR.
751 Expands to \fBtrue\fR if the newly added tracks list has any tracks in it,
752 otherwise to \fBfalse\fR.
755 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
758 Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to
762 Expands to \fBtrue\fR if the recently played list has any tracks in it,
763 otherwise to \fBfalse\fR.
765 .B @label:\fINAME\fR\fB@
766 Expands to the value of label \fINAME\fR. See the shipped \fIoptions.labels\fR
767 file for full documentation of the labels used by the standard templates.
770 Expands to the length of the current track.
772 .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB}
773 Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn.
774 Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to
776 Usually used in \fBchoose.html\fR.
778 .B @ne{\fIA\fB}{\fIB\fB}
779 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
781 .B @new{\fITEMPLATE\fB}
782 Expands \fITEMPLATE\fR for each track in the newly added tracks list, starting
783 with the most recent. Used in \fBnew.html\fR.
786 Expands to the number of files from \fB@files\fR (above).
789 Expands to a string including the time and process ID, intended to be
790 unique across invocations.
793 Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to
796 .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
797 If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise
801 Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at
802 an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR.
804 .B @part{\fICONTEXT\fB}{\fIPART\fB}@
805 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the
806 current track. The context may be omitted (and normally would be) and defaults
809 .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@
810 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for
811 \fITRACK\fR. In this usage the context may not be omitted.
814 Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.
816 .B @playing{\fITEMPLATE\fB}@
817 Expands \fITEMPLATE\fR using the playing track as the current track.
819 .B @pref{\fITRACK\fB}{\fIKEY\fB}@
820 Expand to the track preference, or the empty string if it is not set.
823 Expands to the name of the current preference, in the template
824 argument of \fB@prefs@\fR.
826 .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@
827 Expands \fITEMPLATE\fR repeatedly, for each preference of track
829 Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value.
832 Expands to the value of the current preference, in the template
833 argument of \fB@prefs@\fR.
835 .B @queue{\fITEMPLATE\fB}@
836 Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as
837 the current track. The track at the head of the queue comes first.
840 Expands to \fBtrue\fR if random play is currently enabled, otherwise to
843 .B @recent{\fITEMPLATE\fB}@
844 Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn
845 as the current track. The most recently played track comes first.
847 .B @resolve{\fITRACK\fB}@
848 Resolve aliases for \fITRACK\fR and expands to the result.
850 .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@
851 Expands \fITEMPLATE\fR once for each group of search results that have
852 a common value of track part \fIPART\fR.
853 The groups are sorted by the value of the part.
858 within the template will apply to one of the tracks in the group.
860 If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR,
861 and determines the context for \fIPART\fR. The default is \fBsort\fR. Usually
862 you want \fBdisplay\fR for everything except the title and \fBsort\fR for the
863 title. If you use \fBsort\fR for artist and album then you are likely to get
867 Expands to the server's version string.
869 .B @shell{\fICOMMAND\fB}@
870 Expands to the output of \fICOMMAND\fR executed via the shell. \fBsh\fR is
871 searched for using \fBPATH\fR. If the command fails then this is logged but
875 In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current
876 track. Otherwise the empty string. Known states are:
880 The player terminated with nonzero status, but not because the track was
884 A scratch, in the queue.
887 No player could be found.
893 A randomly chosen track, in the queue.
896 This track was scratched.
899 An explicitly queued track, in the queue.
902 Some additional states only apply to playing tracks, so will never be seen in
903 the queue or recently-played list:
907 The track has been paused.
910 Interrupted because the server is shutting down.
913 This track is currently playing.
917 Expands to the server statistics.
920 Expands to the URL of the current page. Typically used in
922 arguments. If there is a
924 argument then it is changed to a fresh value.
929 .B @trackstate{\fIPATH\fB}@
930 Expands to the current track state: \fBplaying\fR if the track is actually
931 playing now, \fBqueued\fR if it is queued or the empty string otherwise.
933 .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@
934 Transform a path according to \fBtransform\fR (see above).
935 \fIPATH\fR should be a raw filename (of a track or directory).
936 \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR).
937 \fICONTEXT\fR should be the context, and can be omitted (the default
941 Expands to the canonical URL as defined in \fIpkgconfdir/config\fR.
943 .B @urlquote{\fISTRING\fB}@
944 URL-quote \fISTRING\fR.
947 Expands to \fBdisorder.cgi\fR's version string.
949 .B @volume:\fISPEAKER\fB@
950 The volume on the left or right speaker. \fISPEAKER\fR must be \fBleft\fB or
954 When the current track was played (or when it is expected to be played, if it
955 has not been played yet)
958 Who submitted the current track.
960 This is a file called \fIoptions\fR, searched for in the same manner
961 as templates. It includes numerous options for the control of the web
962 interface. The general syntax is the same as the main configuration
963 file, except that it should be encoded using UTF-8 (though this might
964 change to the current locale's character encoding; stick to ASCII to
967 The shipped \fIoptions\fR file includes four standard options files.
971 The default labels file. You wouldn't normally edit this directly - instead
972 supply your own commands in \fIoptions.user\fR. Have a look at the shipped
973 version of the file for documentation of labels used by the standard templates.
976 A user options file. Here you should put any overrides for the default
977 labels and any extra labels required by your modified templates.
979 Valid directives are:
981 .B columns \fINAME\fR \fIHEADING\fR...
982 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB. \fINAME\fR
983 must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
984 \fIHEADING\fR... is a list of
985 heading names. If a column is defined more than once then the last definitions
988 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
991 .B include \fIPATH\fR
992 Includes another file. If \fIPATH\fR starts with a \fB/\fR then it is
993 taken as is, otherwise it is searched for in the template path.
995 .B label \fINAME\fR \fIVALUE\fR
996 Define a label. If a label is defined more than once then the last definition
999 Some labels are defined inside \fBdisorder.cgi\fR and others by the
1000 default templates. You can define your own labels and use them inside
1003 When an undefined label is expanded, if it has a dot in its name then
1004 the part after the final dot is used as its value. Otherwise the
1005 whole name is used as the value.
1007 Labels are no longer documented here, see the shipped \fIoptions.labels\fR file
1009 .SH "REGEXP SUBSTITUTION RULES"
1010 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3). The
1011 only option used is \fBPCRE_UTF8\fR. Remember that the configuration
1012 file syntax means you have to escape backslashes and quotes inside
1015 In a \fISUBST\fR string the following sequences are interpreted
1019 These expand to the first to ninth bracketed subexpression.
1022 This expands to the matched part of the subject string.
1025 This expands to a single \fB$\fR symbol.
1027 All other pairs starting with \fB$\fR are undefined (and might be used
1028 for something else in the future, so don't rely on the current
1031 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent. If
1032 \fBg\fR is present then all matches are replaced, otherwise only the first
1035 What the web interface actually does is terminated by the \fBaction\fR CGI
1036 argument. The values listed below are supported.
1038 Except as specified, all actions redirect back to the \fBplaying.html\fR
1039 template unless the \fBback\fR argument is present, in which case the URL it
1040 gives is used instead.
1042 Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present.
1045 Move track \fBid\fR by offset \fBdelta\fR.
1048 Play track \fBfile\fR, or if that is missing then play all the tracks in
1052 Don't change any state, but instead compute a suitable refresh time and include
1053 that in an HTTP header. Expands the \fBplaying.html\fR template rather than
1056 This is the default if \fBaction\fR is missing.
1059 Disables random play.
1062 Enables random play.
1065 Disables play completely.
1071 Pauses the current track.
1074 Remove track \fBid\fR.
1077 Resumes play after a pause.
1080 Scratch the playing track. If \fBid\fR is present it must match the playing
1084 Change the volume by \fBdelta\fR, or if that is missing then set it to the
1085 values of \fBleft\fR and \fBright\fR. Expands to the \fBvolume.html\fR template
1086 rather than redirecting.
1089 Adjust preferences from the \fBprefs.html\fR template (which it then expands
1090 rather than redirecting).
1094 is set then the cooked interface is assumed. The value of
1096 is used to determine which trackname preferences are set. By default the
1098 context is adjusted but this can be overridden with the
1102 argument is checked; if it is set then random play is enabled for that track,
1103 otherwise it is disabled.
1109 arguments are set then they are used to set a single preference.
1111 Otherwise if just the
1113 argument is set then that preference is deleted.
1115 It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to
1116 enure that the real track name is always used. Otherwise if the preferences
1117 page is used to adjust a trackname_ preference, the alias may change, leading
1118 to the URL going stale.
1121 This action is generated automatically when an error occurs connecting to the
1122 server. The \fBerror\fR label is set to an indication of what the error is.
1123 .SH "TRACK NAME PARTS"
1124 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1125 with the obvious intended meaning. These are controlled by configuration and
1126 by \fBtrackname_\fR preferences.
1128 In addition there are two built-in parts, \fBpath\fR which is the whole path
1129 name and \fBext\fR which is the filename extension, including the initial dot
1130 (or the empty string if there is not extension).
1132 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
1133 \fBpcrepattern\fR(3)
1134 .\" Local Variables:
~mdw / disorder / blob