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.
25 \fIpkgconfdir/config\fR is the primary configuration file but this
26 man page currently documents all of its various configuration files.
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
35 See \fBdisorder\fR(3) for more details about this.
37 Each track can have a set of preferences associated with it.
38 These are simple key-value pairs; they can be used for anything you
39 like, but a number of keys have specific meanings.
40 See \fBdisorder\fR(1) for more details about these.
42 Track names are derived from filenames under the control of regular
43 expressions, rather than attempting to interpret format-specific embedded name
45 They can be overridden by setting preferences.
47 Names for display are distinguished from names for sorting, so with the right
48 underlying filenames an album can be displayed in its original order even if
49 the displayed track titles are not lexically sorted.
51 A collection of global preferences define various bits of server state: whether
52 random play is enabled, what tags to check for when picking at random, etc.
53 .SS "Users And Access Control"
54 DisOrder distinguishes between multiple users.
55 This is for access control and reporting, not to provide different
56 views of the world: i.e. preferences and so on are global.
58 Each user has an associated set of rights which contorl which commands they may
60 Normally you would give all users most rights, and expect them to
61 cooperate (they are after all presumed to be in a shared sound environment).
63 The full set of rights are:
66 User can perform read-only operations
69 User can add tracks to the queue
72 User can move any track
75 User can move their own tracks
78 User can move randomly chosen tracks
81 User can remove any track
84 User can remove their own tracks
87 User can remove randomly chosen tracks
90 User can scratch any track
93 User can scratch their own tracks
96 User can scratch randomly chosen tracks
99 User can change the volume
102 User can perform admin operations
105 User can initiate a rescan
108 User can register new users.
111 user would have this right.
114 User can edit their own userinfo
117 User can modify track preferences
120 User can modify global preferences
123 User can pause/resume
125 Access control is entirely used-based.
126 If you configure DisOrder to listen for TCP/IP connections then it will
127 accept a connection from anywhere provided the right password is
129 Passwords are never transmitted over TCP/IP connections in clear,
130 but everything else is.
131 The expected model is that host-based access control is imposed at
134 The web interface is controlled by a collection of template files, one for each
135 kind of page, and a collection of option files.
136 These are split up and separate from the main configuration file to
137 make it more convenient to override specific bits.
139 The web interface connects to the DisOrder server like any other user, though
140 it is given a special privilege to "become" any other user.
141 (Thus, any process with the same UID as the web interface is very
142 powerful as far as DisOrder goes.
143 This model will be changed in a future version.)
145 Access control to the web interface is (currently) separate from DisOrder's own
146 access control (HTTP authentication is required) but uses the same user
148 .SS "Searching And Tags"
149 Search strings contain a list of search terms separated by spaces.
150 A search term can either be a single word or a tag, prefixed with "tag:".
152 Search words are compared without regard to letter case or accents; thus, all
153 of the following will be considered to be equal to one another:
156 LATIN CAPITAL LETTER E
158 LATIN CAPITAL LETTER E WITH GRAVE
159 LATIN SMALL LETTER E WITH GRAVE
160 LATIN CAPITAL LETTER E plus COMBINING GRAVE ACCENT
161 LATIN SMALL LETTER E plus COMBINING GRAVE ACCENT
164 The same rules apply to tags but in addition leading and trailing whitespace is
165 disregarded and all whitespace sequences are treated as equal when they appear
166 as internal whitespace.
168 Where several tags are listed, for instance the tags preference for a track,
169 the tags are separated by commas.
170 Therefore tags may not contain commas.
171 .SH "CONFIGURATION FILE"
173 Lines are split into fields separated by whitespace (space, tab, line
174 feed, carriage return, form feed).
175 Comments are started by the number sign ("#").
177 Fields may be unquoted (in which case they may not contain spaces and
178 may not start with a quotation mark or apostrophe) or quoted by either
179 quotation marks or apostrophes.
180 Inside quoted fields every character stands for itself, except that
181 a backslash can only appear as part of one of the following escape sequences:
196 No other escape sequences are allowed.
198 Within any line the first field is a configuration command and any
199 further fields are parameters.
200 Lines with no fields are ignored.
202 After editing the config file use \fBdisorder reconfigure\fR to make
204 If there is anything wrong with it the daemon will record a log
205 message and ignore the new config file.
206 (You should fix it before next terminating and restarting the daemon,
207 as it cannot start up without a valid config file.)
208 .SS "Configuration Files"
209 Configuration files are read in the following order:
213 .I pkgconfdir/config.private
214 Should be readable only by the jukebox group.
215 Not really useful any more and will be abolished in future.
217 .I ~\fRUSER\fI/.disorder/passwd
218 Per-user client configuration.
219 Optional but if it exists must be readable only by the relevant user.
220 Would normally contain a \fBpassword\fR directive.
222 .I pkgconfdir/config.\fRUSER
223 Per-user system-controlled client configuration.
224 Optional but if it exists must be readable only by the relevant user.
225 Would normally contain a \fBpassword\fR directive.
227 The prefererred location for per-user passwords is \fI~/.disorder/passwd\fR and
228 \fBdisorder authorize\fR writes there now.
229 .SS "Global Configuration"
231 .B home \fIDIRECTORY\fR
232 The home directory for state files.
235 The server will create this directory on startup if it does not exist.
237 .B plugins \fIPATH\fR
238 Adds a directory to the plugin path.
239 (This is also used by the web interface.)
241 Plugins are opened the first time they are required and never after,
242 so after changing a plugin you must restart the server before it is
243 guaranteed to take effect.
247 is used without arguments the plugin path is cleared.
248 .SS "Server Configuration"
250 .B alias \fIPATTERN\fR
251 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
254 Most characters stand for themselves, the exception being \fB{\fR which is used
255 to insert a track name part in the form \fB{\fIname\fB}\fR or
258 The difference is that the first form just inserts the name part while the
259 second prefixes it with a \fB/\fR if it is nonempty.
261 The pattern should not attempt to include the collection root, which is
262 automatically included, but should include the proper extension.
264 The default is \fB{/artist}{/album}{/title}{ext}\fR.
267 Selects the backend used to play sound and to set the volume.
268 The following options are available:
273 This is only available on Linux systems, on which it is the default.
276 Use Apple Core Audio.
277 This only available on OS X systems, on which it is the default.
280 Use the OSS (/dev/dsp) API.
281 Not available on all platforms.
285 This is the default if
287 is specified, or if no native is available.
290 Transmit audio over the network.
291 This is the default if \fBbroadcast\fR is specified.
293 .BR disorder-playrtp (1)
294 to receive and play the resulting stream on Linux and OS X.
297 .B authorization_algorithm \fIALGORITHM\fR
298 Defines the algorithm used to authenticate clients.
299 The valid options are sha1 (the default), sha256, sha384 and sha512.
301 .BR disorder_protocol (5)
304 .B broadcast \fIADDRESS\fR \fIPORT\fR
305 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.
306 This implies \fBapi network\fR.
308 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
310 .B broadcast_from \fIADDRESS\fR \fIPORT\fR
311 Sets the (local) source address used by \fBbroadcast\fR.
313 .B channel \fICHANNEL\fR
314 The mixer channel that the volume control should use.
316 For \fBapi oss\fR the possible values are:
320 Output level for the audio device.
321 This is probably what you want and is the default.
324 Output level for the PC speaker, if that is connected to the sound card.
327 Output level for alternative codec device.
331 The OSS documentation recommends against using this, as it affects all
335 You can also specify channels by number, if you know the right value.
337 For \fBapi alsa\fR, this is the name of the mixer control to use.
338 The default is \fBPCM\fR.
339 Use \fBamixer scontrols\fR or similar to get a full list.
341 For \fBapi coreaudio\fR, volume setting is not currently supported.
343 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
345 .B collection \fIMODULE\fR \fIROOT\fR
347 .B collection \fIROOT\fR
348 Define a collection of tracks.
350 \fIMODULE\fR defines which plugin module should be used for this
352 Use the supplied \fBfs\fR module for tracks that exist as ordinary
353 files in the filesystem.
354 If no \fIMODULE\fR is specified then \fBfs\fR is assumed.
356 \fIENCODING\fR defines the encoding of filenames in this collection.
357 For \fBfs\fR this would be the encoding you use for filenames.
358 Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR.
359 If no encoding is specified then the current locale's character encoding
362 NB that this default depends on the locale the server runs in, which is not
363 necessarily the same as that of ordinary users, depending how the system is
365 It's best to explicitly specify it to be certain.
367 \fIROOT\fR is the root in the filesystem of the filenames and is
368 passed to the plugin module.
369 It must be an absolute path and should not end with a "/".
371 .B default_rights \fIRIGHTS\fR
372 Defines the set of rights given to new users.
373 The argument is a comma-separated list of rights.
374 For the possible values see
375 .B "Users And Access Control"
378 The default is to allow everything except \fBadmin\fR and \fBregister\fR
379 (modified in legacy configurations by the obsolete \fBrestrict\fR directive).
384 For \fBapi oss\fR this is the path to the device to use.
385 If it is set to \fBdefault\fR then \fI/dev/dsp\fR and \fI/dev/audio\fR
388 For \fBapi alsa\fR this is the device name to use.
390 For \fBapi coreaudio\fR this is currently ignored.
392 The default is \fBdefault\fR, which is intended to map to whatever the system's
396 Specifies the number of seconds to leave between tracks.
399 NB this option currently DOES NOT WORK. If there is genuine demand it might be
402 .B history \fIINTEGER\fR
403 Specifies the number of recently played tracks to remember (including
404 failed tracks and scratches).
406 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
407 Listen for connections on the address specified by \fIHOST\fR and port
408 specified by \fISERVICE\fR.
409 If \fIHOST\fR is omitted then listens on all local addresses.
411 Normally the server only listens on a UNIX domain socket.
414 Determines whether the server locks against concurrent operation.
415 Default is \fByes\fR.
416 There is no good reason to set this to \fBno\fR and the option will
417 probably be removed in a future version.
419 .B mixer \fIDEVICE\fR
420 The mixer device name, if it needs to be specified separately from
423 For \fBapi oss\fR this should be the path to the mixer device and the default
426 For \fBapi alsa\fR, this is the index of the mixer control to use.
429 For \fBapi coreaudio\fR, volume setting is not currently supported.
431 .B multicast_loop yes\fR|\fBno
432 Determines whether multicast packets are loop backed to the sending host.
433 The default is \fByes\fR.
434 This only applies if \fBapi\fR is set to \fBnetwork\fR and \fBbroadcast\fR
435 is actually a multicast address.
437 .B multicast_ttl \fIHOPS\fR
438 Set the maximum number of hops to send multicast packets.
439 This only applies if \fBapi\fR is set to \fBnetwork\fR and
440 \fBbroadcast\fR is actually a multicast address.
443 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
444 Determines how to extract trackname part \fIPART\fR from a
445 track name (with the collection root part removed).
446 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
448 Track names can be different in different contexts.
449 For instance the sort string might include an initial track number,
450 but this would be stripped for the display string.
451 \fICONTEXT\fR should be a glob pattern matching the
452 contexts in which this directive will be used.
454 Valid contexts are \fBsort\fR and \fBdisplay\fR.
456 All the \fBnamepart\fR directives are considered in order.
457 The first directive for the right part, that matches the desired context,
458 and with a \fIREGEXP\fR that
459 matches the track is used, and the value chosen is constructed from
460 \fISUBST\fR according to the substitution rules below.
462 Note that searches use the raw track name and \fBtrackname_\fR preferences but
463 not (currently) the results of \fBnamepart\fR, so generating words via this option
464 that aren't in the original track name will lead to confusing results.
466 If you supply no \fBnamepart\fR directives at all then a default set will be
467 supplied automatically.
468 But if you supply even one then you must supply all of them.
469 The defaults are equivalent to:
472 namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
473 namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
474 namepart album "/([^/]+)/[^/]+$" $1 *
475 namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 *
476 namepart ext "(\\.[a-zA-Z0-9]+)$" $1 *
480 The maximum number of tracks to list when reporting newly noticed tracks.
483 .B nice_rescan \fIPRIORITY\fR
484 Set the recan subprocess priority.
487 (Note that higher values mean the process gets less CPU time; UNIX priority
488 values are backwards.)
490 .B nice_server \fIPRIORITY\fR
491 Set the server priority.
492 This is applied to the server at startup time (and not when you reload
494 The server does not use much CPU itself but this value is inherited
495 by programs it executes.
496 If you have limited CPU then it might help to set this to a small
500 .B nice_speaker \fIPRIORITY\fR
501 Set the speaker process priority.
502 This is applied to the speaker process at startup time (and not when
503 you reload the configuration).
504 The speaker process is not massively CPU intensive by today's
505 standards but depends on reasonably timely scheduling.
506 If you have limited CPU then it might help to set this to a small
511 The maximum days that a track can survive in the database of newly added
515 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR...
516 Specifies the player for files matching the glob \fIPATTERN\fR.
517 \fIMODULE\fR specifies which plugin module to use.
519 The following options are supported:
522 .B \-\-wait\-for\-device\fR[\fB=\fIDEVICE\fR]
523 Waits (for up to a couple of seconds) for the default, or specified, libao
524 device to become openable.
527 Defines the end of the list of options.
528 Needed if the first argument to the plugin starts with a "\-".
531 The following are the standard modules:
534 .B exec \fICOMMAND\fR \fIARGS\fR...
535 The command is executed via \fBexecvp\fR(3), not via the shell.
536 The \fBPATH\fR environment variable is searched for the executable if it is not
538 The command is expected to know how to open its own sound device.
540 .B execraw \fICOMMAND\fR \fIARGS\fR...
541 Identical to the \fBexec\fR except that the player is expected to use the
542 DisOrder raw player protocol.
543 .BR disorder-decode (8)
544 can decode several common audio file formats to this format.
545 If your favourite format is not supported, but you have a player
546 which uses libao, there is also a libao driver which supports this format;
547 see below for more information about this.
549 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
550 The command is executed using the shell.
551 If \fISHELL\fR is specified then that is used, otherwise \fBsh\fR will be used.
552 In either case the \fBPATH\fR environment variable is searched for the shell
553 executable if it is not an absolute path.
554 The track name is stored in the environment variable
557 Be careful of the interaction between the configuration file quoting rules and
558 the shell quoting rules.
561 If multiple player commands match a track then the first match is used.
563 For the server to be able to calculate track lengths, there should be a
565 command corresponding to each
571 is used without arguments, the list of players is cleared.
573 .B prefsync \fISECONDS\fR
574 The interval at which the preferences log file will be synchronised.
575 Defaults to 3600, i.e. one hour.
577 .B queue_pad \fICOUNT\fR
578 The target size of the queue.
579 If random play is enabled then randomly picked tracks will be added until
580 the queue is at least this big.
583 .B reminder_interval \fISECONDS\fR
584 The minimum number of seconds that must elapse between password reminders.
585 The default is 600, i.e. 10 minutes.
587 .B replay_min \fISECONDS\fR
588 The minimum number of seconds that must elapse after a track has been played
589 before it can be picked at random. The default is 8 hours. If this is set to
590 0 then there is no limit, though current \fBdisorder-choose\fR will not pick
591 anything currently listed in the recently-played list.
593 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
594 Describes the sample format expected by the \fBspeaker_command\fR (below).
595 The components of the format specification are as follows:
599 The number of bits per sample.
600 Optionally, may be suffixed by \fBb\fR or \fBl\fR for big-endian and
602 If neither is used the native byte order is assumed.
605 The number of samples per second.
608 The number of channels.
615 backend the sample format is forced to
619 backend it is forced to
621 in both cases regardless of what is specified in the configuration file.
625 Defines the signal to be sent to track player process groups when tracks are
627 The default is \fBSIGKILL\fR.
629 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
630 or \fBInterrupted\fR or whatever.
632 .B sox_generation \fB0\fR|\fB1
633 Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if
634 the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1).
635 See the documentation for your installed copy of \fBsox\fR to determine
639 .B speaker_backend \fINAME
640 This is an alias for \fBapi\fR; see above.
642 .B speaker_command \fICOMMAND
643 Causes the speaker subprocess to pipe audio data into shell command
644 \fICOMMAND\fR, rather than writing to a local sound card.
645 The sample format is determine by
649 Note that if the sample format is wrong then
651 is invoked to translate it.
654 is not installed then this will not work.
656 .B scratch \fIPATH\fR
658 When a track is scratched, a scratch track is played at random.
659 Scratches are played using the same logic as other tracks.
661 At least for the time being, path names of scratches must be encoded using
662 UTF-8 (which means that ASCII will do).
664 If \fBscratch\fR is used without arguments then the list of scratches is
667 .B stopword \fIWORD\fR ...
668 Specifies one or more stopwords that should not take part in searches
671 If \fBstopword\fR is used without arguments then the list of stopwords is
674 There is a default set of stopwords built in, but this option can be used to
675 augment or replace that list.
677 .B tracklength \fIPATTERN\fR \fIMODULE\fR
678 Specifies the module used to calculate the length of files matching
680 \fIMODULE\fR specifies which plugin module to use.
682 If \fBtracklength\fR is used without arguments then the list of modules is
686 Specifies the user to run as.
687 Only makes sense if invoked as root (or the target user).
688 .SS "Client Configuration"
690 .B connect \fIHOST SERVICE\fR
691 Connect to the address specified by \fIHOST\fR and port specified by
693 .SS "Web Interface Configuration"
695 .B mail_sender \fIADDRESS\fR
696 The email address that appears in the From: field of any mail messages sent by
698 This must be set if you have online registration enabled.
700 .B refresh \fISECONDS\fR
701 Specifies the maximum refresh period in seconds.
704 .B short_display \fICHARACTERS\fR
705 Defines the maximum number of characters to include in a \fBshort\fR name
709 .B smtp_server \fIHOSTNAME\fR
710 The hostname (or address) of the SMTP server to use for sending mail.
711 The default is 127.0.0.1.
713 .B templates \fIPATH\fR ...
714 Specifies the directory containing templates used by the web
716 If a template appears in more than one template directory
717 then the one in the earliest directory specified is chosen.
719 See below for further details.
721 If \fBtemplates\fR is used without arguments then the template path is cleared.
723 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
724 Determines how names are sorted and displayed in track choice displays.
726 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
727 \fBdir\fR but you can define your own.
729 \fICONTEXT\fR is a glob pattern matching the context.
730 Standard contexts are \fBsort\fR (which determines how directory names
731 are sorted) and \fBdisplay\fR (which determines how they are displayed).
732 Again, you can define your own.
734 All the \fBtransform\fR directives are considered in order.
735 If the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
736 then a new track name is constructed from
737 \fISUBST\fR according to the substitution rules below.
738 If several match then each is executed in order.
740 If you supply no \fBtransform\fR directives at all then a default set will be
741 supplied automatically.
742 But if you supply even one then you must supply all of them.
746 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
747 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
748 transform dir "^.*/([^/]+)$" $1 *
749 transform dir "^(the) ([^/]*)" "$2 $1" sort i
750 transform dir "[[:punct:]]" "" sort g
754 Specifies the URL of the web interface.
755 This URL will be used in generated web pages.
756 The default is inferred at runtime, so this option no
757 longer needs to be specified.
759 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
760 \fB/cgi-bin/jukebox\fR.
761 .SS "Authentication Configuration"
762 These options would normally be used in \fI~\fRUSER\fI/.disorder/passwd\fR or
763 \fIpkgconfdir/config.\fRUSER.
765 .B password \fIPASSWORD\fR
768 .B username \fIUSERNAME\fR
770 The default is taken from the environment variable \fBLOGNAME\fR.
771 .SH "GLOBAL PREFERENCES"
772 These are the values set with \fBset\-global\fR.
775 If this is set an nonempty then randomly played tracks will always have at
776 least one of the listed tags.
779 If this is set an nonempty then randomly played tracks will never have any of
783 If unset or \fByes\fR then play is enabled.
784 Otherwise it is disabled.
785 Use \fBdisable\fR rather than setting it directly.
788 If unset or \fByes\fR then random play is enabled.
789 Otherwise it is disabled.
790 Use \fBdisable\fR rather than setting it directly.
792 Global preferences starting '_' are read-only (in the sense that you cannot
793 modify them; the server may modify them as part of its normal operation).
797 The database version string.
798 This is used by DisOrder to detect when it must
799 modify the database after an upgrade.
801 .SS "Raw Protocol Players"
802 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
803 Programs that use libao generally have command line options to select the
804 driver and pass options to it.
806 The known driver options are:
809 The file descriptor to write to.
810 If this is not specified then the driver looks like the environment
811 variable \fBDISORDER_RAW_FD\fR.
812 If that is not set then the default is 1 (i.e. standard output).
815 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
816 write to the output file descriptor fails.
817 This is a workaround for buggy players such as \fBogg123\fR that ignore
820 When \fBdisorder.cgi\fR wants to generate a page for an action it searches the
821 directories specified with \fBtemplates\fR for a matching file.
822 It is suggested that you leave the distributed templates unchanged and put
823 any customisations in an earlier entry in the template path.
825 The supplied templates are:
828 Display information about DisOrder.
831 Navigates through the track database to choose a track to play.
832 The \fBdir\fR argument gives the directory to look in; if it is missing
833 then the root directory is used.
836 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
837 directories to be selected by initial letter.
840 Lists newly added tracks.
843 The "front page", which usually shows the currently playing tracks and
845 Gets an HTTP \fBRefresh\fR header.
847 If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra
848 buttons for moving tracks up and down in the queue.
849 There is some logic in \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR
850 is preserved across refreshes and redirects back into itself, but
851 URLs embedded in web pages must include it explicitly.
855 If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are
856 all set then that preference is modified; if \fBfile\fR and \fBname\fR are set
857 but not \fBvalue\fR then the preference is deleted.
860 Lists recently played tracks.
863 Presents search results.
866 Primitive volume control.
868 Additionally, other standard files are included by these:
871 Included at the end of the main content \fB<DIV>\fR element.
874 Included at the start of the \fB<BODY>\fR element.
877 Included at the end of the \fB<BODY>\fR element.
880 Included in the \fB<HEAD>\fR element.
883 Contains the default DisOrder stylesheet.
884 You can override this by editing the CSS or by replacing it all with
885 a \fB<LINK>\fR to an external stylesheet.
887 Templates are ASCII files containing HTML documents, with an expansion
888 syntax to enable data supplied by the implementation to be inserted.
890 If you want to use characters outside the ASCII range, use either the
891 appropriate HTML entity, e.g. \fBé\fR, or an SGML numeric
892 character reference, e.g. \fBý\fR.
893 Use \fB@\fR to insert a literal \fB@\fR without falling foul of
894 the expansion syntax.
895 .SS "Expansion Syntax"
896 Expansions are surrounded by at ("@") symbols take the form of a keyword
897 followed by zero or more arguments.
898 Arguments may either be quoted by curly brackets ("{" and "}") or separated
900 Both kinds may be mixed in a single expansion, though doing so seems
901 likely to cause confusion.
902 The descriptions below contain suggested forms for each expansion.
904 Leading and trailing whitespace in unquoted arguments is ignored, as is
905 whitespace (including newlines) following a close bracket ("}").
907 Arguments are recursively expanded before being interpreted, except for
908 \fITEMPLATE\fR arguments.
909 These are expanded (possibly more than once) to produce the final expansion.
910 (More than once means the same argument being expanded more than once
911 for different tracks or whatever, not the result of the first
912 expansion itself being re-expanded.)
914 Strings constructed by expansions (i.e. not literally copied from the template
915 text) are SGML-quoted: any character which does not stand for itself in #PCDATA
916 or a quoted attribute value is replaced by the appropriate numeric character
919 The exception to this is that such strings are \fInot\fR quoted when they are
920 generated in the expansion of a parameter.
922 In the descriptions below, the current track means the one set by
923 \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing.
924 If none of these expansions are in force then there is no current track.
925 \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR.
927 The following expansion keywords are defined:
929 .B @#{\fICOMMENT\fB}@
936 if the action is really
942 .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
943 If there are no arguments, or all the arguments are \fBtrue\fB, then expands to
944 \fBtrue\fR, otherwise to \fBfalse\fR.
947 Expands to the value of CGI argument \fINAME\fR.
950 The basename of the current directory component, in \fB@navigate@\fR.
952 .B @basename{\fIPATH\fB}@
953 The base name part of \fIPATH\fR.
955 .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@
956 Expands \fITEMPLATE\fR repeatedly for each file or directory under
957 \fB@arg:directory@\fR.
958 \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR.
959 Use \fB@file@\fR to get the display name or filename of the file or
961 Usually used in \fBchoose.html\fR.
964 The directory of the current directory component, in \fB@navigate@\fR.
966 .B @dirname{\fIPATH\fB}@
967 The directory part of \fIPATH\fR.
970 Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR.
972 .B @eq{\fIA\fB}{\fIB\fB}
973 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to
977 Expands to the filename of the current file or directory, inside the template
978 argument to \fBchoose\fR.
980 .B @files{\fITEMPLATE\fB}
981 Expands \fITEMPLATE\fR once for each file indicated by the \fBdirectory\fR CGI
982 arg if it is present, or otherwise for the list of files counted by \fBfiles\fR
983 with names \fB0_file\fR, \fB1_file\fR etc.
986 The full path of the current directory component, in \fB@navigate@\fR.
989 The ID of the current track.
991 .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
992 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
993 to \fIFALSEPART\fR (which may be omitted).
995 .B @image:\fINAME\fB@
996 Expands to the (possibly relative) URL for image \fINAME\fR.
998 If there is a label \fBimages.\fINAME\fR then that will be the image base name.
999 Otherwise the image base name is \fINAME\fB.png\fR or just \fINAME\fR if it
1000 alraedy has an extension.
1001 Thus labels may be defined to give images role names.
1003 If there is a label \fBurl.static\fR then that is the base URL for images.
1004 If it is not defined then \fB/disorder\fR is used as a default.
1006 .B @include:\fIPATH\fB@
1007 Include the named file as if it were a template file.
1008 If \fIPATH\fR starts with a \fB/\fR then it is used as-is;
1009 otherwise, ".html" is appended and the template path is searched.
1012 Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or
1016 Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR,
1017 otherwise to \fBfalse\fR.
1020 Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR,
1021 otherwise to \fBfalse\fR.
1024 Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR
1025 argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
1028 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
1029 loop, otherwise to \fBfalse\fR.
1032 Expands to \fBtrue\fR if the newly added tracks list has any tracks in it,
1033 otherwise to \fBfalse\fR.
1036 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
1039 Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to
1043 Expands to \fBtrue\fR if the recently played list has any tracks in it,
1044 otherwise to \fBfalse\fR.
1046 .B @label:\fINAME\fR\fB@
1047 Expands to the value of label \fINAME\fR.
1048 See the shipped \fIoptions.labels\fR file for full documentation of the
1049 labels used by the standard templates.
1052 Expands to the length of the current track.
1055 Expands to \fBtrue\fR if the current track is movable, otherwise to
1058 .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB}
1059 Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn.
1060 Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to
1062 Usually used in \fBchoose.html\fR.
1064 .B @ne{\fIA\fB}{\fIB\fB}
1065 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
1067 .B @new{\fITEMPLATE\fB}
1068 Expands \fITEMPLATE\fR for each track in the newly added tracks list, starting
1069 with the most recent.
1070 Used in \fBnew.html\fR.
1073 Expands to the number of files from \fB@files\fR (above).
1076 Expands to a string including the time and process ID, intended to be
1077 unique across invocations.
1079 .B @not{\fIBOOL\fB}@
1080 Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to
1083 .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
1084 If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise
1088 Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at
1089 an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR.
1091 .B @part{\fICONTEXT\fB}{\fIPART\fB}@
1092 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the
1094 The context may be omitted and defaults to \fBdisplay\fR.
1096 The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to
1097 the \fBshort_display\fR limit.
1099 .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@
1100 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for
1102 In this usage the context may not be omitted.
1104 The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to
1105 the \fBshort_display\fR limit.
1108 Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.
1110 .B @playing{\fITEMPLATE\fB}@
1111 Expands \fITEMPLATE\fR using the playing track as the current track.
1113 .B @pref{\fITRACK\fB}{\fIKEY\fB}@
1114 Expand to the track preference, or the empty string if it is not set.
1117 Expands to the name of the current preference, in the template
1118 argument of \fB@prefs@\fR.
1120 .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@
1121 Expands \fITEMPLATE\fR repeatedly, for each preference of track
1123 Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value.
1126 Expands to the value of the current preference, in the template
1127 argument of \fB@prefs@\fR.
1129 .B @queue{\fITEMPLATE\fB}@
1130 Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as
1132 The track at the head of the queue comes first.
1134 .B @random\-enabled@
1135 Expands to \fBtrue\fR if random play is currently enabled, otherwise to
1138 .B @recent{\fITEMPLATE\fB}@
1139 Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn
1140 as the current track.
1141 The most recently played track comes first.
1144 Expands to \fBtrue\fR if the current track is removable, otherwise to
1147 .B @resolve{\fITRACK\fB}@
1148 Resolve aliases for \fITRACK\fR and expands to the result.
1150 .B @right{\fIRIGHT\fB}@
1151 Exapnds to \fBtrue\fR if the user has right \fIRIGHT\fR, otherwise to
1154 .B @right{\fIRIGHT\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
1155 Expands to \fITRUEPART\fR if the user right \fIRIGHT\fR, otherwise to
1156 \fIFALSEPART\fR (which may be omitted).
1159 Expands to \fBtrue\fR if the currently playing track is scratchable, otherwise
1162 .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@
1163 Expands \fITEMPLATE\fR once for each group of search results that have
1164 a common value of track part \fIPART\fR.
1165 The groups are sorted by the value of the part.
1170 within the template will apply to one of the tracks in the group.
1172 If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR,
1173 and determines the context for \fIPART\fR.
1174 The default is \fBsort\fR.
1175 Usually you want \fBdisplay\fR for everything except the title and
1176 \fBsort\fR for the title.
1177 If you use \fBsort\fR for artist and album then you are likely to get
1180 .B @server\-version@
1181 Expands to the server's version string.
1183 .B @shell{\fICOMMAND\fB}@
1184 Expands to the output of \fICOMMAND\fR executed via the shell.
1185 \fBsh\fR is searched for using \fBPATH\fR.
1186 If the command fails then this is logged but otherwise ignored.
1189 In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current
1191 Otherwise the empty string.
1196 The player terminated with nonzero status, but not because the track was
1200 A scratch, in the queue.
1203 No player could be found.
1206 Played successfully.
1209 A randomly chosen track, in the queue.
1212 This track was scratched.
1215 An explicitly queued track, in the queue.
1218 Some additional states only apply to playing tracks, so will never be seen in
1219 the queue or recently-played list:
1223 The track has been paused.
1226 Interrupted because the server is shutting down.
1229 This track is currently playing.
1233 Expands to the server statistics.
1236 Expands to the URL of the current page.
1242 argument then it is changed to a fresh value.
1247 .B @trackstate{\fIPATH\fB}@
1248 Expands to the current track state: \fBplaying\fR if the track is actually
1249 playing now, \fBqueued\fR if it is queued or the empty string otherwise.
1251 .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@
1252 Transform a path according to \fBtransform\fR (see above).
1253 \fIPATH\fR should be a raw filename (of a track or directory).
1254 \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR).
1255 \fICONTEXT\fR should be the context, and can be omitted (the default
1259 Expands to the canonical URL as defined in \fIpkgconfdir/config\fR.
1261 .B @urlquote{\fISTRING\fB}@
1262 URL-quote \fISTRING\fR.
1265 The current username.
1266 This will be "guest" if nobody is logged in.
1268 .B @userinfo{\fIPROPERTY\fB}@
1269 Look up a property of the logged-in user.
1272 Expands to \fBdisorder.cgi\fR's version string.
1274 .B @volume:\fISPEAKER\fB@
1275 The volume on the left or right speaker.
1276 \fISPEAKER\fR must be \fBleft\fR or \fBright\fR.
1279 When the current track was played (or when it is expected to be played, if it
1280 has not been played yet)
1283 Who submitted the current track.
1285 This is a file called \fIoptions\fR, searched for in the same manner
1287 It includes numerous options for the control of the web interface.
1288 The general syntax is the same as the main configuration
1289 file, except that it should be encoded using UTF-8 (though this might
1290 change to the current locale's character encoding; stick to ASCII to
1293 The shipped \fIoptions\fR file includes four standard options files.
1297 The default labels file.
1298 You wouldn't normally edit this directly - instead supply your own commands
1299 in \fIoptions.user\fR.
1300 Have a look at the shipped version of the file for documentation of
1301 labels used by the standard templates.
1304 A user options file.
1305 Here you should put any overrides for the default labels and any
1306 extra labels required by your modified templates.
1308 Valid directives are:
1310 .B columns \fINAME\fR \fIHEADING\fR...
1311 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB.
1312 \fINAME\fR must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
1313 \fIHEADING\fR... is a list of heading names.
1314 If a column is defined more than once then the last definitions is used.
1316 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
1319 .B include \fIPATH\fR
1320 Includes another file.
1321 If \fIPATH\fR starts with a \fB/\fR then it is taken as is, otherwise
1322 it is searched for in the template path.
1324 .B label \fINAME\fR \fIVALUE\fR
1326 If a label is defined more than once then the last definition is used.
1328 Some labels are defined inside \fBdisorder.cgi\fR and others by the
1330 You can define your own labels and use them inside a template.
1332 When an undefined label is expanded, if it has a dot in its name then
1333 the part after the final dot is used as its value.
1334 Otherwise the whole name is used as the value.
1336 Labels are no longer documented here, see the shipped \fIoptions.labels\fR file
1338 .SH "REGEXP SUBSTITUTION RULES"
1339 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3).
1340 The only option used is \fBPCRE_UTF8\fR.
1341 Remember that the configuration file syntax means you have to
1342 escape backslashes and quotes inside quoted strings.
1344 In a \fISUBST\fR string the following sequences are interpreted
1348 These expand to the first to ninth bracketed subexpression.
1351 This expands to the matched part of the subject string.
1354 This expands to a single \fB$\fR symbol.
1356 All other pairs starting with \fB$\fR are undefined (and might be used
1357 for something else in the future, so don't rely on the current
1360 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent.
1361 If \fBg\fR is present then all matches are replaced, otherwise only the first
1364 What the web interface actually does is terminated by the \fBaction\fR CGI
1366 The values listed below are supported.
1368 Except as specified, all actions redirect back to the \fBplaying.html\fR
1369 template unless the \fBback\fR argument is present, in which case the URL it
1370 gives is used instead.
1372 Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present.
1375 Move track \fBid\fR by offset \fBdelta\fR.
1378 Play track \fBfile\fR, or if that is missing then play all the tracks in
1382 Don't change any state, but instead compute a suitable refresh time and include
1383 that in an HTTP header.
1384 Expands the \fBplaying.html\fR template rather than redirecting.
1386 This is the default if \fBaction\fR is missing.
1388 .B "random\-disable"
1389 Disables random play.
1392 Enables random play.
1395 Disables play completely.
1401 Pauses the current track.
1404 Remove track \fBid\fR.
1407 Resumes play after a pause.
1410 Scratch the playing track.
1411 If \fBid\fR is present it must match the playing track.
1414 Change the volume by \fBdelta\fR, or if that is missing then set it to the
1415 values of \fBleft\fR and \fBright\fR.
1416 Expands to the \fBvolume.html\fR template rather than redirecting.
1419 Adjust preferences from the \fBprefs.html\fR template (which it then expands
1420 rather than redirecting).
1424 is set then the cooked interface is assumed.
1427 is used to determine which trackname preferences are set.
1430 context is adjusted but this can be overridden with the
1435 argument is checked; if it is set then random play is enabled for that track,
1436 otherwise it is disabled.
1442 arguments are set then they are used to set a single preference.
1444 Otherwise if just the
1446 argument is set then that preference is deleted.
1448 It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to
1449 enure that the real track name is always used.
1450 Otherwise if the preferences page is used to adjust a trackname_ preference,
1451 the alias may change, leading to the URL going stale.
1454 This action is generated automatically when an error occurs connecting to the
1456 The \fBerror\fR label is set to an indication of what the error is.
1457 .SH "TRACK NAME PARTS"
1458 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1459 with the obvious intended meaning.
1460 These are controlled by configuration and by \fBtrackname_\fR preferences.
1462 In addition there are two built-in parts, \fBpath\fR which is the whole path
1463 name and \fBext\fR which is the filename extension, including the initial dot
1464 (or the empty string if there is not extension).
1466 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8),
1467 \fBpcrepattern\fR(3)
1468 .\" Local Variables:
~mdw / disorder / blob