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.
304 ALSA device to play raw-format audio. Default is \fBdefault\fR, i.e. to use
305 the whatever the ALSA configured default is.
308 Specifies the number of seconds to leave between tracks. The default
311 .B history \fIINTEGER\fR
312 Specifies the number of recently played tracks to remember (including
313 failed tracks and scratches).
315 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
316 Listen for connections on the address specified by \fIHOST\fR and port
317 specified by \fISERVICE\fR. If \fIHOST\fR is omitted then listens on all
320 Normally the server only listens on a UNIX domain socket.
323 Determines whether the server locks against concurrent operation. Default is
324 \fByes\fR. There is no good reason to set this to \fBno\fR and the option will
325 probably be removed in a future version.
328 The path to the mixer device, if you want access to the volume control,
329 e.g. \fB/dev/mixer\fR (the default).
331 .B multicast_loop yes\fR|\fBno
332 Determines whether multicast packets are loop backed to the sending host. The
333 default is \fByes\fR. This only applies if
334 \fBspeaker_backend\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
337 .B multicast_ttl \fIHOPS\fR
338 Set the maximum number of hops to send multicast packets. This only applies if
339 \fBspeaker_backend\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
340 multicast address. The default is 1.
342 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
343 Determines how to extract trackname part \fIPART\fR from a
344 track name (with the collection root part removed).
345 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
347 Track names can be different in different contexts. For instance the sort
348 string might include an initial track number, but this would be stripped for
349 the display string. \fICONTEXT\fR should be a glob pattern matching the
350 contexts in which this directive will be used.
352 Valid contexts are \fBsort\fR and \fBdisplay\fR.
354 All the \fBnamepart\fR directives are considered in order. The
355 first directive for the right part, that matches the desired context,
356 and with a \fIREGEXP\fR that
357 matches the track is used, and the value chosen is constructed from
358 \fISUBST\fR according to the substitution rules below.
360 Note that searches use the raw track name and \fBtrackname_\fR preferences but
361 not (currently) the results of \fBnamepart\fR, so generating words via this option
362 that aren't in the original track name will lead to confusing results.
364 If you supply no \fBnamepart\fR directives at all then a default set will be
365 supplied automatically. But if you supply even one then you must supply all of
366 them. The defaults are equivalent to:
369 namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
370 namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
371 namepart album "/([^/]+)/[^/]+$" $1 *
372 namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 *
373 namepart ext "(\\.[a-zA-Z0-9]+)$" $1 *
376 .B nice_rescan \fIPRIORITY\fR
377 Set the recan subprocess priority. The default is 10.
379 (Note that higher values mean the process gets less CPU time; UNIX priority
380 values are backwards.)
382 .B nice_server \fIPRIORITY\fR
383 Set the server priority. This is applied to the server at startup time (and
384 not when you reload configuration). The server does not use much CPU itself
385 but this value is inherited by programs it executes. If you have limited CPU
386 then it might help to set this to a small negative value. The default is 0.
388 .B nice_speaker \fIPRIORITY\fR
389 Set the speaker process priority. This is applied to the speaker process at
390 startup time (and not when you reload the configuration). The speaker process
391 is not massively CPU intensive by today's standards but depends on reasonably
392 timely scheduling. If you have limited CPU then it might help to set this to a
393 small negative value. The default is 0.
396 The maximum days that a track can survive in the database of newly added
397 tracks. The default is 31.
399 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
400 Specifies the player for files matching the glob \fIPATTERN\fR. \fIMODULE\fR
401 specifies which plugin module to use.
403 The following options are supported:
406 .B --wait-for-device\fR[\fB=\fIDEVICE\fR]
407 Waits (for up to a couple of seconds) for the default, or specified, libao
408 device to become openable.
411 Defines the end of the list of options. Needed if the first argument to the
412 plugin starts with a "-".
415 The following are the standard modules:
418 .B exec \fICOMMAND\fR \fIARGS\fR...
419 The command is executed via \fBexecvp\fR(3), not via the shell.
420 The \fBPATH\fR environment variable is searched for the executable if it is not
422 The command is expected to know how to open its own sound device.
424 .B execraw \fICOMMAND\fR \fIARGS\fR...
425 Identical to the \fBexec\fR except that the player is expected to use the
426 DisOrder raw player protocol.
427 .BR disorder-decode (8)
428 can decode several common audio file formats to this format. If your favourite
429 format is not supported, but you have a player which uses libao, there is also
430 a libao driver which supports this format; see below for more information about
433 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
434 The command is executed using the shell. If \fISHELL\fR is specified then that
435 is used, otherwise \fBsh\fR will be used. In either case the \fBPATH\fR
436 environment variable is searched for the shell executable if it is not an
437 absolute path. The track name is stored in the environment variable
440 Be careful of the interaction between the configuration file quoting rules and
441 the shell quoting rules.
444 If multiple player commands match a track then the first match is used.
446 For the server to be able to calculate track lengths, there should be a
448 command corresponding to each
454 is used without arguments, the list of players is cleared.
456 .B prefsync \fISECONDS\fR
457 The interval at which the preferences log file will be synchronised. Defaults
458 to 3600, i.e. one hour.
460 .B queue_pad \fICOUNT\fR
461 The target size of the queue. If random play is enabled then randomly picked
462 tracks will be added until the queue is at least this big. The default is 10.
464 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
465 Describes the sample format expected by the \fBspeaker_command\fR (below). The
466 components of the format specification are as follows:
470 The number of bits per sample. Optionally, may be suffixed by \fBb\fR or
471 \fBl\fR for big-endian and little-endian words. If neither is used the native
472 byte order is assumed.
475 The number of samples per second.
478 The number of channels.
485 backend the sample format is forced to
489 backend it is forced to
491 in both cases regardless of what is specified in the configuration file.
495 Defines the signal to be sent to track player process groups when tracks are
496 scratched. The default is \fBSIGKILL\fR.
498 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
499 or \fBInterrupted\fR or whatever.
501 .B speaker_backend \fINAME\fR
502 Selects the backend use by the speaker process. The following options are
507 Use the ALSA API. This is only available on Linux systems, on which it is the
511 Use Apple Core Audio. This only available on OS X systems, on which it is the
515 Use the OSS (/dev/dsp) API. Not available on all platforms.
518 Execute a command. This is the default if
520 is specified, or if no native is available.
523 Transmit audio over the network. This is the default if
524 \fBbroadcast\fR is specified. You can use
525 .BR disorder-playrtp (1)
526 to receive and play the resulting stream on Linux and OS X.
529 .B sox_generation \fB0\fR|\fB1
530 Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
531 the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1). See the
532 documentation for your installed copy of \fBsox\fR to determine which you need.
535 .B speaker_command \fICOMMAND
536 Causes the speaker subprocess to pipe audio data into shell command
537 \fICOMMAND\fR, rather than writing to a local sound card. The sample format is
542 Note that if the sample format is wrong then
544 is invoked to translate it. If
546 is not installed then this will not work.
548 .B scratch \fIPATH\fR
549 Specifies a scratch. When a track is scratched, a scratch track is
551 Scratches are played using the same logic as other tracks.
553 At least for the time being, path names of scratches must be encoded using
554 UTF-8 (which means that ASCII will do).
556 If \fBscratch\fR is used without arguments then the list of scratches is
559 .B stopword \fIWORD\fR ...
560 Specifies one or more stopwords that should not take part in searches
563 If \fBstopword\fR is used without arguments then the list of stopwords is
566 .B tracklength \fIPATTERN\fR \fIMODULE\fR
567 Specifies the module used to calculate the length of files matching
568 \fIPATTERN\fR. \fIMODULE\fR specifies which plugin module to use.
570 If \fBtracklength\fR is used without arguments then the list of modules is
574 Specifies the user to run as. Only makes sense if invoked as root (or
576 .SS "Client Configuration"
578 .B connect \fIHOST SERVICE\fR
579 Connect to the address specified by \fIHOST\fR and port specified by
581 .SS "Web Interface Configuration"
583 .B refresh \fISECONDS\fR
584 Specifies the maximum refresh period in seconds. Default 15.
586 .B short_display \fICHARACTERS\fR
587 Defines the maximum number of characters to include in a \fBshort\fR name
590 .B templates \fIPATH\fR ...
591 Specifies the directory containing templates used by the web
592 interface. If a template appears in more than one template directory
593 then the one in the earliest directory specified is chosen.
595 See below for further details.
597 If \fBtemplates\fR is used without arguments then the template path is cleared.
599 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
600 Determines how names are sorted and displayed in track choice displays.
602 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
603 \fBdir\fR but you can define your own.
605 \fICONTEXT\fR is a glob pattern matching the context. Standard contexts are
606 \fBsort\fR (which determines how directory names are sorted) and \fBdisplay\fR
607 (which determines how they are displayed). Again, you can define your
610 All the \fBtransform\fR directives are considered in order. If
611 the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
612 then a new track name is constructed from
613 \fISUBST\fR according to the substitution rules below. If several
614 match then each is executed in order.
616 If you supply no \fBtransform\fR directives at all then a default set will be
617 supplied automatically. But if you supply even one then you must supply all of
618 them. The defaults are:
621 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
622 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
623 transform dir "^.*/([^/]+)$" $1 *
624 transform dir "^(the) ([^/]*)" "$2 $1" sort i
625 transform dir "[[:punct:]]" "" sort g
629 Specifies the URL of the web interface. This URL will be used in
632 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
633 \fB/cgi-bin/jukebox\fR.
634 .SS "Authentication Configuration"
635 These options would normally be used in \fI~\fRUSER\fI/.disorder/passwd\fR or
636 \fIpkgconfdir/config.\fRUSER.
638 .B password \fIPASSWORD\fR
641 .B username \fIUSERNAME\fR
642 Specify username. The default is taken from the environment variable
644 .SH "GLOBAL PREFERENCES"
645 These are the values set with \fBset-global\fR.
648 If this is set an nonempty then randomly played tracks will always have at
649 least one of the listed tags.
652 If this is set an nonempty then randomly played tracks will never have any of
656 If unset or \fByes\fR then play is enabled. Otherwise it is disabled. Use
657 \fBdisable\fR rather than setting it directly.
660 If unset or \fByes\fR then random play is enabled. Otherwise it is disabled.
661 Use \fBdisable\fR rather than setting it directly.
663 Global preferences starting '_' are read-only (in the sense that you cannot
664 modify them; the server may modify them as part of its normal operation). They
668 The database version string. This is used by DisOrder to detect when it must
669 modify the database after an upgrade.
671 .SS "Raw Protocol Players"
672 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
673 Programs that use libao generally have command line options to select the
674 driver and pass options to it.
676 The known driver options are:
679 The file descriptor to write to. If this is not specified then the driver
680 looks like the environment variable \fBDISORDER_RAW_FD\fR. If that is not set
681 then the default is 1 (i.e. standard output).
684 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
685 write to the output file descriptor fails. This is a workaround for buggy
686 players such as \fBogg123\fR that ignore write errors.
688 When \fBdisorder.cgi\fR wants to generate a page for an action it searches the
689 directories specified with \fBtemplates\fR for a matching file. It is
690 suggested that you leave the distributed templates unchanged and put
691 any customisations in an earlier entry in the template path.
693 The supplied templates are:
696 Display information about DisOrder.
699 Navigates through the track database to choose a track to play. The
700 \fBdir\fR argument gives the directory to look in; if it is missing
701 then the root directory is used.
704 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
705 directories to be selected by initial letter.
708 Lists newly added tracks.
711 The "front page", which usually shows the currently playing tracks and
713 Gets an HTTP \fBRefresh\fR header.
715 If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra
716 buttons for moving tracks up and down in the queue. There is some logic in
717 \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR is preserved across refreshes
718 and redirects back into itself, but URLs embedded in web pages must include it
722 Views preferences. If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are
723 all set then that preference is modified; if \fBfile\fR and \fBname\fR are set
724 but not \fBvalue\fR then the preference is deleted.
727 Lists recently played tracks.
730 Presents search results.
733 Primitive volume control.
735 Additionally, other standard files are included by these:
738 Included at the end of the main content \fB<DIV>\fR element.
741 Included at the start of the \fB<BODY>\fR element. (This supplants
742 \fBsidebar.html\fR, though the latter is still available; override label
743 \fBmenu\fR to choose between them.)
746 Included in the \fB<HEAD>\fR element.
749 Contains the default DisOrder stylesheet. You can override this by editing the
750 CSS or by replacing it all with a \fB<LINK>\fR to an external stylesheet.
752 Templates are ASCII files containing HTML documents, with an expansion
753 syntax to enable data supplied by the implementation to be inserted.
755 If you want to use characters outside the ASCII range, use either the
756 appropriate HTML entity, e.g. \fBé\fR, or an SGML numeric
757 character reference, e.g. \fBý\fR. Use \fB@\fR to insert a
758 literal \fB@\fR without falling foul of the expansion syntax.
759 .SS "Expansion Syntax"
760 Expansions are surrounded by at ("@") symbols take the form of a keyword
761 followed by zero or more arguments. Arguments may either be quoted by curly
762 brackets ("{" and "}") or separated by colons (":"). Both kinds may be mixed
763 in a single expansion, though doing so seems likely to cause confusion.
764 The descriptions below contain suggested forms for each
767 Leading and trailing whitespace in unquoted arguments is ignored, as is
768 whitespace (including newlines) following a close bracket ("}").
770 Arguments are recursively expanded before being interpreted, except for
771 \fITEMPLATE\fR arguments. These are expanded (possibly more than once) to
772 produce the final expansion.
773 (More than once means the same argument being expanded more than once
774 for different tracks or whatever, not the result of the first
775 expansion itself being re-expanded.)
777 Strings constructed by expansions (i.e. not literally copied from the template
778 text) are SGML-quoted: any character which does not stand for itself in #PCDATA
779 or a quoted attribute value is replaced by the appropriate numeric character
782 The exception to this is that such strings are \fInot\fR quoted when they are
783 generated in the expansion of a parameter.
785 In the descriptions below, the current track means the one set by
786 \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing.
787 If none of these expansions are in force then there is no current track.
788 \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR.
790 The following expansion keywords are defined:
792 .B @#{\fICOMMENT\fB}@
796 The current action. This reports
798 if the action is really
804 .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
805 If there are no arguments, or all the arguments are \fBtrue\fB, then expands to
806 \fBtrue\fR, otherwise to \fBfalse\fR.
809 Expands to the value of CGI argument \fINAME\fR.
812 The basename of the current directory component, in \fB@navigate@\fR.
814 .B @basename{\fIPATH\fB}@
815 The base name part of \fIPATH\fR.
817 .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@
818 Expands \fITEMPLATE\fR repeatedly for each file or directory under
819 \fB@arg:directory@\fR.
820 \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR.
821 Use \fB@file@\fR to get the display name or filename of the file or
823 Usually used in \fBchoose.html\fR.
826 The directory of the current directory component, in \fB@navigate@\fR.
828 .B @dirname{\fIPATH\fB}@
829 The directory part of \fIPATH\fR.
832 Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR.
834 .B @eq{\fIA\fB}{\fIB\fB}
835 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to
839 Expands to the filename of the current file or directory, inside the template
840 argument to \fBchoose\fR.
842 .B @files{\fITEMPLATE\fB}
843 Expands \fITEMPLATE\fR once for each file indicated by the \fBdirectory\fR CGI
844 arg if it is present, or otherwise for the list of files counted by \fBfiles\fR
845 with names \fB0_file\fR, \fB1_file\fR etc.
848 The full path of the current directory component, in \fB@navigate@\fR.
851 The ID of the current track.
853 .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
854 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
855 to \fIFALSEPART\fR (which may be omitted).
857 .B @include:\fIPATH\fR@
858 Include the named file as if it were a template file. If \fIPATH\fR
859 starts with a \fB/\fR then it is used as-is; otherwise, ".html" is
860 appended and the template path is searched.
863 Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or
867 Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR,
868 otherwise to \fBfalse\fR.
871 Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR,
872 otherwise to \fBfalse\fR.
875 Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR
876 argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
879 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
880 loop, otherwise to \fBfalse\fR.
883 Expands to \fBtrue\fR if the newly added tracks list has any tracks in it,
884 otherwise to \fBfalse\fR.
887 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
890 Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to
894 Expands to \fBtrue\fR if the recently played list has any tracks in it,
895 otherwise to \fBfalse\fR.
897 .B @label:\fINAME\fR\fB@
898 Expands to the value of label \fINAME\fR. See the shipped \fIoptions.labels\fR
899 file for full documentation of the labels used by the standard templates.
902 Expands to the length of the current track.
904 .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB}
905 Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn.
906 Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to
908 Usually used in \fBchoose.html\fR.
910 .B @ne{\fIA\fB}{\fIB\fB}
911 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
913 .B @new{\fITEMPLATE\fB}
914 Expands \fITEMPLATE\fR for each track in the newly added tracks list, starting
915 with the most recent. Used in \fBnew.html\fR.
918 Expands to the number of files from \fB@files\fR (above).
921 Expands to a string including the time and process ID, intended to be
922 unique across invocations.
925 Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to
928 .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
929 If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise
933 Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at
934 an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR.
936 .B @part{\fICONTEXT\fB}{\fIPART\fB}@
937 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the
938 current track. The context may be omitted and defaults
941 The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to
942 the \fBshort_display\fR limit.
944 .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@
945 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for
946 \fITRACK\fR. In this usage the context may not be omitted.
948 The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to
949 the \fBshort_display\fR limit.
952 Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.
954 .B @playing{\fITEMPLATE\fB}@
955 Expands \fITEMPLATE\fR using the playing track as the current track.
957 .B @pref{\fITRACK\fB}{\fIKEY\fB}@
958 Expand to the track preference, or the empty string if it is not set.
961 Expands to the name of the current preference, in the template
962 argument of \fB@prefs@\fR.
964 .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@
965 Expands \fITEMPLATE\fR repeatedly, for each preference of track
967 Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value.
970 Expands to the value of the current preference, in the template
971 argument of \fB@prefs@\fR.
973 .B @queue{\fITEMPLATE\fB}@
974 Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as
975 the current track. The track at the head of the queue comes first.
978 Expands to \fBtrue\fR if random play is currently enabled, otherwise to
981 .B @recent{\fITEMPLATE\fB}@
982 Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn
983 as the current track. The most recently played track comes first.
985 .B @resolve{\fITRACK\fB}@
986 Resolve aliases for \fITRACK\fR and expands to the result.
988 .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@
989 Expands \fITEMPLATE\fR once for each group of search results that have
990 a common value of track part \fIPART\fR.
991 The groups are sorted by the value of the part.
996 within the template will apply to one of the tracks in the group.
998 If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR,
999 and determines the context for \fIPART\fR. The default is \fBsort\fR. Usually
1000 you want \fBdisplay\fR for everything except the title and \fBsort\fR for the
1001 title. If you use \fBsort\fR for artist and album then you are likely to get
1005 Expands to the server's version string.
1007 .B @shell{\fICOMMAND\fB}@
1008 Expands to the output of \fICOMMAND\fR executed via the shell. \fBsh\fR is
1009 searched for using \fBPATH\fR. If the command fails then this is logged but
1013 In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current
1014 track. Otherwise the empty string. Known states are:
1018 The player terminated with nonzero status, but not because the track was
1022 A scratch, in the queue.
1025 No player could be found.
1028 Played successfully.
1031 A randomly chosen track, in the queue.
1034 This track was scratched.
1037 An explicitly queued track, in the queue.
1040 Some additional states only apply to playing tracks, so will never be seen in
1041 the queue or recently-played list:
1045 The track has been paused.
1048 Interrupted because the server is shutting down.
1051 This track is currently playing.
1055 Expands to the server statistics.
1058 Expands to the URL of the current page. Typically used in
1060 arguments. If there is a
1062 argument then it is changed to a fresh value.
1067 .B @trackstate{\fIPATH\fB}@
1068 Expands to the current track state: \fBplaying\fR if the track is actually
1069 playing now, \fBqueued\fR if it is queued or the empty string otherwise.
1071 .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@
1072 Transform a path according to \fBtransform\fR (see above).
1073 \fIPATH\fR should be a raw filename (of a track or directory).
1074 \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR).
1075 \fICONTEXT\fR should be the context, and can be omitted (the default
1079 Expands to the canonical URL as defined in \fIpkgconfdir/config\fR.
1081 .B @urlquote{\fISTRING\fB}@
1082 URL-quote \fISTRING\fR.
1085 Expands to \fBdisorder.cgi\fR's version string.
1087 .B @volume:\fISPEAKER\fB@
1088 The volume on the left or right speaker. \fISPEAKER\fR must be \fBleft\fR or
1092 When the current track was played (or when it is expected to be played, if it
1093 has not been played yet)
1096 Who submitted the current track.
1098 This is a file called \fIoptions\fR, searched for in the same manner
1099 as templates. It includes numerous options for the control of the web
1100 interface. The general syntax is the same as the main configuration
1101 file, except that it should be encoded using UTF-8 (though this might
1102 change to the current locale's character encoding; stick to ASCII to
1105 The shipped \fIoptions\fR file includes four standard options files.
1109 The default labels file. You wouldn't normally edit this directly - instead
1110 supply your own commands in \fIoptions.user\fR. Have a look at the shipped
1111 version of the file for documentation of labels used by the standard templates.
1114 A user options file. Here you should put any overrides for the default
1115 labels and any extra labels required by your modified templates.
1117 Valid directives are:
1119 .B columns \fINAME\fR \fIHEADING\fR...
1120 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB. \fINAME\fR
1121 must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
1122 \fIHEADING\fR... is a list of
1123 heading names. If a column is defined more than once then the last definitions
1126 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
1129 .B include \fIPATH\fR
1130 Includes another file. If \fIPATH\fR starts with a \fB/\fR then it is
1131 taken as is, otherwise it is searched for in the template path.
1133 .B label \fINAME\fR \fIVALUE\fR
1134 Define a label. If a label is defined more than once then the last definition
1137 Some labels are defined inside \fBdisorder.cgi\fR and others by the
1138 default templates. You can define your own labels and use them inside
1141 When an undefined label is expanded, if it has a dot in its name then
1142 the part after the final dot is used as its value. Otherwise the
1143 whole name is used as the value.
1145 Labels are no longer documented here, see the shipped \fIoptions.labels\fR file
1147 .SH "REGEXP SUBSTITUTION RULES"
1148 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3). The
1149 only option used is \fBPCRE_UTF8\fR. Remember that the configuration
1150 file syntax means you have to escape backslashes and quotes inside
1153 In a \fISUBST\fR string the following sequences are interpreted
1157 These expand to the first to ninth bracketed subexpression.
1160 This expands to the matched part of the subject string.
1163 This expands to a single \fB$\fR symbol.
1165 All other pairs starting with \fB$\fR are undefined (and might be used
1166 for something else in the future, so don't rely on the current
1169 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent. If
1170 \fBg\fR is present then all matches are replaced, otherwise only the first
1173 What the web interface actually does is terminated by the \fBaction\fR CGI
1174 argument. The values listed below are supported.
1176 Except as specified, all actions redirect back to the \fBplaying.html\fR
1177 template unless the \fBback\fR argument is present, in which case the URL it
1178 gives is used instead.
1180 Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present.
1183 Move track \fBid\fR by offset \fBdelta\fR.
1186 Play track \fBfile\fR, or if that is missing then play all the tracks in
1190 Don't change any state, but instead compute a suitable refresh time and include
1191 that in an HTTP header. Expands the \fBplaying.html\fR template rather than
1194 This is the default if \fBaction\fR is missing.
1197 Disables random play.
1200 Enables random play.
1203 Disables play completely.
1209 Pauses the current track.
1212 Remove track \fBid\fR.
1215 Resumes play after a pause.
1218 Scratch the playing track. If \fBid\fR is present it must match the playing
1222 Change the volume by \fBdelta\fR, or if that is missing then set it to the
1223 values of \fBleft\fR and \fBright\fR. Expands to the \fBvolume.html\fR template
1224 rather than redirecting.
1227 Adjust preferences from the \fBprefs.html\fR template (which it then expands
1228 rather than redirecting).
1232 is set then the cooked interface is assumed. The value of
1234 is used to determine which trackname preferences are set. By default the
1236 context is adjusted but this can be overridden with the
1240 argument is checked; if it is set then random play is enabled for that track,
1241 otherwise it is disabled.
1247 arguments are set then they are used to set a single preference.
1249 Otherwise if just the
1251 argument is set then that preference is deleted.
1253 It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to
1254 enure that the real track name is always used. Otherwise if the preferences
1255 page is used to adjust a trackname_ preference, the alias may change, leading
1256 to the URL going stale.
1259 This action is generated automatically when an error occurs connecting to the
1260 server. The \fBerror\fR label is set to an indication of what the error is.
1261 .SH "TRACK NAME PARTS"
1262 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1263 with the obvious intended meaning. These are controlled by configuration and
1264 by \fBtrackname_\fR preferences.
1266 In addition there are two built-in parts, \fBpath\fR which is the whole path
1267 name and \fBext\fR which is the filename extension, including the initial dot
1268 (or the empty string if there is not extension).
1270 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
1271 \fBpcrepattern\fR(3)
1272 .\" Local Variables:
~mdw / disorder / blob