2 .\" Copyright (C) 2004-2008 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 will be abolished in future.
205 .I ~\fRUSER\fI/.disorder/passwd
206 Per-user client configuration. Optional but if it exists must be
207 readable only by the relevant user. Would normally contain a
208 \fBpassword\fR directive.
210 .I pkgconfdir/config.\fRUSER
211 Per-user system-controlled client configuration. Optional but if it
212 exists must be readable only by the relevant user. Would normally
213 contain a \fBpassword\fR directive.
215 The prefererred location for per-user passwords is \fI~/.disorder/passwd\fR and
216 \fBdisorder authorize\fR writes there now.
217 .SS "Global Configuration"
219 .B home \fIDIRECTORY\fR
220 The home directory for state files. Defaults to
222 The server will create this directory on startup if it does not exist.
224 .B plugins \fIPATH\fR
225 Adds a directory to the plugin path. (This is also used by the web
228 Plugins are opened the first time they are required and never after,
229 so after changing a plugin you must restart the server before it is
230 guaranteed to take effect.
234 is used without arguments the plugin path is cleared.
235 .SS "Server Configuration"
237 .B alias \fIPATTERN\fR
238 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
241 Most characters stand for themselves, the exception being \fB{\fR which is used
242 to insert a track name part in the form \fB{\fIname\fB}\fR or
245 The difference is that the first form just inserts the name part while the
246 second prefixes it with a \fB/\fR if it is nonempty.
248 The pattern should not attempt to include the collection root, which is
249 automatically included, but should include the proper extension.
251 The default is \fB{/artist}{/album}{/title}{ext}\fR.
254 Selects the backend used to play sound and to set the volume. The following
255 options are available:
259 Use the ALSA API. This is only available on Linux systems, on which it is the
263 Use Apple Core Audio. This only available on OS X systems, on which it is the
267 Use the OSS (/dev/dsp) API. Not available on all platforms.
270 Execute a command. This is the default if
272 is specified, or if no native is available.
275 Transmit audio over the network. This is the default if
276 \fBbroadcast\fR is specified. You can use
277 .BR disorder-playrtp (1)
278 to receive and play the resulting stream on Linux and OS X.
281 .B authorization_algorithm \fIALGORITHM\fR
282 Defines the algorithm used to authenticate clients. The valid options
283 are sha1 (the default), sha256, sha384 and sha512. See
284 .BR disorder_protocol (5)
287 .B broadcast \fIADDRESS\fR \fIPORT\fR
288 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. This implies
291 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
293 .B broadcast_from \fIADDRESS\fR \fIPORT\fR
294 Sets the (local) source address used by \fBbroadcast\fR.
296 .B channel \fICHANNEL\fR
297 The mixer channel that the volume control should use.
299 For \fBapi oss\fR the possible values are:
303 Output level for the audio device. This is probably what you want and is the
307 Output level for the PC speaker, if that is connected to the sound card.
310 Output level for alternative codec device.
313 Master output level. The OSS documentation recommends against using this, as
314 it affects all output devices.
317 You can also specify channels by number, if you know the right value.
319 For \fBapi alsa\fR, this is the name of the mixer control to use. The default
320 is \fBPCM\fR. Use \fBamixer scontrols\fR or similar to get a full list.
322 For \fBapi coreaudio\fR, volume setting is not currently supported.
324 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
326 .B collection \fIMODULE\fR \fIROOT\fR
328 .B collection \fIROOT\fR
329 Define a collection of tracks.
331 \fIMODULE\fR defines which plugin module should be used for this
332 collection. Use the supplied \fBfs\fR module for tracks that exist
333 as ordinary files in the filesystem. If no \fIMODULE\fR is specified
334 then \fBfs\fR is assumed.
336 \fIENCODING\fR defines the encoding of filenames in this collection. For
337 \fBfs\fR this would be the encoding you use for filenames. Examples might be
338 \fBiso-8859-1\fR or \fButf-8\fR. If no encoding is specified then the current
339 locale's character encoding is used.
341 NB that this default depends on the locale the server runs in, which is not
342 necessarily the same as that of ordinary users, depending how the system is
343 configured. It's best to explicitly specify it to be certain.
345 \fIROOT\fR is the root in the filesystem of the filenames and is
346 passed to the plugin module. It must be an absolute path and should not
349 .B default_rights \fIRIGHTS\fR
350 Defines the set of rights given to new users. The argument is a
351 comma-separated list of rights. For the possible values see
352 .B "Users And Access Control"
355 The default is to allow everything except \fBadmin\fR and \fBregister\fR
356 (modified in legacy configurations by the obsolete \fBrestrict\fR directive).
361 For \fBapi oss\fR this is the path to the device to use. If it is set to
362 \fBdefault\fR then \fI/dev/dsp\fR and \fI/dev/audio\fR will be tried.
364 For \fBapi alsa\fR this is the device name to use.
366 For \fBapi coreaudio\fR this is currently ignored.
368 The default is \fBdefault\fR, which is intended to map to whatever the system's
372 Specifies the number of seconds to leave between tracks. The default
375 .B history \fIINTEGER\fR
376 Specifies the number of recently played tracks to remember (including
377 failed tracks and scratches).
379 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
380 Listen for connections on the address specified by \fIHOST\fR and port
381 specified by \fISERVICE\fR. If \fIHOST\fR is omitted then listens on all
384 Normally the server only listens on a UNIX domain socket.
387 Determines whether the server locks against concurrent operation. Default is
388 \fByes\fR. There is no good reason to set this to \fBno\fR and the option will
389 probably be removed in a future version.
391 .B mixer \fIDEVICE\fR
392 The mixer device name, if it needs to be specified separately from
395 For \fBapi oss\fR this should be the path to the mixer device and the default
398 For \fBapi alsa\fR, this is the index of the mixer control to use. The default
401 For \fBapi coreaudio\fR, volume setting is not currently supported.
403 .B multicast_loop yes\fR|\fBno
404 Determines whether multicast packets are loop backed to the sending host. The
405 default is \fByes\fR. This only applies if
406 \fBapi\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
409 .B multicast_ttl \fIHOPS\fR
410 Set the maximum number of hops to send multicast packets. This only applies if
411 \fBapi\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
412 multicast address. The default is 1.
414 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
415 Determines how to extract trackname part \fIPART\fR from a
416 track name (with the collection root part removed).
417 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
419 Track names can be different in different contexts. For instance the sort
420 string might include an initial track number, but this would be stripped for
421 the display string. \fICONTEXT\fR should be a glob pattern matching the
422 contexts in which this directive will be used.
424 Valid contexts are \fBsort\fR and \fBdisplay\fR.
426 All the \fBnamepart\fR directives are considered in order. The
427 first directive for the right part, that matches the desired context,
428 and with a \fIREGEXP\fR that
429 matches the track is used, and the value chosen is constructed from
430 \fISUBST\fR according to the substitution rules below.
432 Note that searches use the raw track name and \fBtrackname_\fR preferences but
433 not (currently) the results of \fBnamepart\fR, so generating words via this option
434 that aren't in the original track name will lead to confusing results.
436 If you supply no \fBnamepart\fR directives at all then a default set will be
437 supplied automatically. But if you supply even one then you must supply all of
438 them. The defaults are equivalent to:
441 namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
442 namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
443 namepart album "/([^/]+)/[^/]+$" $1 *
444 namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 *
445 namepart ext "(\\.[a-zA-Z0-9]+)$" $1 *
449 The maximum number of tracks to list when reporting newly noticed tracks. The
452 .B nice_rescan \fIPRIORITY\fR
453 Set the recan subprocess priority. The default is 10.
455 (Note that higher values mean the process gets less CPU time; UNIX priority
456 values are backwards.)
458 .B nice_server \fIPRIORITY\fR
459 Set the server priority. This is applied to the server at startup time (and
460 not when you reload configuration). The server does not use much CPU itself
461 but this value is inherited by programs it executes. If you have limited CPU
462 then it might help to set this to a small negative value. The default is 0.
464 .B nice_speaker \fIPRIORITY\fR
465 Set the speaker process priority. This is applied to the speaker process at
466 startup time (and not when you reload the configuration). The speaker process
467 is not massively CPU intensive by today's standards but depends on reasonably
468 timely scheduling. If you have limited CPU then it might help to set this to a
469 small negative value. The default is 0.
472 The maximum days that a track can survive in the database of newly added
473 tracks. The default is 31.
475 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
476 Specifies the player for files matching the glob \fIPATTERN\fR. \fIMODULE\fR
477 specifies which plugin module to use.
479 The following options are supported:
482 .B --wait-for-device\fR[\fB=\fIDEVICE\fR]
483 Waits (for up to a couple of seconds) for the default, or specified, libao
484 device to become openable.
487 Defines the end of the list of options. Needed if the first argument to the
488 plugin starts with a "-".
491 The following are the standard modules:
494 .B exec \fICOMMAND\fR \fIARGS\fR...
495 The command is executed via \fBexecvp\fR(3), not via the shell.
496 The \fBPATH\fR environment variable is searched for the executable if it is not
498 The command is expected to know how to open its own sound device.
500 .B execraw \fICOMMAND\fR \fIARGS\fR...
501 Identical to the \fBexec\fR except that the player is expected to use the
502 DisOrder raw player protocol.
503 .BR disorder-decode (8)
504 can decode several common audio file formats to this format. If your favourite
505 format is not supported, but you have a player which uses libao, there is also
506 a libao driver which supports this format; see below for more information about
509 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
510 The command is executed using the shell. If \fISHELL\fR is specified then that
511 is used, otherwise \fBsh\fR will be used. In either case the \fBPATH\fR
512 environment variable is searched for the shell executable if it is not an
513 absolute path. The track name is stored in the environment variable
516 Be careful of the interaction between the configuration file quoting rules and
517 the shell quoting rules.
520 If multiple player commands match a track then the first match is used.
522 For the server to be able to calculate track lengths, there should be a
524 command corresponding to each
530 is used without arguments, the list of players is cleared.
532 .B prefsync \fISECONDS\fR
533 The interval at which the preferences log file will be synchronised. Defaults
534 to 3600, i.e. one hour.
536 .B queue_pad \fICOUNT\fR
537 The target size of the queue. If random play is enabled then randomly picked
538 tracks will be added until the queue is at least this big. The default is 10.
540 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
541 Describes the sample format expected by the \fBspeaker_command\fR (below). The
542 components of the format specification are as follows:
546 The number of bits per sample. Optionally, may be suffixed by \fBb\fR or
547 \fBl\fR for big-endian and little-endian words. If neither is used the native
548 byte order is assumed.
551 The number of samples per second.
554 The number of channels.
561 backend the sample format is forced to
565 backend it is forced to
567 in both cases regardless of what is specified in the configuration file.
571 Defines the signal to be sent to track player process groups when tracks are
572 scratched. The default is \fBSIGKILL\fR.
574 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
575 or \fBInterrupted\fR or whatever.
577 .B sox_generation \fB0\fR|\fB1
578 Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
579 the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1). See the
580 documentation for your installed copy of \fBsox\fR to determine which you need.
583 .B speaker_backend \fINAME
584 This is an alias for \fBapi\fR; see above.
586 .B speaker_command \fICOMMAND
587 Causes the speaker subprocess to pipe audio data into shell command
588 \fICOMMAND\fR, rather than writing to a local sound card. The sample format is
593 Note that if the sample format is wrong then
595 is invoked to translate it. If
597 is not installed then this will not work.
599 .B scratch \fIPATH\fR
600 Specifies a scratch. When a track is scratched, a scratch track is
602 Scratches are played using the same logic as other tracks.
604 At least for the time being, path names of scratches must be encoded using
605 UTF-8 (which means that ASCII will do).
607 If \fBscratch\fR is used without arguments then the list of scratches is
610 .B stopword \fIWORD\fR ...
611 Specifies one or more stopwords that should not take part in searches
614 If \fBstopword\fR is used without arguments then the list of stopwords is
617 There is a default set of stopwords built in, but this option can be used to
618 augment or replace that list.
620 .B tracklength \fIPATTERN\fR \fIMODULE\fR
621 Specifies the module used to calculate the length of files matching
622 \fIPATTERN\fR. \fIMODULE\fR specifies which plugin module to use.
624 If \fBtracklength\fR is used without arguments then the list of modules is
628 Specifies the user to run as. Only makes sense if invoked as root (or
630 .SS "Client Configuration"
632 .B connect \fIHOST SERVICE\fR
633 Connect to the address specified by \fIHOST\fR and port specified by
635 .SS "Web Interface Configuration"
637 .B mail_sender \fIADDRESS\fR
638 The email address that appears in the From: field of any mail messages sent by
639 the web interface. This must be set if you have online registration enabled.
641 .B refresh \fISECONDS\fR
642 Specifies the maximum refresh period in seconds. Default 15.
644 .B short_display \fICHARACTERS\fR
645 Defines the maximum number of characters to include in a \fBshort\fR name
648 .B smtp_server \fIHOSTNAME\fR
649 The hostname (or address) of the SMTP server to use for sending mail. The
650 default is 127.0.0.1.
652 .B templates \fIPATH\fR ...
653 Specifies the directory containing templates used by the web
654 interface. If a template appears in more than one template directory
655 then the one in the earliest directory specified is chosen.
657 See below for further details.
659 If \fBtemplates\fR is used without arguments then the template path is cleared.
661 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
662 Determines how names are sorted and displayed in track choice displays.
664 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
665 \fBdir\fR but you can define your own.
667 \fICONTEXT\fR is a glob pattern matching the context. Standard contexts are
668 \fBsort\fR (which determines how directory names are sorted) and \fBdisplay\fR
669 (which determines how they are displayed). Again, you can define your
672 All the \fBtransform\fR directives are considered in order. If
673 the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
674 then a new track name is constructed from
675 \fISUBST\fR according to the substitution rules below. If several
676 match then each is executed in order.
678 If you supply no \fBtransform\fR directives at all then a default set will be
679 supplied automatically. But if you supply even one then you must supply all of
680 them. The defaults are:
683 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
684 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
685 transform dir "^.*/([^/]+)$" $1 *
686 transform dir "^(the) ([^/]*)" "$2 $1" sort i
687 transform dir "[[:punct:]]" "" sort g
691 Specifies the URL of the web interface. This URL will be used in
692 generated web pages. The default is inferred at runtime, so this option no
693 longer needs to be specified.
695 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
696 \fB/cgi-bin/jukebox\fR.
697 .SS "Authentication Configuration"
698 These options would normally be used in \fI~\fRUSER\fI/.disorder/passwd\fR or
699 \fIpkgconfdir/config.\fRUSER.
701 .B password \fIPASSWORD\fR
704 .B username \fIUSERNAME\fR
705 Specify username. The default is taken from the environment variable
707 .SH "GLOBAL PREFERENCES"
708 These are the values set with \fBset-global\fR.
711 If this is set an nonempty then randomly played tracks will always have at
712 least one of the listed tags.
715 If this is set an nonempty then randomly played tracks will never have any of
719 If unset or \fByes\fR then play is enabled. Otherwise it is disabled. Use
720 \fBdisable\fR rather than setting it directly.
723 If unset or \fByes\fR then random play is enabled. Otherwise it is disabled.
724 Use \fBdisable\fR rather than setting it directly.
726 Global preferences starting '_' are read-only (in the sense that you cannot
727 modify them; the server may modify them as part of its normal operation). They
731 The database version string. This is used by DisOrder to detect when it must
732 modify the database after an upgrade.
734 .SS "Raw Protocol Players"
735 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
736 Programs that use libao generally have command line options to select the
737 driver and pass options to it.
739 The known driver options are:
742 The file descriptor to write to. If this is not specified then the driver
743 looks like the environment variable \fBDISORDER_RAW_FD\fR. If that is not set
744 then the default is 1 (i.e. standard output).
747 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
748 write to the output file descriptor fails. This is a workaround for buggy
749 players such as \fBogg123\fR that ignore write errors.
751 When \fBdisorder.cgi\fR wants to generate a page for an action it searches the
752 directories specified with \fBtemplates\fR for a matching file. It is
753 suggested that you leave the distributed templates unchanged and put
754 any customisations in an earlier entry in the template path.
756 The supplied templates are:
759 Display information about DisOrder.
762 Navigates through the track database to choose a track to play. The
763 \fBdir\fR argument gives the directory to look in; if it is missing
764 then the root directory is used.
767 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
768 directories to be selected by initial letter.
771 Lists newly added tracks.
774 The "front page", which usually shows the currently playing tracks and
776 Gets an HTTP \fBRefresh\fR header.
778 If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra
779 buttons for moving tracks up and down in the queue. There is some logic in
780 \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR is preserved across refreshes
781 and redirects back into itself, but URLs embedded in web pages must include it
785 Views preferences. If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are
786 all set then that preference is modified; if \fBfile\fR and \fBname\fR are set
787 but not \fBvalue\fR then the preference is deleted.
790 Lists recently played tracks.
793 Presents search results.
796 Primitive volume control.
798 Additionally, other standard files are included by these:
801 Included at the end of the main content \fB<DIV>\fR element.
804 Included at the start of the \fB<BODY>\fR element.
807 Included at the end of the \fB<BODY>\fR element.
810 Included in the \fB<HEAD>\fR element.
813 Contains the default DisOrder stylesheet. You can override this by editing the
814 CSS or by replacing it all with a \fB<LINK>\fR to an external stylesheet.
816 Templates are ASCII files containing HTML documents, with an expansion
817 syntax to enable data supplied by the implementation to be inserted.
819 If you want to use characters outside the ASCII range, use either the
820 appropriate HTML entity, e.g. \fBé\fR, or an SGML numeric
821 character reference, e.g. \fBý\fR. Use \fB@\fR to insert a
822 literal \fB@\fR without falling foul of the expansion syntax.
823 .SS "Expansion Syntax"
824 Expansions are surrounded by at ("@") symbols take the form of a keyword
825 followed by zero or more arguments. Arguments may either be quoted by curly
826 brackets ("{" and "}") or separated by colons (":"). Both kinds may be mixed
827 in a single expansion, though doing so seems likely to cause confusion.
828 The descriptions below contain suggested forms for each
831 Leading and trailing whitespace in unquoted arguments is ignored, as is
832 whitespace (including newlines) following a close bracket ("}").
834 Arguments are recursively expanded before being interpreted, except for
835 \fITEMPLATE\fR arguments. These are expanded (possibly more than once) to
836 produce the final expansion.
837 (More than once means the same argument being expanded more than once
838 for different tracks or whatever, not the result of the first
839 expansion itself being re-expanded.)
841 Strings constructed by expansions (i.e. not literally copied from the template
842 text) are SGML-quoted: any character which does not stand for itself in #PCDATA
843 or a quoted attribute value is replaced by the appropriate numeric character
846 The exception to this is that such strings are \fInot\fR quoted when they are
847 generated in the expansion of a parameter.
849 In the descriptions below, the current track means the one set by
850 \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing.
851 If none of these expansions are in force then there is no current track.
852 \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR.
854 The following expansion keywords are defined:
856 .B @#{\fICOMMENT\fB}@
860 The current action. This reports
862 if the action is really
868 .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
869 If there are no arguments, or all the arguments are \fBtrue\fB, then expands to
870 \fBtrue\fR, otherwise to \fBfalse\fR.
873 Expands to the value of CGI argument \fINAME\fR.
876 The basename of the current directory component, in \fB@navigate@\fR.
878 .B @basename{\fIPATH\fB}@
879 The base name part of \fIPATH\fR.
881 .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@
882 Expands \fITEMPLATE\fR repeatedly for each file or directory under
883 \fB@arg:directory@\fR.
884 \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR.
885 Use \fB@file@\fR to get the display name or filename of the file or
887 Usually used in \fBchoose.html\fR.
890 The directory of the current directory component, in \fB@navigate@\fR.
892 .B @dirname{\fIPATH\fB}@
893 The directory part of \fIPATH\fR.
896 Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR.
898 .B @eq{\fIA\fB}{\fIB\fB}
899 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to
903 Expands to the filename of the current file or directory, inside the template
904 argument to \fBchoose\fR.
906 .B @files{\fITEMPLATE\fB}
907 Expands \fITEMPLATE\fR once for each file indicated by the \fBdirectory\fR CGI
908 arg if it is present, or otherwise for the list of files counted by \fBfiles\fR
909 with names \fB0_file\fR, \fB1_file\fR etc.
912 The full path of the current directory component, in \fB@navigate@\fR.
915 The ID of the current track.
917 .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
918 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
919 to \fIFALSEPART\fR (which may be omitted).
921 .B @image:\fINAME\fB@
922 Expands to the (possibly relative) URL for image \fINAME\fR.
924 If there is a label \fBimages.\fINAME\fR then that will be the image base name.
925 Otherwise the image base name is \fINAME\fB.png\fR or just \fINAME\fR if it
926 alraedy has an extension. Thus labels may be defined to give images role
929 If there is a label \fBurl.static\fR then that is the base URL for images. If
930 it is not defined then \fB/disorder\fR is used as a default.
932 .B @include:\fIPATH\fB@
933 Include the named file as if it were a template file. If \fIPATH\fR
934 starts with a \fB/\fR then it is used as-is; otherwise, ".html" is
935 appended and the template path is searched.
938 Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or
942 Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR,
943 otherwise to \fBfalse\fR.
946 Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR,
947 otherwise to \fBfalse\fR.
950 Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR
951 argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
954 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
955 loop, otherwise to \fBfalse\fR.
958 Expands to \fBtrue\fR if the newly added tracks list has any tracks in it,
959 otherwise to \fBfalse\fR.
962 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
965 Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to
969 Expands to \fBtrue\fR if the recently played list has any tracks in it,
970 otherwise to \fBfalse\fR.
972 .B @label:\fINAME\fR\fB@
973 Expands to the value of label \fINAME\fR. See the shipped \fIoptions.labels\fR
974 file for full documentation of the labels used by the standard templates.
977 Expands to the length of the current track.
980 Expands to \fBtrue\fR if the current track is movable, otherwise to
983 .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB}
984 Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn.
985 Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to
987 Usually used in \fBchoose.html\fR.
989 .B @ne{\fIA\fB}{\fIB\fB}
990 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
992 .B @new{\fITEMPLATE\fB}
993 Expands \fITEMPLATE\fR for each track in the newly added tracks list, starting
994 with the most recent. Used in \fBnew.html\fR.
997 Expands to the number of files from \fB@files\fR (above).
1000 Expands to a string including the time and process ID, intended to be
1001 unique across invocations.
1003 .B @not{\fIBOOL\fB}@
1004 Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to
1007 .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
1008 If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise
1012 Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at
1013 an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR.
1015 .B @part{\fICONTEXT\fB}{\fIPART\fB}@
1016 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the
1017 current track. The context may be omitted and defaults
1020 The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to
1021 the \fBshort_display\fR limit.
1023 .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@
1024 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for
1025 \fITRACK\fR. In this usage the context may not be omitted.
1027 The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to
1028 the \fBshort_display\fR limit.
1031 Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.
1033 .B @playing{\fITEMPLATE\fB}@
1034 Expands \fITEMPLATE\fR using the playing track as the current track.
1036 .B @pref{\fITRACK\fB}{\fIKEY\fB}@
1037 Expand to the track preference, or the empty string if it is not set.
1040 Expands to the name of the current preference, in the template
1041 argument of \fB@prefs@\fR.
1043 .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@
1044 Expands \fITEMPLATE\fR repeatedly, for each preference of track
1046 Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value.
1049 Expands to the value of the current preference, in the template
1050 argument of \fB@prefs@\fR.
1052 .B @queue{\fITEMPLATE\fB}@
1053 Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as
1054 the current track. The track at the head of the queue comes first.
1057 Expands to \fBtrue\fR if random play is currently enabled, otherwise to
1060 .B @recent{\fITEMPLATE\fB}@
1061 Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn
1062 as the current track. The most recently played track comes first.
1065 Expands to \fBtrue\fR if the current track is removable, otherwise to
1068 .B @resolve{\fITRACK\fB}@
1069 Resolve aliases for \fITRACK\fR and expands to the result.
1071 .B @right{\fIRIGHT\fB}@
1072 Exapnds to \fBtrue\fR if the user has right \fIRIGHT\fR, otherwise to
1075 .B @right{\fIRIGHT\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
1076 Expands to \fITRUEPART\fR if the user right \fIRIGHT\fR, otherwise to
1077 \fIFALSEPART\fR (which may be omitted).
1080 Expands to \fBtrue\fR if the currently playing track is scratchable, otherwise
1083 .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@
1084 Expands \fITEMPLATE\fR once for each group of search results that have
1085 a common value of track part \fIPART\fR.
1086 The groups are sorted by the value of the part.
1091 within the template will apply to one of the tracks in the group.
1093 If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR,
1094 and determines the context for \fIPART\fR. The default is \fBsort\fR. Usually
1095 you want \fBdisplay\fR for everything except the title and \fBsort\fR for the
1096 title. If you use \fBsort\fR for artist and album then you are likely to get
1100 Expands to the server's version string.
1102 .B @shell{\fICOMMAND\fB}@
1103 Expands to the output of \fICOMMAND\fR executed via the shell. \fBsh\fR is
1104 searched for using \fBPATH\fR. If the command fails then this is logged but
1108 In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current
1109 track. Otherwise the empty string. Known states are:
1113 The player terminated with nonzero status, but not because the track was
1117 A scratch, in the queue.
1120 No player could be found.
1123 Played successfully.
1126 A randomly chosen track, in the queue.
1129 This track was scratched.
1132 An explicitly queued track, in the queue.
1135 Some additional states only apply to playing tracks, so will never be seen in
1136 the queue or recently-played list:
1140 The track has been paused.
1143 Interrupted because the server is shutting down.
1146 This track is currently playing.
1150 Expands to the server statistics.
1153 Expands to the URL of the current page. Typically used in
1155 arguments. If there is a
1157 argument then it is changed to a fresh value.
1162 .B @trackstate{\fIPATH\fB}@
1163 Expands to the current track state: \fBplaying\fR if the track is actually
1164 playing now, \fBqueued\fR if it is queued or the empty string otherwise.
1166 .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@
1167 Transform a path according to \fBtransform\fR (see above).
1168 \fIPATH\fR should be a raw filename (of a track or directory).
1169 \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR).
1170 \fICONTEXT\fR should be the context, and can be omitted (the default
1174 Expands to the canonical URL as defined in \fIpkgconfdir/config\fR.
1176 .B @urlquote{\fISTRING\fB}@
1177 URL-quote \fISTRING\fR.
1180 The current username. This will be "guest" if nobody is logged in.
1182 .B @userinfo{\fIPROPERTY\fB}@
1183 Look up a property of the logged-in user.
1186 Expands to \fBdisorder.cgi\fR's version string.
1188 .B @volume:\fISPEAKER\fB@
1189 The volume on the left or right speaker. \fISPEAKER\fR must be \fBleft\fR or
1193 When the current track was played (or when it is expected to be played, if it
1194 has not been played yet)
1197 Who submitted the current track.
1199 This is a file called \fIoptions\fR, searched for in the same manner
1200 as templates. It includes numerous options for the control of the web
1201 interface. The general syntax is the same as the main configuration
1202 file, except that it should be encoded using UTF-8 (though this might
1203 change to the current locale's character encoding; stick to ASCII to
1206 The shipped \fIoptions\fR file includes four standard options files.
1210 The default labels file. You wouldn't normally edit this directly - instead
1211 supply your own commands in \fIoptions.user\fR. Have a look at the shipped
1212 version of the file for documentation of labels used by the standard templates.
1215 A user options file. Here you should put any overrides for the default
1216 labels and any extra labels required by your modified templates.
1218 Valid directives are:
1220 .B columns \fINAME\fR \fIHEADING\fR...
1221 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB. \fINAME\fR
1222 must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
1223 \fIHEADING\fR... is a list of
1224 heading names. If a column is defined more than once then the last definitions
1227 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
1230 .B include \fIPATH\fR
1231 Includes another file. If \fIPATH\fR starts with a \fB/\fR then it is
1232 taken as is, otherwise it is searched for in the template path.
1234 .B label \fINAME\fR \fIVALUE\fR
1235 Define a label. If a label is defined more than once then the last definition
1238 Some labels are defined inside \fBdisorder.cgi\fR and others by the
1239 default templates. You can define your own labels and use them inside
1242 When an undefined label is expanded, if it has a dot in its name then
1243 the part after the final dot is used as its value. Otherwise the
1244 whole name is used as the value.
1246 Labels are no longer documented here, see the shipped \fIoptions.labels\fR file
1248 .SH "REGEXP SUBSTITUTION RULES"
1249 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3). The
1250 only option used is \fBPCRE_UTF8\fR. Remember that the configuration
1251 file syntax means you have to escape backslashes and quotes inside
1254 In a \fISUBST\fR string the following sequences are interpreted
1258 These expand to the first to ninth bracketed subexpression.
1261 This expands to the matched part of the subject string.
1264 This expands to a single \fB$\fR symbol.
1266 All other pairs starting with \fB$\fR are undefined (and might be used
1267 for something else in the future, so don't rely on the current
1270 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent. If
1271 \fBg\fR is present then all matches are replaced, otherwise only the first
1274 What the web interface actually does is terminated by the \fBaction\fR CGI
1275 argument. The values listed below are supported.
1277 Except as specified, all actions redirect back to the \fBplaying.html\fR
1278 template unless the \fBback\fR argument is present, in which case the URL it
1279 gives is used instead.
1281 Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present.
1284 Move track \fBid\fR by offset \fBdelta\fR.
1287 Play track \fBfile\fR, or if that is missing then play all the tracks in
1291 Don't change any state, but instead compute a suitable refresh time and include
1292 that in an HTTP header. Expands the \fBplaying.html\fR template rather than
1295 This is the default if \fBaction\fR is missing.
1298 Disables random play.
1301 Enables random play.
1304 Disables play completely.
1310 Pauses the current track.
1313 Remove track \fBid\fR.
1316 Resumes play after a pause.
1319 Scratch the playing track. If \fBid\fR is present it must match the playing
1323 Change the volume by \fBdelta\fR, or if that is missing then set it to the
1324 values of \fBleft\fR and \fBright\fR. Expands to the \fBvolume.html\fR template
1325 rather than redirecting.
1328 Adjust preferences from the \fBprefs.html\fR template (which it then expands
1329 rather than redirecting).
1333 is set then the cooked interface is assumed. The value of
1335 is used to determine which trackname preferences are set. By default the
1337 context is adjusted but this can be overridden with the
1341 argument is checked; if it is set then random play is enabled for that track,
1342 otherwise it is disabled.
1348 arguments are set then they are used to set a single preference.
1350 Otherwise if just the
1352 argument is set then that preference is deleted.
1354 It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to
1355 enure that the real track name is always used. Otherwise if the preferences
1356 page is used to adjust a trackname_ preference, the alias may change, leading
1357 to the URL going stale.
1360 This action is generated automatically when an error occurs connecting to the
1361 server. The \fBerror\fR label is set to an indication of what the error is.
1362 .SH "TRACK NAME PARTS"
1363 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1364 with the obvious intended meaning. These are controlled by configuration and
1365 by \fBtrackname_\fR preferences.
1367 In addition there are two built-in parts, \fBpath\fR which is the whole path
1368 name and \fBext\fR which is the filename extension, including the initial dot
1369 (or the empty string if there is not extension).
1371 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
1372 \fBpcrepattern\fR(3)
1373 .\" Local Variables:
~mdw / disorder / blob