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