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 the 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.
271 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
272 Specifies the player for files matching the glob \fIPATTERN\fR. \fIMODULE\fR
273 specifies which plugin module to use.
275 The following options are supported:
278 .B --wait-for-device\fR[\fB=\fIDEVICE\fR]
279 Waits (for up to a couple of seconds) for the default, or specified, libao
280 device to become openable.
283 Defines the end of the list of options. Needed if the first argument to the
284 plugin starts with a "-".
287 The following are the standard modules:
290 .B exec \fICOMMAND\fR \fIARGS\fR...
291 The command is executed via \fBexecvp\fR(3), not via the shell.
292 The \fBPATH\fR environment variable is searched for the executable if it is not
294 The command is expected to know how to open its own sound device.
296 .B execraw \fICOMMAND\fR \fIARGS\fR...
297 Identical to the \fBexec\fR except that the player is expected to use the
298 DisOrder raw player protocol.
299 .BR disorder-decode (8)
300 can decode several common audio file formats to this format. If your favourite
301 format is not supported, but you have a player which uses libao, there is also
302 a libao driver which supports this format; see below for more information about
305 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
306 The command is executed using the shell. If \fISHELL\fR is specified then that
307 is used, otherwise \fBsh\fR will be used. In either case the \fBPATH\fR
308 environment variable is searched for the shell executable if it is not an
309 absolute path. The track name is stored in the environment variable
312 Be careful of the interaction between the configuration file quoting rules and
313 the shell quoting rules.
316 If multiple player commands match a track then the first match is used.
318 .B prefsync \fISECONDS\fR
319 The interval at which the preferences log file will be synchronised. Defaults
320 to 3600, i.e. one hour.
322 .B queue_pad \fICOUNT\fR
323 The target size of the queue. If random play is enabled then randomly picked
324 tracks will be added until the queue is at least this big.
326 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
327 Describes the sample format expected by the \fBspeaker_command\fR (below). The
328 components of the format specification are as follows:
332 The number of bits per sample. Optionally, may be suffixed by \fBb\fR or
333 \fBl\fR for big-endian and little-endian words. If neither is used the native
334 byte order is assumed.
337 The number of samples per second.
340 The number of channels.
347 Defines the signal to be sent to track player process groups when tracks are
348 scratched. The default is \fBSIGKILL\fR.
350 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
351 or \fBInterrupted\fR or whatever.
353 .B speaker_backend \fINAME\fR
354 Selects the backend use by the speaker process. The following options are
359 Use the ALSA API. This is only available on Linux systems, on which it is the
363 Execute a command. This is the default if
365 is specified, or (currently) on non-Linux systems.
368 Transmit audio over the network. This is the default if
369 \fBbroadcast\fR is specified. You can use
370 .BR disorder-playrtp (1)
371 to receive and play the resulting stream on Linux and OS X.
374 .B sox_generation \fB0\fR|\fB1
375 Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
376 the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1). The default
379 .B speaker_command \fICOMMAND
380 Causes the speaker subprocess to pipe audio data into shell command
381 \fICOMMAND\fR, rather than writing to a local sound card. The sample format is
386 Note that if the sample format is wrong then
388 is invoked to translate it. If
390 is not installed then this will not work.
392 .B restrict \fR[\fBscratch\fR] [\fBremove\fR] [\fBmove\fR]
393 Determine which operations are restricted to the submitter of a
394 track. By default, no operations are restricted, i.e. anyone can
395 scratch or remove anything.
397 If \fBrestrict scratch\fR or \fBrestrict remove\fR are set then only the user
398 that submitted a track can scratch or remove it, respectively.
400 If \fBrestrict move\fR is set then only trusted users can move tracks around in
403 If \fBrestrict\fR is used more than once then only the final use has any
406 .B scratch \fIPATH\fR
407 Specifies a scratch. When a track is scratched, a scratch track is
409 Scratches are played using the same logic as other tracks.
411 At least for the time being, path names of scratches must be encoded using
412 UTF-8 (which means that ASCII will do).
414 .B stopword \fIWORD\fR ...
415 Specifies one or more stopwords that should not take part in searches
417 .SS "Client Configuration"
419 .B connect \fIHOST SERVICE\fR
420 Connect to the address specified by \fIHOST\fR and port specified by
422 .SS "Web Interface Configuration"
424 .B refresh \fISECONDS\fR
425 Specifies the maximum refresh period in seconds. Default 15.
427 .B templates \fIPATH\fR ...
428 Specifies the directory containing templates used by the web
429 interface. If a template appears in more than one template directory
430 then the one in the earliest directory specified is chosen.
432 See below for further details.
434 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
435 Determines how names are sorted and displayed in track choice displays.
437 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
438 \fBdir\fR but you can define your own.
440 \fICONTEXT\fR is a glob pattern matching the context. Standard contexts are
441 \fBsort\fR (which determines how directory names are sorted) and \fBdisplay\fR
442 (which determines how they are displayed). Again, you can define your
445 All the \fBtransform\fR directives are considered in order. If
446 the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
447 then a new track name is constructed from
448 \fISUBST\fR according to the substitution rules below. If several
449 match then each is executed in order.
451 If you supply no \fBtransform\fR directives at all then a default set will be
452 supplied automatically. But if you supply even one then you must supply all of
453 them. See the example config file for the defaults.
456 Specifies the URL of the web interface. This URL will be used in
459 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
460 \fB/cgi-bin/jukebox\fR.
461 .SS "Authentication Configuration"
463 .B allow \fIUSERNAME\fR \fIPASSWORD\fR
464 Specify a username/password pair.
466 .B password \fIPASSWORD\fR
469 .B trust \fIUSERNAME\fR
470 Allow \fIUSERNAME\fR to perform privileged operations such as shutting
471 down or reconfiguring the daemon, or becoming another user.
474 Specifies the user to run as. Only makes sense if invoked as root (or
477 .B username \fIUSERNAME\fR
478 Specify username. The default is taken from the environment variable
481 Configuration files are read in the following order:
485 .I pkgconfdir/config.private
486 Should be readable only by the jukebox group, and contain \fBallow\fR
487 commands for authorised users.
489 .I pkgconfdir/config.\fRUSER
490 Per-user system-controlled client configuration. Optional but if it
491 exists must be readable only by the relevant user. Would normally
492 contain a \fBpassword\fR directive.
494 .I ~\fRUSER\fI/.disorder/passwd
495 Per-user client configuration. Optional but if it exists must be
496 readable only by the relevant user. Would normally contain a
497 \fBpassword\fR directive.
498 .SH "GLOBAL PREFERENCES"
499 These are the values set with \fBset-global\fR.
502 If this is set an nonempty then randomly played tracks will always have at
503 least one of the listed tags.
505 Tags can contain any printing character except comma. Leading and trailing
506 spaces are not significant but internal spaces are. Tags in a list are
510 If this is set an nonempty then randomly played tracks will never have any of
514 If unset or \fByes\fR then play is enabled. Otherwise it is disabled. Use
515 \fBdisable\fR rather than setting it directly.
518 If unset or \fByes\fR then random play is enabled. Otherwise it is disabled.
519 Use \fBdisable\fR rather than setting it directly.
521 .SS "Raw Protocol Players"
522 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
523 Programs that use libao generally have command line options to select the
524 driver and pass options to it.
526 The known driver options are:
529 The file descriptor to write to. If this is not specified then the driver
530 looks like the environment variable \fBDISORDER_RAW_FD\fR. If that is not set
531 then the default is 1 (i.e. standard output).
534 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
535 write to the output file descriptor fails. This is a workaround for buggy
536 players such as \fBogg123\fR that ignore write errors.
538 When \fBdisorder.cgi\fR wants to generate a page for an action it searches the
539 directories specified with \fBtemplates\fR for a matching file. It is
540 suggested that you leave the distributed templates unchanged and put
541 any customisations in an earlier entry in the template path.
543 The supplied templates are:
546 Display information about DisOrder.
549 Navigates through the track database to choose a track to play. The
550 \fBdir\fR argument gives the directory to look in; if it is missing
551 then the root directory is used.
554 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
555 directories to be selected by initial letter.
558 The "front page", which usually shows the currently playing tracks and
560 Gets an HTTP \fBRefresh\fR header.
562 If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra
563 buttons for moving tracks up and down in the queue. There is some logic in
564 \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR is preserved across refreshes
565 and redirects back into itself, but URLs embedded in web pages must include it
569 Views preferences. If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are
570 all set then that preference is modified; if \fBfile\fR and \fBname\fR are set
571 but not \fBvalue\fR then the preference is deleted.
574 Lists recently played tracks.
577 Presents search results.
580 Primitive volume control.
582 Additionally, other standard files are included by these:
585 Included at the end of the main content \fB<DIV>\fR element.
588 Included at the start of the \fB<BODY>\fR element.
591 Included in the \fB<HEAD>\fR element.
594 Contains the default DisOrder stylesheet. You can override this by editing the
595 CSS or by replacing it all with a \fB<LINK>\fR to an external stylesheet.
597 Templates are ASCII files containing HTML documents, with an expansion
598 syntax to enable data supplied by the implementation to be inserted.
600 If you want to use characters outside the ASCII range, use either the
601 appropriate HTML entity, e.g. \fBé\fR, or an SGML numeric
602 character reference, e.g. \fBý\fR. Use \fB@\fR to insert a
603 literal \fB@\fR without falling foul of the expansion syntax.
604 .SS "Expansion Syntax"
605 Expansions are surrounded by at ("@") symbols take the form of a keyword
606 followed by zero or more arguments. Arguments may either be quoted by curly
607 brackets ("{" and "}") or separated by colons (":"). Both kinds may be mixed
608 in a single expansion, though doing so seems likely to cause confusion.
609 The descriptions below contain suggested forms for each
612 Leading and trailing whitespace in unquoted arguments is ignored, as is
613 whitespace (including newlines) following a close bracket ("}").
615 Arguments are recursively expanded before being interpreted, except for
616 \fITEMPLATE\fR arguments. These are expanded (possibly more than once) to
617 produce the final expansion.
618 (More than once means the same argument being expanded more than once
619 for different tracks or whatever, not the result of the first
620 expansion itself being re-expanded.)
622 Strings constructed by expansions (i.e. not literally copied from the template
623 text) are SGML-quoted: any character which does not stand for itself in #PCDATA
624 or a quoted attribute value is replaced by the appropriate numeric character
627 The exception to this is that such strings are \fInot\fR quoted when they are
628 generated in the expansion of a parameter.
630 In the descriptions below, the current track means the one set by
631 \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing.
632 If none of these expansions are in force then there is no current track.
633 \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR.
635 The following expansion keywords are defined:
637 .B @#{\fICOMMENT\fB}@
641 The current action. This reports
643 if the action is really
649 .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
650 If there are no arguments, or all the arguments are \fBtrue\fB, then expands to
651 \fBtrue\fR, otherwise to \fBfalse\fR.
654 Expands to the value of CGI script argument \fINAME\fR.
657 The basename of the current directory component, in \fB@navigate@\fR.
659 .B @basename{\fIPATH\fB}@
660 The base name part of \fIPATH\fR.
662 .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@
663 Expands \fITEMPLATE\fR repeatedly for each file or directory under
664 \fB@arg:directory@\fR.
665 \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR.
666 Use \fB@file@\fR to get the display name or filename of the file or
668 Usually used in \fBchoose.html\fR.
671 The directory of the current directory component, in \fB@navigate@\fR.
673 .B @dirname{\fIPATH\fB}@
674 The directory part of \fIPATH\fR.
677 Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR.
679 .B @eq{\fIA\fB}{\fIB\fB}
680 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to
684 Expands to the filename of the current file or directory, inside the template
685 argument to \fBchoose\fR.
687 .B @files{\fITEMPLATE\fB}
688 Expands \fITEMPLATE\fB once for each file indicated by the \fBdirectory\fR CGI
689 arg if it is present, or otherwise for the list of files counted by \fBfiles\fR
690 with names \fB0_file\fR, \fB1_file\fR etc.
693 The full path of the current directory component, in \fB@navigate@\fR.
696 The ID of the current track.
698 .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
699 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
700 to \fIFALSEPART\fR (which may be omitted).
702 .B @include:\fIPATH\fR@
703 Include the named file as if it were a template file. If \fIPATH\fR
704 starts with a \fB/\fR then it is used as-is; otherwise, ".html" is
705 appended and the template path is searched.
708 Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or
712 Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR,
713 otherwise to \fBfalse\fR.
716 Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR,
717 otherwise to \fBfalse\fR.
720 Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR
721 argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
724 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
725 loop, otherwise to \fBfalse\fR.
728 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
731 Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to
735 Expands to \fBtrue\fR if the recently played list has any tracks in it,
736 otherwise to \fBfalse\fR.
738 .B @label:\fINAME\fR\fB@
739 Expands to the value of label \fINAME\fR. See the shipped \fIoptions.labels\fR
740 file for full documentation of the labels used by the standard templates.
743 Expands to the length of the current track.
745 .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB}
746 Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn.
747 Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to
749 Usually used in \fBchoose.html\fR.
751 .B @ne{\fIA\fB}{\fIB\fB}
752 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
755 Expands to the number of files from \fB@files\fR (above).
758 Expands to a string including the time and process ID, intended to be
759 unique across invocations.
762 Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to
765 .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
766 If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise
770 Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at
771 an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR.
773 .B @part{\fICONTEXT\fB}{\fIPART\fB}@
774 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the
775 current track. The context may be omitted (and normally would be) and defaults
778 .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@
779 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for
780 \fITRACK\fR. In this usage the context may not be omitted.
783 Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.
785 .B @playing{\fITEMPLATE\fB}@
786 Expands \fITEMPLATE\fR using the playing track as the current track.
788 .B @pref{\fITRACK\fB}{\fIKEY\fB}@
789 Expand to the track preference, or the empty string if it is not set.
792 Expands to the name of the current preference, in the template
793 argument of \fB@prefs@\fR.
795 .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@
796 Expands \fITEMPLATE\fR repeatedly, for each preference of track
798 Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value.
801 Expands to the value of the current preference, in the template
802 argument of \fB@prefs@\fR.
804 .B @queue{\fITEMPLATE\fB}@
805 Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as
806 the current track. The track at the head of the queue comes first.
809 Expands to \fBtrue\fR if random play is currently enabled, otherwise to
812 .B @recent{\fITEMPLATE\fB}@
813 Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn
814 as the current track. The most recently played track comes first.
816 .B @resolve{\fITRACK\fB}@
817 Resolve aliases for \fITRACK\fR and expands to the result.
819 .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@
820 Expands \fITEMPLATE\fR once for each group of search results that have
821 a common value of track part \fIPART\fR.
822 The groups are sorted by the value of the part.
827 within the template will apply to one of the tracks in the group.
829 If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR,
830 and determines the context for \fIPART\fR. The default is \fBsort\fR. Usually
831 you want \fBdisplay\fR for everything except the title and \fBsort\fR for the
832 title. If you use \fBsort\fR for artist and album then you are likely to get
836 Expands to the server's version string.
838 .B @shell{\fICOMMAND\fB}@
839 Expands to the output of \fICOMMAND\fR executed via the shell. \fBsh\fR is
840 searched for using \fBPATH\fR. If the command fails then this is logged but
844 In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current
845 track. Otherwise the empty string. Known states are:
849 The player terminated with nonzero status, but not because the track was
853 A scratch, in the queue.
856 No player could be found.
862 A randomly chosen track, in the queue.
865 This track was scratched.
868 An explicitly queued track, in the queue.
871 Some additional states only apply to playing tracks, so will never be seen in
872 the queue or recently-played list:
876 The track has been paused.
879 Interrupted because the server is shutting down.
882 This track is currently playing.
886 Expands to the server statistics.
889 Expands to the URL of the current page. Typically used in
891 arguments. If there is a
893 argument then it is changed to a fresh value.
898 .B @trackstate{\fIPATH\fB}@
899 Expands to the current track state: \fBplaying\fR if the track is actually
900 playing now, \fBqueued\fR if it is queued or the empty string otherwise.
902 .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@
903 Transform a path according to \fBtransform\fR (see above).
904 \fIPATH\fR should be a raw filename (of a track or directory).
905 \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR).
906 \fICONTEXT\fR should be the context, and can be omitted (the default
910 Expands to the canonical URL as defined in \fIpkgconfdir/config\fR.
912 .B @urlquote{\fISTRING\fB}@
913 URL-quote \fISTRING\fR.
916 Expands to \fBdisorder.cgi\fR's version string.
918 .B @volume:\fISPEAKER\fB@
919 The volume on the left or right speaker. \fISPEAKER\fR must be \fBleft\fB or
923 When the current track was played (or when it is expected to be played, if it
924 has not been played yet)
927 Who submitted the current track.
929 This is a file called \fIoptions\fR, searched for in the same manner
930 as templates. It includes numerous options for the control of the web
931 interface. The general syntax is the same as the main configuration
932 file, except that it should be encoded using UTF-8 (though this might
933 change to the current locale's character encoding; stick to ASCII to
936 The shipped \fIoptions\fR file includes four standard options files.
940 The default labels file. You wouldn't normally edit this directly - instead
941 supply your own commands in \fIoptions.user\fR. Have a look at the shipped
942 version of the file for documentation of labels used by the standard templates.
945 A user options file. Here you should put any overrides for the default
946 labels and any extra labels required by your modified templates.
948 Valid directives are:
950 .B columns \fINAME\fR \fIHEADING\fR...
951 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB. \fINAME\fR
952 must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
953 \fIHEADING\fR... is a list of
954 heading names. If a column is defined more than once then the last definitions
957 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
960 .B include \fIPATH\fR
961 Includes another file. If \fIPATH\fR starts with a \fB/\fR then it is
962 taken as is, otherwise it is searched for in the template path.
964 .B label \fINAME\fR \fIVALUE\fR
965 Define a label. If a label is defined more than once then the last definition
968 Some labels are defined inside \fBdisorder.cgi\fR and others by the
969 default templates. You can define your own labels and use them inside
972 When an undefined label is expanded, if it has a dot in its name then
973 the part after the final dot is used as its value. Otherwise the
974 whole name is used as the value.
976 Labels are no longer documented here, see the shipped \fIoptions.labels\fR file
978 .SH "REGEXP SUBSTITUTION RULES"
979 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3). The
980 only option used is \fBPCRE_UTF8\fR. Remember that the configuration
981 file syntax means you have to escape backslashes and quotes inside
984 In a \fISUBST\fR string the following sequences are interpreted
988 These expand to the first to ninth bracketed subexpression.
991 This expands to the matched part of the subject string.
994 This expands to a single \fB$\fR symbol.
996 All other pairs starting with \fB$\fR are undefined (and might be used
997 for something else in the future, so don't rely on the current
1000 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent. If
1001 \fBg\fR is present then all matches are replaced, otherwise only the first
1004 What the web interface actually does is terminated by the \fBaction\fR CGI
1005 argument. The values listed below are supported.
1007 Except as specified, all actions redirect back to the \fBplaying.html\fR
1008 template unless the \fBback\fR argument is present, in which case the URL it
1009 gives is used instead.
1011 Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present.
1014 Move track \fBid\fR by offset \fBdelta\fR.
1017 Play track \fBfile\fR, or if that is missing then play all the tracks in
1021 Don't change any state, but instead compute a suitable refresh time and include
1022 that in an HTTP header. Expands the \fBplaying.html\fR template rather than
1025 This is the default if \fBaction\fR is missing.
1028 Disables random play.
1031 Enables random play.
1034 Disables play completely.
1040 Pauses the current track.
1043 Remove track \fBid\fR.
1046 Resumes play after a pause.
1049 Scratch the playing track. If \fBid\fR is present it must match the playing
1053 Change the volume by \fBdelta\fR, or if that is missing then set it to the
1054 values of \fBleft\fR and \fBright\fR. Expands to the \fBvolume.html\fR template
1055 rather than redirecting.
1058 Adjust preferences from the \fBprefs.html\fR template (which it then expands
1059 rather than redirecting).
1063 is set then the cooked interface is assumed. The value of
1065 is used to determine which trackname preferences are set. By default the
1067 context is adjusted but this can be overridden with the
1071 argument is checked; if it is set then random play is enabled for that track,
1072 otherwise it is disabled.
1078 arguments are set then they are used to set a single preference.
1080 Otherwise if just the
1082 argument is set then that preference is deleted.
1084 It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to
1085 enure that the real track name is always used. Otherwise if the preferences
1086 page is used to adjust a trackname_ preference, the alias may change, leading
1087 to the URL going stale.
1090 This action is generated automatically when an error occurs connecting to the
1091 server. The \fBerror\fR label is set to an indication of what the error is.
1092 .SH "TRACK NAME PARTS"
1093 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1094 with the obvious intended meaning. These are controlled by configuration and
1095 by \fBtrackname_\fR preferences.
1097 In addition there are two built-in parts, \fBpath\fR which is the whole path
1098 name and \fBext\fR which is the filename extension, including the initial dot
1099 (or the empty string if there is not extension).
1101 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
1102 \fBpcrepattern\fR(3)
1103 .\" Local Variables:
~mdw / disorder / blob