chiark / gitweb /
mention broadcast, broadcast_from in disorder_config(5)
[disorder] / doc /
1 .\"
2 .\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
3 .\"
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.
8 .\"
9 .\" This program is distributed in the hope that it will be useful, but
10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" General Public License for more details.
13 .\"
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
17 .\" USA
18 .\"
19 .TH disorder_config 5
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
26 configuration files.
27 .SS Tracks
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
30 instance, "*.mp3").
31 .PP
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.
35 .PP
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.
39 .SS "Track Names"
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.
43 .PP
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.
47 .SS "Server State"
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
53 on are global.
54 .PP
55 It's possible to restrict a small number of operations to a specific subset of
56 users.  However, it is assumed that every user is supposed to be able to do
57 most operations - since the users are all sharing the same audio environment
58 they are expected to cooperate with each other.
59 .PP
60 Access control is entirely used-based.  If you configure DisOrder to listen for
61 TCP/IP connections then it will accept a connection from anywhere provided the
62 right password is available.  Passwords are never transmitted over TCP/IP
63 connections in clear, but everything else is.  The expected model is that
64 host-based access control is imposed at the network layer.
65 .SS "Web Interface"
66 The web interface is controlled by a collection of template files, one for each
67 kind of page, and a collection of option files.  These are split up and
68 separate from the main configuration file to make it more convenient to
69 override specific bits.
70 .PP
71 The web interface connects to the DisOrder server like any other user, though
72 it is given a special privilege to "become" any other user.  (Thus, any process
73 with the same UID as the web interface is very powerful as far as DisOrder
74 goes.)
75 .PP
76 Access control to the web interface is (currently) separate from DisOrder's own
77 access control (HTTP authentication is required) but uses the same user
78 namespace.
80 .SS "General Syntax"
81 Lines are split into fields separated by whitespace (space, tab, line
82 feed, carriage return, form feed).  Comments are started by the number
83 sign ("#").
84 .PP
85 Fields may be unquoted (in which case they may not contain spaces and
86 may not start with a quotation mark or apostrophe) or quoted by either
87 quotation marks or apostrophes.  Inside quoted fields every character
88 stands for itself, except that a backslash can only appear as part of
89 one of the following escape sequences:
90 .TP
91 .B \e\e
92 Backslash
93 .TP
94 .B \e"
95 Quotation mark
96 .\" "
97 .TP
98 .B \e'
99 Apostrophe
100 .TP
101 .B \en
102 Line feed
103 .PP
104 No other escape sequences are allowed.
105 .PP
106 Within any line the first field is a configuration command and any
107 further fields are parameters.  Lines with no fields are ignored.
108 .PP
109 After editing the config file use \fBdisorder reconfigure\fR to make
110 it re-read it.  If there is anything wrong with it the daemon will
111 record a log message and ignore the new config file.  (You should fix
112 it before next terminating and restarting the daemon, as it cannot
113 start up without a valid config file.)
114 .SS "Global Configuration"
115 .TP
116 .B home \fIDIRECTORY\fR
117 The home directory for state files.  Defaults to
118 .IR pkgstatedir .
119 .TP
120 .B plugin \fIPATH\fR
121 Adds a directory to the plugin path.  (This is also used by the web
122 interface.)
123 .IP
124 Plugins are opened the first time they are required and never after,
125 so after changing a plugin you must restart the server before it is
126 guaranteed to take effect.
127 .SS "Server Configuration"
128 .TP
129 .B alias \fIPATTERN\fR
130 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
131 preferences.
132 .IP
133 Most characters stand for themselves, the exception being \fB{\fR which is used
134 to insert a track name part in the form \fB{\fIname\fB}\fR or
135 \fB{/\fIname\fB}\fR.
136 .IP
137 The difference is that the first form just inserts the name part while the
138 second prefixes it with a \fB/\fR if it is nonempty.
139 .IP
140 The pattern should not attempt to include the collection root, which is
141 automatically included, but should include the proper extension.
142 .IP
143 The default is \fB{/artist}{/album}{/title}{ext}\fR.
144 .TP
145 .B backend \fINAME\fR
146 Selects the backend use by the speaker process.  The following options are
147 available:
148 .RS
149 .TP
150 .B alsa
151 Use the ALSA API.  This is only available on Linux systems, on which it is the
152 default.
153 .TP
154 .B command
155 Execute a command.  This is the default if
156 .B speaker_command
157 is specified, or (currently) on non-Linux systems.
158 .TP
159 .B network
160 Transmit audio over the network.  This is the default if
161 \fBbroadcast\fR is specified.
162 .RE
163 .TP
164 .B broadcast \fIADDRESS\fR \fIPORT\fR
165 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.  This implies
166 \fBbackend network\fR.
167 .TP
168 .B broadcast_from \fIADDRESS\fR \fIPORT\fR
169 Sets the (local) source address used by \fBbroadcast\fR.
170 .TP
171 .B channel \fICHANNEL\fR
172 The mixer channel that the volume control should use.  Valid names depend on
173 your operating system and hardware, but some standard ones that might be useful
174 are:
175 .RS
176 .TP 8
177 .B pcm
178 Output level for the audio device.  This is probably what you want.
179 .TP
180 .B speaker
181 Output level for the PC speaker, if that is connected to the sound card.
182 .TP
183 .B pcm2
184 Output level for alternative codec device.
185 .TP
186 .B vol
187 Master output level.  The OSS documentation recommends against using this, as
188 it affects all output devices.
189 .RE
190 .IP
191 You can also specify channels by number, if you know the right value.
192 .TP
193 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
194 Define a collection of tracks.
195 .IP
196 \fIMODULE\fR defines which plugin module should be used for this
197 collection.  Use the supplied \fBfs\fR module for tracks that exists
198 as ordinary files in the filesystem.
199 .IP
200 \fIENCODING\fR defines the encoding of filenames in this collection.
201 For \fBfs\fR this would be the encoding you use for filenames.
202 Examples might be \fBiso-8859-1\fR or \fButf-8\fR.
203 .IP
204 \fIROOT\fR is the root in the filesystem of the filenames and is
205 passed to the plugin module.
206 .TP
207 .B device \fINAME\fR
208 ALSA device to play raw-format audio.  Default is \fBdefault\fR, i.e. to use
209 the whatever the ALSA configured default is.
210 .TP
211 .B gap \fISECONDS\fR
212 Specifies the number of seconds to leave between tracks.  The default
213 is 2.
214 .TP
215 .B history \fIINTEGER\fR
216 Specifies the number of recently played tracks to remember (including
217 failed tracks and scratches).
218 .TP
219 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
220 Listen for connections on the address specified by \fIHOST\fR and port
221 specified by \fISERVICE\fR.  If \fIHOST\fR is omitted then listens on all
222 local addresses.
223 .IP
224 Normally the server only listens on a UNIX domain socket.
225 .TP
226 .B lock yes\fR|\fBno
227 Determines whether the server locks against concurrent operation.  Default is
228 \fByes\fR.
229 .TP
230 .B mixer \fIPATH\fR
231 The path to the mixer device, if you want access to the volume control,
232 e.g. \fB/dev/mixer\fR.
233 .TP
234 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
235 Determines how to extract trackname part \fIPART\fR from a 
236 track name (with the collection root part removed).
237 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
238 .IP
239 Track names can be different in different contexts.  For instance the sort
240 string might include an initial track number, but this would be stripped for
241 the display string.  \fICONTEXT\fR should be a glob pattern matching the
242 contexts in which this directive will be used.
243 .IP
244 Valid contexts are \fBsort\fR and \fBdisplay\fR.
245 .IP
246 All the \fBnamepart\fR directives are considered in order.  The
247 first directive for the right part, that matches the desired context,
248 and with a \fIREGEXP\fR that
249 matches the track is used, and the value chosen is constructed from
250 \fISUBST\fR according to the substitution rules below.
251 .IP
252 Note that searches use the raw track name and \fBtrackname_\fR preferences but
253 not (currently) the results of \fBnamepart\fR, so generating words via this option
254 that aren't in the original track name will lead to confusing results.
255 .IP
256 If you supply no \fBnamepart\fR directives at all then a default set will be
257 supplied automatically.  But if you supply even one then you must supply all of
258 them.  See the example config file for the defaults.
259 .TP
260 .B nice_rescan \fIPRIORITY\fR
261 Set the recan subprocess priority.  The default is 10.
262 .IP
263 (Note that higher values mean the process gets less CPU time; UNIX priority
264 values are the backwards.)
265 .TP
266 .B nice_server \fIPRIORITY\fR
267 Set the server priority.  This is applied to the server at startup time (and
268 not when you reload configuration).  The server does not use much CPU itself
269 but this value is inherited by programs it executes.  If you have limited CPU
270 then it might help to set this to a small negative value.  The default is 0.
271 .TP
272 .B nice_speaker \fIPRIORITY\fR
273 Set the speaker process priority.  This is applied to the speaker process at
274 startup time (and not when you reload the configuration).  The speaker process
275 is not massively CPU intensive by today's standards but depends on reasonably
276 timely scheduling.  If you have limited CPU then it might help to set this to a
277 small negative value.  The default is 0.
278 .TP
279 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
280 Specifies the player for files matching the glob \fIPATTERN\fR.  \fIMODULE\fR
281 specifies which plugin module to use.
282 .IP
283 The following options are supported:
284 .RS
285 .TP
286 .B --wait-for-device\fR[\fB=\fIDEVICE\fR]
287 Waits (for up to a couple of seconds) for the default, or specified, libao
288 device to become openable.
289 .TP
290 .B --
291 Defines the end of the list of options.  Needed if the first argument to the
292 plugin starts with a "-".
293 .RE
294 .IP
295 The following are the standard modules:
296 .RS
297 .TP
298 .B exec \fICOMMAND\fR \fIARGS\fR...
299 The command is executed via \fBexecvp\fR(3), not via the shell.
300 The \fBPATH\fR environment variable is searched for the executable if it is not
301 an absolute path.
302 The command is expected to know how to open its own sound device.
303 .TP
304 .B execraw \fICOMMAND\fR \fIARGS\fR...
305 Identical to the \fBexec\fR except that the player is expected to use the
306 DisOrder raw player protocol (see notes below).
307 .TP
308 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
309 The command is executed using the shell.  If \fISHELL\fR is specified then that
310 is used, otherwise \fBsh\fR will be used.  In either case the \fBPATH\fR
311 environment variable is searched for the shell executable if it is not an
312 absolute path.  The track name is stored in the environment variable
313 \fBTRACK\fR.
314 .IP
315 Be careful of the interaction between the configuration file quoting rules and
316 the shell quoting rules.
317 .RE
318 .IP
319 If multiple player commands match a track then the first match is used.
320 .TP
321 .B prefsync \fISECONDS\fR
322 The interval at which the preferences log file will be synchronised.  Defaults
323 to 3600, i.e. one hour.
324 .TP
325 .B queue_pad \fICOUNT\fR
326 The target size of the queue.  If random play is enabled then randomly picked
327 tracks will be added until the queue is at least this big.
328 .TP
329 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
330 Describes the sample format expected by the \fBspeaker_command\fR (below).  The
331 components of the format specification are as follows:
332 .RS
333 .TP 10
334 .I BITS
335 The number of bits per sample.  Optionally, may be suffixed by \fBb\fR or
336 \fBl\fR for big-endian and little-endian words.  If neither is used the native
337 byte order is assumed.
338 .TP
339 .I RATE
340 The number of samples per second.
341 .TP
343 The number of channels.
344 .PP
345 The default is
346 .BR 16/44100/2 .
347 .RE
348 .TP
349 .B signal \fINAME\fR
350 Defines the signal to be sent to track player process groups when tracks are
351 scratched.  The default is \fBSIGKILL\fR.
352 .IP
353 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
354 or \fBInterrupted\fR or whatever.
355 .TP
356 .B sox_generation \fB0\fR|\fB1
357 Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
358 the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1).  The default
359 is 0.
360 .TP
361 .B speaker_command \fICOMMAND
362 Causes the speaker subprocess to pipe audio data into shell command
363 \fICOMMAND\fR, rather than writing to a local sound card.  The sample format is
364 determine by
365 .B sample_format
366 above.
367 .IP
368 Note that if the sample format is wrong then
369 .BR sox (1)
370 is invoked to translate it.  If
371 .B sox
372 is not installed then this will not work.
373 .TP
374 .B restrict \fR[\fBscratch\fR] [\fBremove\fR] [\fBmove\fR]
375 Determine which operations are restricted to the submitter of a
376 track.  By default, no operations are restricted, i.e. anyone can
377 scratch or remove anything.
378 .IP
379 If \fBrestrict scratch\fR or \fBrestrict remove\fR are set then only the user
380 that submitted a track can scratch or remove it, respectively.
381 .IP
382 If \fBrestrict move\fR is set then only trusted users can move tracks around in
383 the queue.
384 .IP
385 If \fBrestrict\fR is used more than once then only the final use has any
386 effect.
387 .TP
388 .B scratch \fIPATH\fR
389 Specifies a scratch.  When a track is scratched, a scratch track is
390 played at random.
391 Scratches are played using the same logic as other tracks.
392 .IP
393 At least for the time being, path names of scratches must be encoded using
394 UTF-8 (which means that ASCII will do).
395 .TP
396 .B stopword \fIWORD\fR ...
397 Specifies one or more stopwords that should not take part in searches
398 over track names.
399 .SS "Client Configuration"
400 .TP
401 .B connect \fR[\fIHOST\fR] \fISERVICE\fR
402 Connect to the address specified by \fIHOST\fR and port specified by
403 \fISERVICE\fR.  If \fIHOST\fR is omitted then connects to the local host.
404 Normally the UNIX domain socket is used instead.
405 .SS "Web Interface Configuration"
406 .TP
407 .B refresh \fISECONDS\fR
408 Specifies the maximum refresh period in seconds.  Default 15.
409 .TP
410 .B templates \fIPATH\fR ...
411 Specifies the directory containing templates used by the web
412 interface.  If a template appears in more than one template directory
413 then the one in the earliest directory specified is chosen.
414 .IP
415 See below for further details.
416 .TP
417 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
418 Determines how names are sorted and displayed in track choice displays.
419 .IP
420 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
421 \fBdir\fR but you can define your own.
422 .IP
423 \fICONTEXT\fR is a glob pattern matching the context.  Standard contexts are
424 \fBsort\fR (which determines how directory names are sorted) and \fBdisplay\fR
425 (which determines how they are displayed).  Again, you can define your
426 own.
427 .IP
428 All the \fBtransform\fR directives are considered in order.  If
429 the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
430 then a new track name is constructed from
431 \fISUBST\fR according to the substitution rules below.  If several
432 match then each is executed in order.
433 .IP
434 If you supply no \fBtransform\fR directives at all then a default set will be
435 supplied automatically.  But if you supply even one then you must supply all of
436 them.  See the example config file for the defaults.
437 .TP
438 .B url \fIURL\fR
439 Specifies the URL of the web interface.  This URL will be used in
440 generated web pages.
441 .IP
442 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
443 \fB/cgi-bin/jukebox\fR.
444 .SS "Authentication Configuration"
445 .TP
446 .B allow \fIUSERNAME\fR \fIPASSWORD\fR
447 Specify a username/password pair.
448 .TP
449 .B password \fIPASSWORD\fR
450 Specify password.
451 .TP
452 .B trust \fIUSERNAME\fR
453 Allow \fIUSERNAME\fR to perform privileged operations such as shutting
454 down or reconfiguring the daemon, or becoming another user.
455 .TP
456 .B user \fIUSER\fR
457 Specifies the user to run as.  Only makes sense if invoked as root (or
458 the target user).
459 .TP
460 .B username \fIUSERNAME\fR
461 Specify username.  The default is taken from the environment variable
462 \fBLOGNAME\fR.
463 .PP
464 Configuration files are read in the following order:
465 .TP
466 .I pkgconfdir/config
467 .TP
468 .I pkgconfdir/config.private
469 Should be readable only by the jukebox group, and contain \fBallow\fR
470 commands for authorised users.
471 .TP
472 .I pkgconfdir/config.\fRUSER
473 Per-user system-controlled client configuration.  Optional but if it
474 exists must be readable only by the relevant user.  Would normally
475 contain a \fBpassword\fR directive.
476 .TP
477 .I ~\fRUSER\fI/.disorder/passwd
478 Per-user client configuration.  Optional but if it exists must be
479 readable only by the relevant user.  Would normally contain a
480 \fBpassword\fR directive.
482 These are the values set with \fBset-global\fR.
483 .TP
484 .B required-tags
485 If this is set an nonempty then randomly played tracks will always have at
486 least one of the listed tags.
487 .IP
488 Tags can contain any printing character except comma.  Leading and trailing
489 spaces are not significant but internal spaces are.  Tags in a list are
490 separated by commas.
491 .TP
492 .B prohibited-tags
493 If this is set an nonempty then randomly played tracks will never have any of
494 the listed tags.
495 .TP
496 .B playing
497 If unset or \fByes\fR then play is enabled.  Otherwise it is disabled.  Use
498 \fBdisable\fR rather than setting it directly.
499 .TP
500 .B random-play
501 If unset or \fByes\fR then random play is enabled.  Otherwise it is disabled.
502 Use \fBdisable\fR rather than setting it directly.
504 .SS "Raw Protocol Players"
505 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
506 Programs that use libao generally have command line options to select the
507 driver and pass options to it.
508 .SS "Driver Options"
509 The known driver options are:
510 .TP
511 .B fd
512 The file descriptor to write to.  If this is not specified then the driver
513 looks like the environment variable \fBDISORDER_RAW_FD\fR.  If that is not set
514 then the default is 1 (i.e. standard output).
515 .TP
516 .B fragile
517 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
518 write to the output file descriptor fails.  This is a workaround for buggy
519 players such as \fBogg123\fR that ignore write errors.
521 When \fBdisorder.cgi\fR wants to generate a page for an action it searches the
522 directories specified with \fBtemplates\fR for a matching file.  It is
523 suggested that you leave the distributed templates unchanged and put
524 any customisations in an earlier entry in the template path.
525 .PP
526 The supplied templates are:
527 .TP
528 .B about.html
529 Display information about DisOrder.
530 .TP
531 .B choose.html
532 Navigates through the track database to choose a track to play.  The
533 \fBdir\fR argument gives the directory to look in; if it is missing
534 then the root directory is used.
535 .TP
536 .B choosealpha.html
537 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
538 directories to be selected by initial letter.
539 .TP
540 .B playing.html
541 The "front page", which usually shows the currently playing tracks and
542 the queue.
543 Gets an HTTP \fBRefresh\fR header.
544 .IP
545 If the \fBmgmt\fR CGI argument is set to \fBtrue\fR then we include extra
546 buttons for moving tracks up and down in the queue.  There is some logic in
547 \fBdisorder.cgi\fR to ensure that \fBmgmt=true\fR is preserved across refreshes
548 and redirects back into itself, but URLs embedded in web pages must include it
549 explicitly.
550 .TP
551 .B prefs.html
552 Views preferences.  If the \fBfile\fR, \fBname\fR and \fBvalue\fR arguments are
553 all set then that preference is modified; if \fBfile\fR and \fBname\fR are set
554 but not \fBvalue\fR then the preference is deleted.
555 .TP
556 .B recent.html
557 Lists recently played tracks.
558 .TP
559 .B search.html
560 Presents search results.
561 .TP
562 .B volume.html
563 Primitive volume control.
564 .PP
565 Additionally, other standard files are included by these:
566 .TP
567 .B credits.html
568 Included at the end of the main content \fB<DIV>\fR element.
569 .TP
570 .B sidebar.html
571 Included at the start of the \fB<BODY>\fR element.
572 .TP
573 .B stdhead.html
574 Included in the \fB<HEAD>\fR element.
575 .TP
576 .B stylesheet.html
577 Contains the default DisOrder stylesheet.  You can override this by editing the
578 CSS or by replacing it all with a \fB<LINK>\fR to an external stylesheet.
579 .PP
580 Templates are ASCII files containing HTML documents, with an expansion
581 syntax to enable data supplied by the implementation to be inserted.
582 .PP
583 If you want to use characters outside the ASCII range, use either the
584 appropriate HTML entity, e.g. \fB&eacute;\fR, or an SGML numeric
585 character reference, e.g. \fB&#253;\fR.  Use \fB&#64;\fR to insert a
586 literal \fB@\fR without falling foul of the expansion syntax.
587 .SS "Expansion Syntax"
588 Expansions are surrounded by at ("@") symbols take the form of a keyword
589 followed by zero or more arguments.  Arguments may either be quoted by curly
590 brackets ("{" and "}") or separated by colons (":").  Both kinds may be mixed
591 in a single expansion, though doing so seems likely to cause confusion.
592 The descriptions below contain suggested forms for each
593 expansion.
594 .PP
595 Leading and trailing whitespace in unquoted arguments is ignored, as is
596 whitespace (including newlines) following a close bracket ("}").
597 .PP
598 Arguments are recursively expanded before being interpreted, except for
599 \fITEMPLATE\fR arguments.  These are expanded (possibly more than once) to
600 produce the final expansion.
601 (More than once means the same argument being expanded more than once
602 for different tracks or whatever, not the result of the first
603 expansion itself being re-expanded.)
604 .PP
605 Strings constructed by expansions (i.e. not literally copied from the template
606 text) are SGML-quoted: any character which does not stand for itself in #PCDATA
607 or a quoted attribute value is replaced by the appropriate numeric character
608 reference.
609 .PP
610 The exception to this is that such strings are \fInot\fR quoted when they are
611 generated in the expansion of a parameter.
612 .PP
613 In the descriptions below, the current track means the one set by
614 \fB@playing@\fR, \fB@recent@\fR or \fB@queue@\fR, not the one that is playing.
615 If none of these expansions are in force then there is no current track.
616 \fIBOOL\fR should always be either \fBtrue\fR or \fBfalse\fR.
617 .SS "Expansions"
618 The following expansion keywords are defined:
619 .TP
620 .B @#{\fICOMMENT\fB}@
621 Ignored.
622 .TP
623 .B @action@
624 The current action.  This reports
625 .B manage
626 if the action is really
627 .B playing
628 but
629 .B mgmt=true
630 was set.
631 .TP
632 .B @and{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
633 If there are no arguments, or all the arguments are \fBtrue\fB, then expands to
634 \fBtrue\fR, otherwise to \fBfalse\fR.
635 .TP
636 .B @arg:\fINAME\fB@
637 Expands to the value of CGI script argument \fINAME\fR.
638 .TP
639 .B @basename@
640 The basename of the current directory component, in \fB@navigate@\fR.
641 .TP
642 .B @basename{\fIPATH\fB}@
643 The base name part of \fIPATH\fR.
644 .TP
645 .B @choose{\fIWHAT\fB}{\fITEMPLATE\fB}@
646 Expands \fITEMPLATE\fR repeatedly for each file or directory under
647 \fB@arg:directory@\fR.
648 \fIWHAT\fR should be either \fBfile\fR or \fBdirectory\fR.
649 Use \fB@file@\fR to get the display name or filename of the file or
650 directory.
651 Usually used in \fBchoose.html\fR.
652 .TP
653 .B @dirname@
654 The directory of the current directory component, in \fB@navigate@\fR.
655 .TP
656 .B @dirname{\fIPATH\fB}@
657 The directory part of \fIPATH\fR.
658 .TP
659 .B @enabled@
660 Expands to \fBtrue\fR if play is currently enabled, otherwise to \fBfalse\fR.
661 .TP
662 .B @eq{\fIA\fB}{\fIB\fB}
663 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR are identical, otherwise to
664 \fBfalse\fR.
665 .TP
666 .B @file@
667 Expands to the filename of the current file or directory, inside the template
668 argument to \fBchoose\fR.
669 .TP
670 .B @files{\fITEMPLATE\fB}
671 Expands \fITEMPLATE\fB once for each file indicated by the \fBdirectory\fR CGI
672 arg if it is present, or otherwise for the list of files counted by \fBfiles\fR
673 with names \fB0_file\fR, \fB1_file\fR etc.
674 .TP
675 .B @fullname@
676 The full path of the current directory component, in \fB@navigate@\fR.
677 .TP
678 .B @id@
679 The ID of the current track.
680 .TP
681 .B @if{\fIBOOL\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@
682 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
683 to \fIFALSEPART\fR (which may be omitted).
684 .TP
685 .B @include:\fIPATH\fR@
686 Include the named file as if it were a template file.  If \fIPATH\fR
687 starts with a \fB/\fR then it is used as-is; otherwise, ".html" is
688 appended and the template path is searched.
689 .TP
690 .B @index@
691 Expands to the index of the current file in \fB@queue@\fR, \fB@recent@\fR or
692 \fB@files@\fR.
693 .TP
694 .B @isdirectories@
695 Expands to \fBtrue\fR if there are any directories in \fB@arg:directory@\fR,
696 otherwise to \fBfalse\fR.
697 .TP
698 .B @isfiles@
699 Expands to \fBtrue\fR if there are any files in \fB@arg:directory@\fR,
700 otherwise to \fBfalse\fR.
701 .TP
702 .B @isfirst@
703 Expands to \fBtrue\fR if this is the first repetition of a \fITEMPLATE\fR
704 argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
705 .TP
706 .B @islast@
707 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
708 loop, otherwise to \fBfalse\fR.
709 .TP
710 .B @isplaying@
711 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
712 .TP
713 .B @isqueue@
714 Expands to \fBtrue\fR if there are any tracks in the queue, otherwise to
715 \fBfalse\fR.
716 .TP
717 .B @isrecent@
718 Expands to \fBtrue\fR if the recently played list has any tracks in it,
719 otherwise to \fBfalse\fR.
720 .TP
721 .B @label:\fINAME\fR\fB@
722 Expands to the value of label \fINAME\fR.  See the shipped \fIoptions.labels\fR
723 file for full documentation of the labels used by the standard templates.
724 .TP
725 .B @length@
726 Expands to the length of the current track.
727 .TP
728 .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB}
729 Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn.
730 Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to
731 each component.
732 Usually used in \fBchoose.html\fR.
733 .TP
734 .B @ne{\fIA\fB}{\fIB\fB}
735 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
736 .TP
737 .B @nfiles@
738 Expands to the number of files from \fB@files\fR (above).
739 .TP
740 .B @nonce@
741 Expands to a string including the time and process ID, intended to be
742 unique across invocations.
743 .TP
744 .B @not{\fIBOOL\fB}@
745 Expands to \fBfalse\fR if \fIBOOL\fR is \fBtrue\fR, otherwise to
746 \fBfalse\fR.
747 .TP
748 .B @or{\fIBOOL\fB}{\fIBOOL\fB}\fR...\fB@
749 If at least one argument is \fBtrue\fB, then expands to \fBtrue\fR, otherwise
750 to \fBfalse\fR.
751 .TP
752 .B @parity@
753 Expands to \fBeven\fR or \fBodd\fR depending on whether the current track is at
754 an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR.
755 .TP
756 .B @part{\fICONTEXT\fB}{\fIPART\fB}@
757 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the
758 current track.  The context may be omitted (and normally would be) and defaults
759 to \fBdisplay\fR.
760 .TP
761 .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@
762 Expands to track name part \fIPART\fR using context \fICONTEXT\fR for
763 \fITRACK\fR.  In this usage the context may not be omitted.
764 .TP
765 .B @paused@
766 Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.
767 .TP
768 .B @playing{\fITEMPLATE\fB}@
769 Expands \fITEMPLATE\fR using the playing track as the current track.
770 .TP
771 .B @pref{\fITRACK\fB}{\fIKEY\fB}@
772 Expand to the track preference, or the empty string if it is not set.
773 .TP
774 .B @prefname@
775 Expands to the name of the current preference, in the template
776 argument of \fB@prefs@\fR.
777 .TP
778 .B @prefs{\fIFILE\fB}{\fITEMPLATE\fB}@
779 Expands \fITEMPLATE\fR repeatedly, for each preference of track
780 \fIFILE\fR.
781 Use \fB@prefname@\fR and \fB@prefvalue@\fR to get the name and value.
782 .TP
783 .B @prefvalue@
784 Expands to the value of the current preference, in the template
785 argument of \fB@prefs@\fR.
786 .TP
787 .B @queue{\fITEMPLATE\fB}@
788 Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as
789 the current track.  The track at the head of the queue comes first.
790 .TP
791 .B @random-enabled@
792 Expands to \fBtrue\fR if random play is currently enabled, otherwise to
793 \fBfalse\fR.
794 .TP
795 .B @recent{\fITEMPLATE\fB}@
796 Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn
797 as the current track.  The most recently played track comes first.
798 .TP
799 .B @resolve{\fITRACK\fB}@
800 Resolve aliases for \fITRACK\fR and expands to the result.
801 .TP
802 .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@
803 Expands \fITEMPLATE\fR once for each group of search results that have
804 a common value of track part \fIPART\fR.
805 The groups are sorted by the value of the part.
806 .IP
807 .B @part@
808 and
809 .B @file@
810 within the template will apply to one of the tracks in the group.
811 .IP
812 If \fICONTEXT\fR is specified it should be either \fBsort\fR or \fBdisplay\fR,
813 and determines the context for \fIPART\fR.  The default is \fBsort\fR.  Usually
814 you want \fBdisplay\fR for everything except the title and \fBsort\fR for the
815 title.  If you use \fBsort\fR for artist and album then you are likely to get
816 strange effects.
817 .TP
818 .B @server-version@
819 Expands to the server's version string.
820 .TP
821 .B @shell{\fICOMMAND\fB}@
822 Expands to the output of \fICOMMAND\fR executed via the shell.  \fBsh\fR is
823 searched for using \fBPATH\fR.  If the command fails then this is logged but
824 otherwise ignored.
825 .TP
826 .B @state@
827 In \fB@queue@\fR and \fB@recent@\fR, expands to the state of the current
828 track.  Otherwise the empty string.  Known states are:
829 .RS
830 .TP 12
831 .B failed
832 The player terminated with nonzero status, but not because the track was
833 scratched.
834 .TP
835 .B isscratch
836 A scratch, in the queue.
837 .TP
838 .B no_player
839 No player could be found.
840 .TP
841 .B ok
842 Played successfully.
843 .TP
844 .B random
845 A randomly chosen track, in the queue.
846 .TP
847 .B scratched
848 This track was scratched.
849 .TP
850 .B unplayed
851 An explicitly queued track, in the queue.
852 .RE
853 .IP
854 Some additional states only apply to playing tracks, so will never be seen in
855 the queue or recently-played list:
856 .RS
857 .TP 12
858 .B paused
859 The track has been paused.
860 .TP
861 .B quitting
862 Interrupted because the server is shutting down.
863 .TP
864 .B started
865 This track is currently playing.
866 .RE
867 .TP
868 .B @stats@
869 Expands to the server statistics.
870 .TP
871 .B @thisurl@
872 Expands to the URL of the current page.  Typically used in
873 .B back
874 arguments.  If there is a
875 .B nonce
876 argument then it is changed to a fresh value.
877 .TP
878 .B @track@
879 The current track.
880 .TP
881 .B @trackstate{\fIPATH\fB}@
882 Expands to the current track state: \fBplaying\fR if the track is actually
883 playing now, \fBqueued\fR if it is queued or the empty string otherwise.
884 .TP
885 .B @transform{\fIPATH\fB}{\fITYPE\fB}{\fICONTEXT\fB}@
886 Transform a path according to \fBtransform\fR (see above).
887 \fIPATH\fR should be a raw filename (of a track or directory).
888 \fITYPE\fR should be the transform type (e.g. \fItrack\fR or \fIdir\fR).
889 \fICONTEXT\fR should be the context, and can be omitted (the default
890 is \fBdisplay\fR).
891 .TP
892 .B @url@
893 Expands to the canonical URL as defined in \fIpkgconfdir/config\fR.
894 .TP
895 .B @urlquote{\fISTRING\fB}@
896 URL-quote \fISTRING\fR.
897 .TP
898 .B @version@
899 Expands to \fBdisorder.cgi\fR's version string.
900 .TP
901 .B @volume:\fISPEAKER\fB@
902 The volume on the left or right speaker.  \fISPEAKER\fR must be \fBleft\fB or
903 \fBright\fR.
904 .TP
905 .B @when@
906 When the current track was played (or when it is expected to be played, if it
907 has not been played yet)
908 .TP
909 .B @who@
910 Who submitted the current track.
912 This is a file called \fIoptions\fR, searched for in the same manner
913 as templates.  It includes numerous options for the control of the web
914 interface.  The general syntax is the same as the main configuration
915 file, except that it should be encoded using UTF-8 (though this might
916 change to the current locale's character encoding; stick to ASCII to
917 be safe).
918 .PP
919 The shipped \fIoptions\fR file includes four standard options files.
920 In order, they are:
921 .TP
922 .I options.labels
923 The default labels file.  You wouldn't normally edit this directly - instead
924 supply your own commands in \fIoptions.user\fR.  Have a look at the shipped
925 version of the file for documentation of labels used by the standard templates.
926 .TP
927 .I options.user
928 A user options file.  Here you should put any overrides for the default
929 labels and any extra labels required by your modified templates.
930 .PP
931 Valid directives are:
932 .TP
933 .B columns \fINAME\fR \fIHEADING\fR...
934 Defines the columns used in \fB@playing@\fR and \fB@recent@\fB.  \fINAME\fR
935 must be either \fBplaying\fR, \fBrecent\fR or \fBsearch\fR.
936 \fIHEADING\fR...  is a list of
937 heading names.  If a column is defined more than once then the last definitions
938 is used.
939 .IP
940 The heading names \fBbutton\fR, \fBlength\fR, \fBwhen\fR and \fBwho\fR
941 are built in.
942 .TP
943 .B include \fIPATH\fR
944 Includes another file.  If \fIPATH\fR starts with a \fB/\fR then it is
945 taken as is, otherwise it is searched for in the template path.
946 .TP
947 .B label \fINAME\fR \fIVALUE\fR
948 Define a label.  If a label is defined more than once then the last definition
949 is used.
950 .SS Labels
951 Some labels are defined inside \fBdisorder.cgi\fR and others by the
952 default templates.  You can define your own labels and use them inside
953 a template.
954 .PP
955 When an undefined label is expanded, if it has a dot in its name then
956 the part after the final dot is used as its value.  Otherwise the
957 whole name is used as the value.
958 .PP
959 Labels are no longer documented here, see the shipped \fIoptions.labels\fR file
960 instead.
962 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3).  The
963 only option used is \fBPCRE_UTF8\fR.  Remember that the configuration
964 file syntax means you have to escape backslashes and quotes inside
965 quoted strings.
966 .PP
967 In a \fISUBST\fR string the following sequences are interpreted
968 specially:
969 .TP
970 .B $1 \fR... \fB$9
971 These expand to the first to ninth bracketed subexpression.
972 .TP
973 .B $&
974 This expands to the matched part of the subject string.
975 .TP
976 .B $$
977 This expands to a single \fB$\fR symbol.
978 .PP
979 All other pairs starting with \fB$\fR are undefined (and might be used
980 for something else in the future, so don't rely on the current
981 behaviour.)
982 .PP
983 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent.  If
984 \fBg\fR is present then all matches are replaced, otherwise only the first
985 match is replaced.
987 What the web interface actually does is terminated by the \fBaction\fR CGI
988 argument.  The values listed below are supported.
989 .PP
990 Except as specified, all actions redirect back to the \fBplaying.html\fR
991 template unless the \fBback\fR argument is present, in which case the URL it
992 gives is used instead.
993 .PP
994 Redirection to \fBplaying.html\fR preserves \fBmgmt=true\fR if it is present.
995 .TP 8
996 .B "move"
997 Move track \fBid\fR by offset \fBdelta\fR.
998 .TP
999 .B "play"
1000 Play track \fBfile\fR, or if that is missing then play all the tracks in
1001 \fBdirectory\fR.
1002 .TP
1003 .B "playing"
1004 Don't change any state, but instead compute a suitable refresh time and include
1005 that in an HTTP header.  Expands the \fBplaying.html\fR template rather than
1006 redirecting.
1007 .IP
1008 This is the default if \fBaction\fR is missing.
1009 .TP
1010 .B "random-disable"
1011 Disables random play.
1012 .TP
1013 .B "random-enable"
1014 Enables random play.
1015 .TP
1016 .B "disable"
1017 Disables play completely.
1018 .TP
1019 .B "enable"
1020 Enables play.
1021 .TP
1022 .B "pause"
1023 Pauses the current track.
1024 .TP
1025 .B "remove"
1026 Remove track \fBid\fR.
1027 .TP
1028 .B "resume"
1029 Resumes play after a pause.
1030 .TP
1031 .B "scratch"
1032 Scratch the playing track.  If \fBid\fR is present it must match the playing
1033 track.
1034 .TP
1035 .B "volume"
1036 Change the volume by \fBdelta\fR, or if that is missing then set it to the
1037 values of \fBleft\fR and \fBright\fR.  Expands to the \fBvolume.html\fR template
1038 rather than redirecting.
1039 .TP
1040 .B "prefs"
1041 Adjust preferences from the \fBprefs.html\fR template (which it then expands
1042 rather than redirecting).
1043 .IP
1044 If
1045 .B parts
1046 is set then the cooked interface is assumed.  The value of
1047 .B parts
1048 is used to determine which trackname preferences are set.  By default the
1049 .B display
1050 context is adjusted but this can be overridden with the
1051 .B context
1052 argument.  Also the
1053 .B random
1054 argument is checked; if it is set then random play is enabled for that track,
1055 otherwise it is disabled.
1056 .IP
1057 Otherwise if the
1058 .B name
1059 and
1060 .B value
1061 arguments are set then they are used to set a single preference.
1062 .IP
1063 Otherwise if just the
1064 .B name
1065 argument is set then that preference is deleted.
1066 .IP
1067 It is recommended that links to the \fBprefs\fR action use \fB@resolve@\fR to
1068 enure that the real track name is always used.  Otherwise if the preferences
1069 page is used to adjust a trackname_ preference, the alias may change, leading
1070 to the URL going stale.
1071 .TP
1072 .B "error"
1073 This action is generated automatically when an error occurs connecting to the
1074 server.  The \fBerror\fR label is set to an indication of what the error is.
1076 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1077 with the obvious intended meaning.  These are controlled by configuration and
1078 by \fBtrackname_\fR preferences.
1079 .PP
1080 In addition there are two built-in parts, \fBpath\fR which is the whole path
1081 name and \fBext\fR which is the filename extension, including the initial dot
1082 (or the empty string if there is not extension).
1083 .SH "SEE ALSO"
1084 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
1085 \fBpcrepattern\fR(3)
1086 .\" Local Variables:
1087 .\" mode:nroff
1088 .\" fill-column:79
1089 .\" End: