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