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