chiark / gitweb /
Support arbitrary Core Audio devices.
[disorder] / doc / disorder_config.5.in
1 .\"
2 .\" Copyright (C) 2004-2008 Richard Kettlewell
3 .\"
4 .\" This program is free software: you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation, either version 3 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,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 .\" GNU 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, see <http://www.gnu.org/licenses/>.
16 .\"
17 .TH disorder_config 5
18 .SH NAME
19 pkgconfdir/config - DisOrder jukebox configuration
20 .SH DESCRIPTION
21 The purpose of DisOrder is to organize and play digital audio files, under the
22 control of multiple users.
23 \fIpkgconfdir/config\fR is the primary configuration file; the web interface
24 uses a number of others (see \fBdisorder.cgi\fR(8)).
25 .SS Tracks
26 DisOrder can be configured with multiple collections of tracks, indexing them
27 by their filename, and picking players on the basis of filename patterns (for
28 instance, "*.mp3").
29 .PP
30 Although the model is of filenames, it is not inherent that there are
31 corresponding real files - merely that they can be interpreted by the chosen
32 player.
33 See \fBdisorder\fR(3) for more details about this.
34 .PP
35 Each track can have a set of preferences associated with it.
36 These are simple key-value pairs; they can be used for anything you
37 like, but a number of keys have specific meanings.
38 See \fBdisorder_preferences\fR(5) 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.
43 They can be overridden by setting preferences.
44 .PP
45 Names for display are distinguished from names for sorting, so with the right
46 underlying filenames an album can be displayed in its original order even if
47 the displayed track titles are not lexically sorted.
48 .SS "Server State"
49 A collection of global preferences define various bits of server state: whether
50 random play is enabled, what tags to check for when picking at random, etc.
51 See \fBdisorder_preferences\fR(5) for more information.
52 .SS "Users And Access Control"
53 DisOrder distinguishes between multiple users.
54 This is for access control and reporting, not to provide different
55 views of the world: i.e. preferences and so on are global.
56 .PP
57 Each user has an associated set of rights which contorl which commands they may
58 execute.
59 Normally you would give all users most rights, and expect them to
60 cooperate (they are after all presumed to be in a shared sound environment).
61 .PP
62 The full set of rights are:
63 .TP
64 .B read
65 User can perform read-only operations
66 .TP
67 .B play
68 User can add tracks to the queue
69 .TP
70 .B "move any"
71 User can move any track
72 .TP
73 .B "move mine"
74 User can move their own tracks
75 .TP
76 .B "move random"
77 User can move randomly chosen tracks
78 .TP
79 .B "remove any"
80 User can remove any track
81 .TP
82 .B "remove mine"
83 User can remove their own tracks
84 .TP
85 .B "remove random"
86 User can remove randomly chosen tracks
87 .TP
88 .B "scratch any"
89 User can scratch any track
90 .TP
91 .B "scratch mine"
92 User can scratch their own tracks
93 .TP
94 .B "scratch random"
95 User can scratch randomly chosen tracks
96 .TP
97 .B volume
98 User can change the volume
99 .TP
100 .B admin
101 User can perform admin operations
102 .TP
103 .B rescan
104 User can initiate a rescan
105 .TP
106 .B register
107 User can register new users.
108 Normally only the
109 .B guest
110 user would have this right.
111 .TP
112 .B userinfo
113 User can edit their own userinfo
114 .TP
115 .B prefs
116 User can modify track preferences
117 .TP
118 .B "global prefs"
119 User can modify global preferences
120 .TP
121 .B pause
122 User can pause/resume 
123 .PP
124 Access control is entirely used-based.
125 If you configure DisOrder to listen for TCP/IP connections then it will
126 accept a connection from anywhere provided the right password is
127 available.
128 Passwords are never transmitted over TCP/IP connections in clear,
129 but everything else is.
130 The expected model is that host-based access control is imposed at
131 the network layer.
132 .SS "Web Interface"
133 The web interface is controlled by a collection of template files, one for each
134 kind of page, and a collection of option files.
135 These are split up and separate from the main configuration file to
136 .PP
137 See \fBdisorder.cgi\fR(8) for more information.
138 .SS "Searching And Tags"
139 Search strings contain a list of search terms separated by spaces.
140 A search term can either be a single word or a tag, prefixed with "tag:".
141 .PP
142 Search words are compared without regard to letter case or accents; thus, all
143 of the following will be considered to be equal to one another:
144 .PP
145 .nf
146   LATIN CAPITAL LETTER E
147   LATIN SMALL LETTER E
148   LATIN CAPITAL LETTER E WITH GRAVE
149   LATIN SMALL LETTER E WITH GRAVE
150   LATIN CAPITAL LETTER E plus COMBINING GRAVE ACCENT
151   LATIN SMALL LETTER E plus COMBINING GRAVE ACCENT
152 .fi
153 .PP
154 The same rules apply to tags but in addition leading and trailing whitespace is
155 disregarded and all whitespace sequences are treated as equal when they appear
156 as internal whitespace.
157 .PP
158 Where several tags are listed, for instance the tags preference for a track,
159 the tags are separated by commas.
160 Therefore tags may not contain commas.
161 .SH "CONFIGURATION FILE"
162 .SS "General Syntax"
163 Lines are split into fields separated by whitespace (space, tab, line
164 feed, carriage return, form feed).
165 Comments are started by the number sign ("#").
166 .PP
167 Fields may be unquoted (in which case they may not contain spaces and
168 may not start with a quotation mark or apostrophe) or quoted by either
169 quotation marks or apostrophes.
170 Inside quoted fields every character stands for itself, except that
171 a backslash can only appear as part of one of the following escape sequences:
172 .TP
173 .B \e\e
174 Backslash
175 .TP
176 .B \e"
177 Quotation mark
178 .\" "
179 .TP
180 .B \e'
181 Apostrophe
182 .TP
183 .B \en
184 Line feed
185 .PP
186 No other escape sequences are allowed.
187 .PP
188 Within any line the first field is a configuration command and any
189 further fields are parameters.
190 Lines with no fields are ignored.
191 .PP
192 After editing the config file use \fBdisorder reconfigure\fR to make
193 it re-read it.
194 If there is anything wrong with it the daemon will record a log
195 message and ignore the new config file.
196 (You should fix it before next terminating and restarting the daemon,
197 as it cannot start up without a valid config file.)
198 .SS "Configuration Files"
199 Configuration files are read in the following order:
200 .TP
201 .I pkgconfdir/config
202 .TP
203 .I pkgconfdir/config.private
204 Should be readable only by the jukebox group.
205 Not really useful any more and will be abolished in future.
206 .TP
207 .I ~\fRUSERNAME\fI/.disorder/passwd
208 Per-user client configuration.
209 Optional but if it exists must be readable only by the relevant user.
210 Would normally contain a \fBpassword\fR directive.
211 .TP
212 .I pkgconfdir/config.\fRUSERNAME
213 Per-user system-controlled client configuration.
214 Optional but if it exists must be readable only by the relevant user.
215 Would normally contain a \fBpassword\fR directive.
216 .IP
217 The prefererred location for per-user passwords is \fI~/.disorder/passwd\fR and
218 \fBdisorder authorize\fR writes there now.
219 .SS "Global Configuration"
220 .TP
221 .B home \fIDIRECTORY\fR
222 The home directory for state files.
223 Defaults to
224 .IR pkgstatedir .
225 The server will create this directory on startup if it does not exist.
226 .TP
227 .B plugins \fIPATH\fR
228 Adds a directory to the plugin path.
229 (This is also used by the web interface.)
230 .IP
231 Plugins are opened the first time they are required and never after,
232 so after changing a plugin you must restart the server before it is
233 guaranteed to take effect.
234 .IP
235 If
236 .B plugins
237 is used without arguments the plugin path is cleared.
238 .SS "Server Configuration"
239 .TP
240 .B alias \fIPATTERN\fR
241 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
242 preferences.
243 .IP
244 Most characters stand for themselves, the exception being \fB{\fR which is used
245 to insert a track name part in the form \fB{\fIname\fB}\fR or
246 \fB{/\fIname\fB}\fR.
247 .IP
248 The difference is that the first form just inserts the name part while the
249 second prefixes it with a \fB/\fR if it is nonempty.
250 .IP
251 The pattern should not attempt to include the collection root, which is
252 automatically included, but should include the proper extension.
253 .IP
254 The default is \fB{/artist}{/album}{/title}{ext}\fR.
255 .TP
256 .B api \fINAME\fR
257 Selects the backend used to play sound and to set the volume.
258 The following options are available:
259 .RS
260 .TP
261 .B alsa
262 Use the ALSA API.
263 This is only available on Linux systems, on which it is the default.
264 .TP
265 .B coreaudio
266 Use Apple Core Audio.
267 This only available on OS X systems, on which it is the default.
268 .TP
269 .B oss
270 Use the OSS (/dev/dsp) API.
271 Not available on all platforms.
272 .TP
273 .B command
274 Execute a command.
275 This is the default if
276 .B speaker_command
277 is specified, or if no native is available.
278 .TP
279 .B network
280 Transmit audio over the network.
281 This is the default if \fBbroadcast\fR is specified.
282 You can use
283 .BR disorder-playrtp (1)
284 to receive and play the resulting stream on Linux and OS X.
285 .RE
286 .TP
287 .B authorization_algorithm \fIALGORITHM\fR
288 Defines the algorithm used to authenticate clients.
289 The valid options are sha1 (the default), sha256, sha384 and sha512.
290 See
291 .BR disorder_protocol (5)
292 for more details.
293 .TP
294 .B broadcast \fIADDRESS\fR \fIPORT\fR
295 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.
296 This implies \fBapi network\fR.
297 .IP
298 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
299 .TP
300 .B broadcast_from \fIADDRESS\fR \fIPORT\fR
301 Sets the (local) source address used by \fBbroadcast\fR.
302 .TP
303 .B channel \fICHANNEL\fR
304 The mixer channel that the volume control should use.
305 .IP
306 For \fBapi oss\fR the possible values are:
307 .RS
308 .TP 8
309 .B pcm
310 Output level for the audio device.
311 This is probably what you want and is the default.
312 .TP
313 .B speaker
314 Output level for the PC speaker, if that is connected to the sound card.
315 .TP
316 .B pcm2
317 Output level for alternative codec device.
318 .TP
319 .B vol
320 Master output level.
321 The OSS documentation recommends against using this, as it affects all
322 output devices.
323 .RE
324 .IP
325 You can also specify channels by number, if you know the right value.
326 .IP
327 For \fBapi alsa\fR, this is the name of the mixer control to use.
328 The default is \fBPCM\fR.
329 Use \fBamixer scontrols\fR or similar to get a full list.
330 .IP
331 For \fBapi coreaudio\fR, volume setting is not currently supported.
332 .TP
333 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
334 .TP
335 .B collection \fIMODULE\fR \fIROOT\fR
336 .TP
337 .B collection \fIROOT\fR
338 Define a collection of tracks.
339 .IP
340 \fIMODULE\fR defines which plugin module should be used for this
341 collection.
342 Use the supplied \fBfs\fR module for tracks that exist as ordinary
343 files in the filesystem.
344 If no \fIMODULE\fR is specified then \fBfs\fR is assumed.
345 .IP
346 \fIENCODING\fR defines the encoding of filenames in this collection.
347 For \fBfs\fR this would be the encoding you use for filenames.
348 Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR.
349 If no encoding is specified then the current locale's character encoding
350 is used.
351 .IP
352 NB that this default depends on the locale the server runs in, which is not
353 necessarily the same as that of ordinary users, depending how the system is
354 configured.
355 It's best to explicitly specify it to be certain.
356 .IP
357 \fIROOT\fR is the root in the filesystem of the filenames and is
358 passed to the plugin module.
359 It must be an absolute path and should not end with a "/".
360 .TP
361 .B cookie_key_lifetime \fISECONDS\fR
362 Lifetime of the signing key used in constructing cookies.  The default is one
363 week.
364 .TP
365 .B cookie_login_lifetime \fISECONDS\fR
366 Lifetime of a cookie enforced by the server.  When the cookie expires the user
367 will have to log in again even if their browser has remembered the cookie that
368 long.  The default is one day.
369 .TP
370 .B default_rights \fIRIGHTS\fR
371 Defines the set of rights given to new users.
372 The argument is a comma-separated list of rights.
373 For the possible values see
374 .B "Users And Access Control"
375 above.
376 .IP
377 The default is to allow everything except \fBadmin\fR and \fBregister\fR
378 (modified in legacy configurations by the obsolete \fBrestrict\fR directive).
379 .TP
380 .B device \fINAME\fR
381 Sound output device.
382 .IP
383 For \fBapi oss\fR this is the path to the device to use.
384 If it is set to \fBdefault\fR then \fI/dev/dsp\fR and \fI/dev/audio\fR
385 will be tried.
386 .IP
387 For \fBapi alsa\fR this is the device name to use.
388 .IP
389 For \fBapi coreaudio\fR this can be either the UID or the human-readable
390 name of the desired device.
391 For a list of names, visit System Preferences -> Sound and look at the Type column.
392 For example, you might use "Built-in Output" for the built-in speaker
393 or "Built-in Line Output" if you have connected external speakers.
394 Remember to quote the name.
395 .IP
396 The default is \fBdefault\fR, which is intended to map to whatever the system's
397 default is.
398 .TP
399 .B gap \fISECONDS\fR
400 Specifies the number of seconds to leave between tracks.
401 The default is 0.
402 .IP
403 NB this option currently DOES NOT WORK.  If there is genuine demand it might be
404 reinstated.
405 .TP
406 .B history \fIINTEGER\fR
407 Specifies the number of recently played tracks to remember (including
408 failed tracks and scratches).
409 .TP
410 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
411 Listen for connections on the address specified by \fIHOST\fR and port
412 specified by \fISERVICE\fR.
413 If \fIHOST\fR is omitted then listens on all local addresses.
414 .IP
415 Normally the server only listens on a UNIX domain socket.
416 .TP
417 .B lock yes\fR|\fBno
418 Determines whether the server locks against concurrent operation.
419 Default is \fByes\fR.
420 There is no good reason to set this to \fBno\fR and the option will
421 probably be removed in a future version.
422 .TP
423 .B mixer \fIDEVICE\fR
424 The mixer device name, if it needs to be specified separately from
425 \fBdevice\fR.
426 .IP
427 For \fBapi oss\fR this should be the path to the mixer device and the default
428 is \fI/dev/mixer\fR.
429 .IP
430 For \fBapi alsa\fR, this is the index of the mixer control to use.
431 The default is 0.
432 .IP
433 For \fBapi coreaudio\fR, volume setting is not currently supported.
434 .TP
435 .B multicast_loop yes\fR|\fBno
436 Determines whether multicast packets are loop backed to the sending host.
437 The default is \fByes\fR.
438 This only applies if \fBapi\fR is set to \fBnetwork\fR and \fBbroadcast\fR
439 is actually a multicast address.
440 .TP
441 .B multicast_ttl \fIHOPS\fR
442 Set the maximum number of hops to send multicast packets.
443 This only applies if \fBapi\fR is set to \fBnetwork\fR and
444 \fBbroadcast\fR is actually a multicast address.
445 The default is 1.
446 .TP
447 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
448 Determines how to extract trackname part \fIPART\fR from a 
449 track name (with the collection root part removed).
450 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
451 .IP
452 Track names can be different in different contexts.
453 For instance the sort string might include an initial track number,
454 but this would be stripped for the display string.
455 \fICONTEXT\fR should be a glob pattern matching the
456 contexts in which this directive will be used.
457 .IP
458 Valid contexts are \fBsort\fR and \fBdisplay\fR.
459 .IP
460 All the \fBnamepart\fR directives are considered in order.
461 The first directive for the right part, that matches the desired context,
462 and with a \fIREGEXP\fR that
463 matches the track is used, and the value chosen is constructed from
464 \fISUBST\fR according to the substitution rules below.
465 .IP
466 Note that searches use the raw track name and \fBtrackname_\fR preferences but
467 not (currently) the results of \fBnamepart\fR, so generating words via this option
468 that aren't in the original track name will lead to confusing results.
469 .IP
470 If you supply no \fBnamepart\fR directives at all then a default set will be
471 supplied automatically.
472 But if you supply even one then you must supply all of them.
473 The defaults are equivalent to:
474 .PP
475 .nf
476 namepart title  "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
477 namepart title  "/([^/]+)\\.[a-zA-Z0-9]+$"                  $1 sort
478 namepart album  "/([^/]+)/[^/]+$"                          $1 *
479 namepart artist "/([^/]+)/[^/]+/[^/]+$"                    $1 *
480 namepart ext    "(\\.[a-zA-Z0-9]+)$"                        $1 *
481 .fi
482 .TP
483 .B new_bias \fIWEIGHT\fR
484 The weight for new tracks.
485 The default is 450000, i.e. recently added tracks are a fifty times as likely
486 to be picked as normal.
487 .TP
488 .B new_bias_age \fISECONDS\fR
489 The maximum age of tracks that \fBnew_bias\fR applies to, in seconds.
490 The default is one week.
491 .TP
492 .B new_max \fIMAX\fR
493 The maximum number of tracks to list when reporting newly noticed tracks.
494 The default is 100.
495 .TP
496 .B nice_rescan \fIPRIORITY\fR
497 Set the recan subprocess priority.
498 The default is 10.
499 .IP
500 (Note that higher values mean the process gets less CPU time; UNIX priority
501 values are backwards.)
502 .TP
503 .B nice_server \fIPRIORITY\fR
504 Set the server priority.
505 This is applied to the server at startup time (and not when you reload
506 configuration).
507 The server does not use much CPU itself but this value is inherited
508 by programs it executes.
509 If you have limited CPU then it might help to set this to a small
510 negative value.
511 The default is 0.
512 .TP
513 .B nice_speaker \fIPRIORITY\fR
514 Set the speaker process priority.
515 This is applied to the speaker process at startup time (and not when
516 you reload the configuration).
517 The speaker process is not massively CPU intensive by today's
518 standards but depends on reasonably timely scheduling.
519 If you have limited CPU then it might help to set this to a small
520 negative value.
521 The default is 0.
522 .TP
523 .B noticed_history
524 The maximum days that a track can survive in the database of newly added
525 tracks.
526 The default is 31.
527 .TP
528 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR...
529 Specifies the player for files matching the glob \fIPATTERN\fR.
530 \fIMODULE\fR specifies which plugin module to use.
531 .IP
532 The following options are supported:
533 .RS
534 .TP
535 .B \-\-wait\-for\-device\fR[\fB=\fIDEVICE\fR]
536 Waits (for up to a couple of seconds) for the default, or specified, libao
537 device to become openable.
538 .TP
539 .B \-\-
540 Defines the end of the list of options.
541 Needed if the first argument to the plugin starts with a "\-".
542 .RE
543 .IP
544 The following are the standard modules:
545 .RS
546 .TP
547 .B exec \fICOMMAND\fR \fIARGS\fR...
548 The command is executed via \fBexecvp\fR(3), not via the shell.
549 The \fBPATH\fR environment variable is searched for the executable if it is not
550 an absolute path.
551 The command is expected to know how to open its own sound device.
552 .TP
553 .B execraw \fICOMMAND\fR \fIARGS\fR...
554 Identical to the \fBexec\fR except that the player is expected to use the
555 DisOrder raw player protocol.
556 .BR disorder-decode (8)
557 can decode several common audio file formats to this format.
558 If your favourite format is not supported, but you have a player
559 which uses libao, there is also a libao driver which supports this format;
560 see below for more information about this.
561 .TP
562 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
563 The command is executed using the shell.
564 If \fISHELL\fR is specified then that is used, otherwise \fBsh\fR will be used.
565 In either case the \fBPATH\fR environment variable is searched for the shell
566 executable if it is not an absolute path.
567 The track name is stored in the environment variable
568 \fBTRACK\fR.
569 .IP
570 Be careful of the interaction between the configuration file quoting rules and
571 the shell quoting rules.
572 .RE
573 .IP
574 If multiple player commands match a track then the first match is used.
575 .IP
576 For the server to be able to calculate track lengths, there should be a
577 .B tracklength
578 command corresponding to each
579 .B player
580 command.
581 .IP
582 If
583 .B player
584 is used without arguments, the list of players is cleared.
585 .TP
586 .B prefsync \fISECONDS\fR
587 The interval at which the preferences log file will be synchronised.
588 Defaults to 3600, i.e. one hour.
589 .TP
590 .B queue_pad \fICOUNT\fR
591 The target size of the queue.
592 If random play is enabled then randomly picked tracks will be added until
593 the queue is at least this big.
594 The default is 10.
595 .TP
596 .B reminder_interval \fISECONDS\fR
597 The minimum number of seconds that must elapse between password reminders.
598 The default is 600, i.e. 10 minutes.
599 .TP
600 .B remote_userman yes\fR|\fBno
601 User management over TCP connection is only allowed if this is set to
602 \fByes\fR.  By default it is set to \fBno\fR.
603 .TP
604 .B replay_min \fISECONDS\fR
605 The minimum number of seconds that must elapse after a track has been played
606 before it can be picked at random.  The default is 8 hours.  If this is set to
607 0 then there is no limit, though current \fBdisorder-choose\fR will not pick
608 anything currently listed in the recently-played list.
609 .TP
610 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
611 Describes the sample format expected by the \fBspeaker_command\fR (below).
612 The components of the format specification are as follows:
613 .RS
614 .TP 10
615 .I BITS
616 The number of bits per sample.
617 Optionally, may be suffixed by \fBb\fR or \fBl\fR for big-endian and
618 little-endian words.
619 If neither is used the native byte order is assumed.
620 .TP
621 .I RATE
622 The number of samples per second.
623 .TP
624 .I CHANNELS
625 The number of channels.
626 .PP
627 The default is
628 .BR 16/44100/2 .
629 .PP
630 With the
631 .B network
632 backend the sample format is forced to
633 .B 16b/44100/2
634 and with the
635 .B coreaudio
636 backend it is forced to
637 .BR 16/44100/2 ,
638 in both cases regardless of what is specified in the configuration file.
639 .RE
640 .TP
641 .B signal \fINAME\fR
642 Defines the signal to be sent to track player process groups when tracks are
643 scratched.
644 The default is \fBSIGKILL\fR.
645 .IP
646 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
647 or \fBInterrupted\fR or whatever.
648 .TP
649 .B sox_generation \fB0\fR|\fB1
650 Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if
651 the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1).
652 See the documentation for your installed copy of \fBsox\fR to determine
653 which you need.
654 The default is set according to the version of sox found when DisOrder was
655 built.
656 If you run on a system with a different version of sox, you will need to
657 set this option.
658 .TP
659 .B speaker_backend \fINAME
660 This is an alias for \fBapi\fR; see above.
661 .TP
662 .B speaker_command \fICOMMAND
663 Causes the speaker subprocess to pipe audio data into shell command
664 \fICOMMAND\fR, rather than writing to a local sound card.
665 The sample format is determine by
666 .B sample_format
667 above.
668 .IP
669 Note that if the sample format is wrong then
670 .BR sox (1)
671 is invoked to translate it.
672 If
673 .B sox
674 is not installed then this will not work.
675 .TP
676 .B scratch \fIPATH\fR
677 Specifies a scratch.
678 When a track is scratched, a scratch track is played at random.
679 Scratches are played using the same logic as other tracks.
680 .IP
681 At least for the time being, path names of scratches must be encoded using
682 UTF-8 (which means that ASCII will do).
683 .IP
684 If \fBscratch\fR is used without arguments then the list of scratches is
685 cleared.
686 .TP
687 .B stopword \fIWORD\fR ...
688 Specifies one or more stopwords that should not take part in searches
689 over track names.
690 .IP
691 If \fBstopword\fR is used without arguments then the list of stopwords is
692 cleared.
693 .IP
694 There is a default set of stopwords built in, but this option can be used to
695 augment or replace that list.
696 .TP
697 .B tracklength \fIPATTERN\fR \fIMODULE\fR
698 Specifies the module used to calculate the length of files matching
699 \fIPATTERN\fR.
700 \fIMODULE\fR specifies which plugin module to use.
701 .IP
702 If \fBtracklength\fR is used without arguments then the list of modules is
703 cleared.
704 .TP
705 .B user \fIUSERNAME\fR
706 Specifies the user to run as.
707 Only makes sense if invoked as root (or the target user).
708 .SS "Client Configuration"
709 These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR
710 or
711 \fIpkgconfdir/config.\fRUSERNAME.
712 .TP
713 .B connect \fIHOST SERVICE\fR
714 Connect to the address specified by \fIHOST\fR and port specified by
715 \fISERVICE\fR.
716 .TP
717 .B password \fIPASSWORD\fR
718 Specify password.
719 .TP
720 .B username \fIUSERNAME\fR
721 Specify username.
722 The default is inferred from the current UID.
723 .SS "Web Interface Configuration"
724 .\" TODO this section is misnamed really...
725 .TP
726 .B mail_sender \fIADDRESS\fR
727 The email address that appears in the From: field of any mail messages sent by
728 the web interface.
729 This must be set if you have online registration enabled.
730 .TP
731 .B refresh \fISECONDS\fR
732 Specifies the maximum refresh period in seconds.
733 Default 15.
734 .TP
735 .B sendmail \fIPATH\fR
736 The path to the Sendmail executable.
737 This must support the \fB-bs\fR option (Postfix, Exim and Sendmail should all
738 work).
739 The default is the sendmail executable found at compile time.
740 .TP
741 .B short_display \fICHARACTERS\fR
742 Defines the maximum number of characters to include in a \fBshort\fR name
743 part.
744 Default 30.
745 .TP
746 .B smtp_server \fIHOSTNAME\fR
747 The hostname (or address) of the SMTP server to use for sending mail.
748 The default is 127.0.0.1.
749 If \fBsendmail\fR is set then that is used instead.
750 .TP
751 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
752 Determines how names are sorted and displayed in track choice displays.
753 .IP
754 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
755 \fBdir\fR but you can define your own.
756 .IP
757 \fICONTEXT\fR is a glob pattern matching the context.
758 Standard contexts are \fBsort\fR (which determines how directory names
759 are sorted) and \fBdisplay\fR (which determines how they are displayed).
760 Again, you can define your own.
761 .IP
762 All the \fBtransform\fR directives are considered in order.
763 If the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
764 then a new track name is constructed from
765 \fISUBST\fR according to the substitution rules below.
766 If several match then each is executed in order.
767 .IP
768 If you supply no \fBtransform\fR directives at all then a default set will be
769 supplied automatically.
770 But if you supply even one then you must supply all of them.
771 The defaults are:
772 .PP
773 .nf
774 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
775 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$"        $1 sort
776 transform dir   "^.*/([^/]+)$"                      $1 *
777 transform dir   "^(the) ([^/]*)"                    "$2 $1" sort i
778 transform dir   "[[:punct:]]"                       "" sort g
779 .fi
780 .TP
781 .B url \fIURL\fR
782 Specifies the URL of the web interface.
783 This URL will be used in generated web pages.
784 The default is inferred at runtime, so this option no
785 longer needs to be specified.
786 .IP
787 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
788 \fB/cgi-bin/jukebox\fR.
789 .SH "GLOBAL PREFERENCES"
790 .SH "LIBAO DRIVER"
791 .SS "Raw Protocol Players"
792 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
793 Programs that use libao generally have command line options to select the
794 driver and pass options to it.
795 .SS "Driver Options"
796 The known driver options are:
797 .TP
798 .B fd
799 The file descriptor to write to.
800 If this is not specified then the driver looks like the environment
801 variable \fBDISORDER_RAW_FD\fR.
802 If that is not set then the default is 1 (i.e. standard output).
803 .TP
804 .B fragile
805 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
806 write to the output file descriptor fails.
807 This is a workaround for buggy players such as \fBogg123\fR that ignore
808 write errors.
809 .SH "REGEXP SUBSTITUTION RULES"
810 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3).
811 The only option used is \fBPCRE_UTF8\fR.
812 Remember that the configuration file syntax means you have to
813 escape backslashes and quotes inside quoted strings.
814 .PP
815 In a \fISUBST\fR string the following sequences are interpreted
816 specially:
817 .TP
818 .B $1 \fR... \fB$9
819 These expand to the first to ninth bracketed subexpression.
820 .TP
821 .B $&
822 This expands to the matched part of the subject string.
823 .TP
824 .B $$
825 This expands to a single \fB$\fR symbol.
826 .PP
827 All other pairs starting with \fB$\fR are undefined (and might be used
828 for something else in the future, so don't rely on the current
829 behaviour.)
830 .PP
831 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent.
832 If \fBg\fR is present then all matches are replaced, otherwise only the first
833 match is replaced.
834 .SH "TRACK NAME PARTS"
835 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
836 with the obvious intended meaning.
837 These are controlled by configuration and by \fBtrackname_\fR preferences.
838 .PP
839 In addition there are two built-in parts, \fBpath\fR which is the whole path
840 name and \fBext\fR which is the filename extension, including the initial dot
841 (or the empty string if there is not extension).
842 .SH "SEE ALSO"
843 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8),
844 \fBpcrepattern\fR(3), \fBdisorder_templates\fR(5), \fBdisorder_actions\fR(5),
845 \fBdisorder.cgi\fR(8), \fBdisorder_preferences\fR(5)
846 .\" Local Variables:
847 .\" mode:nroff
848 .\" fill-column:79
849 .\" End: