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