chiark / gitweb /
Don't keep audio files open except when they are actually being read
[disorder] / doc /
1 .\"
2 .\" Copyright (C) 2004-2009 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
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 <>.
16 .\"
17 .TH disorder_config 5
19 pkgconfdir/config - DisOrder jukebox configuration
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
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.
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\(aq
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 .IP
227 This setting cannot be changed during the lifetime of the server.
228 .TP
229 .B plugins \fIPATH\fR
230 Adds a directory to the plugin path.
231 (This is also used by the web interface.)
232 .IP
233 Plugins are opened the first time they are required and never after,
234 so after changing a plugin you must restart the server before it is
235 guaranteed to take effect.
236 .IP
237 If
238 .B plugins
239 is used without arguments the plugin path is cleared.
240 .SS "Server Configuration"
241 .TP
242 .B alias \fIPATTERN\fR
243 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
244 preferences.
245 .IP
246 Most characters stand for themselves, the exception being \fB{\fR which is used
247 to insert a track name part in the form \fB{\fIname\fB}\fR or
248 \fB{/\fIname\fB}\fR.
249 .IP
250 The difference is that the first form just inserts the name part while the
251 second prefixes it with a \fB/\fR if it is nonempty.
252 .IP
253 The pattern should not attempt to include the collection root, which is
254 automatically included, but should include the proper extension.
255 .IP
256 The default is \fB{/artist}{/album}{/title}{ext}\fR.
257 .IP
258 This setting cannot be changed during the lifetime of the server.
259 .TP
260 .B api \fINAME\fR
261 Selects the backend used to play sound and to set the volume.
262 The following options are available:
263 .RS
264 .TP
265 .B alsa
266 Use the ALSA API.
267 This is only available on Linux systems, on which it is the default.
268 .TP
269 .B coreaudio
270 Use Apple Core Audio.
271 This only available on OS X systems, on which it is the default.
272 .TP
273 .B oss
274 Use the OSS (/dev/dsp) API.
275 Not available on all platforms.
276 .TP
277 .B command
278 Execute a command.
279 This is the default if
280 .B speaker_command
281 is specified, or if no native is available.
282 .IP
283 You might want to set
284 .B pause_mode
285 with this backend.
286 .TP
287 .B rtp
288 Transmit audio over the network.
289 This is the default if \fBbroadcast\fR is specified.
290 You can use
291 .BR disorder-playrtp (1)
292 to receive and play the resulting stream on Linux and OS X.
293 .B network
294 is a deprecated synonym for this API.
295 .RE
296 .TP
297 .B authorization_algorithm \fIALGORITHM\fR
298 Defines the algorithm used to authenticate clients.
299 The valid options are sha1 (the default), sha256, sha384 and sha512.
300 See
301 .BR disorder_protocol (5)
302 for more details.
303 .TP
304 .B broadcast \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR
305 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.
306 This implies \fBapi rtp\fR.
307 .IP
308 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
309 implied by \fIADDRESS\fR.
310 Note that IPv6 is not currently well tested.
311 .IP
312 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
313 .TP
314 .B broadcast_from \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR
315 Sets the (local) source address used by \fBbroadcast\fR.
316 .IP
317 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
318 implied by \fIADDRESS\fR.
319 Note that IPv6 is not currently well tested.
320 .TP
321 .B channel \fICHANNEL\fR
322 The mixer channel that the volume control should use.
323 .IP
324 For \fBapi oss\fR the possible values are:
325 .RS
326 .TP 8
327 .B pcm
328 Output level for the audio device.
329 This is probably what you want and is the default.
330 .TP
331 .B speaker
332 Output level for the PC speaker, if that is connected to the sound card.
333 .TP
334 .B pcm2
335 Output level for alternative codec device.
336 .TP
337 .B vol
338 Master output level.
339 The OSS documentation recommends against using this, as it affects all
340 output devices.
341 .RE
342 .IP
343 You can also specify channels by number, if you know the right value.
344 .IP
345 For \fBapi alsa\fR, this is the name of the mixer control to use.
346 The default is \fBPCM\fR.
347 Use \fBamixer scontrols\fR or similar to get a full list.
348 .IP
349 For \fBapi coreaudio\fR, volume setting is not currently supported.
350 .TP
351 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
352 .TP
353 .B collection \fIMODULE\fR \fIROOT\fR
354 .TP
355 .B collection \fIROOT\fR
356 Define a collection of tracks.
357 .IP
358 \fIMODULE\fR defines which plugin module should be used for this
359 collection.
360 Use the supplied \fBfs\fR module for tracks that exist as ordinary
361 files in the filesystem.
362 If no \fIMODULE\fR is specified then \fBfs\fR is assumed.
363 .IP
364 \fIENCODING\fR defines the encoding of filenames in this collection.
365 For \fBfs\fR this would be the encoding you use for filenames.
366 Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR.
367 If no encoding is specified then the current locale's character encoding
368 is used.
369 .IP
370 NB that this default depends on the locale the server runs in, which is not
371 necessarily the same as that of ordinary users, depending how the system is
372 configured.
373 It's best to explicitly specify it to be certain.
374 .IP
375 \fIROOT\fR is the root in the filesystem of the filenames and is
376 passed to the plugin module.
377 It must be an absolute path and should not end with a "/".
378 .TP
379 .B cookie_key_lifetime \fISECONDS\fR
380 Lifetime of the signing key used in constructing cookies.  The default is one
381 week.
382 .IP
383 If this is changed during the lifetime of the server, the current key doesn't
384 hvave its lifetime retroactively changed.
385 .TP
386 .B cookie_login_lifetime \fISECONDS\fR
387 Lifetime of a cookie enforced by the server.  When the cookie expires the user
388 will have to log in again even if their browser has remembered the cookie that
389 long.  The default is one day.
390 .IP
391 If this is changed during the lifetime of the server, cookies that have already
392 een generated don't hvave their lifetime retroactively changed.
393 .TP
394 .B default_rights \fIRIGHTS\fR
395 Defines the set of rights given to new users.
396 The argument is a comma-separated list of rights.
397 For the possible values see
398 .B "Users And Access Control"
399 above.
400 .IP
401 The default is to allow everything except \fBadmin\fR and \fBregister\fR
402 (modified in legacy configurations by the obsolete \fBrestrict\fR directive).
403 .TP
404 .B device \fINAME\fR
405 Sound output device.
406 .IP
407 For \fBapi oss\fR this is the path to the device to use.
408 If it is set to \fBdefault\fR then \fI/dev/dsp\fR and \fI/dev/audio\fR
409 will be tried.
410 .IP
411 For \fBapi alsa\fR this is the device name to use.
412 .IP
413 For \fBapi coreaudio\fR this can be either the UID or the human-readable
414 name of the desired device.
415 For a list of names, visit System Preferences -> Sound and look at the Type column.
416 For example, you might use "Built-in Output" for the built-in speaker
417 or "Built-in Line Output" if you have connected external speakers.
418 Remember to quote the name.
419 .IP
420 The default is \fBdefault\fR, which is intended to map to whatever the system's
421 default is.
422 .TP
423 .B gap \fISECONDS\fR
424 This option no longer does anything and will be removed in a future version.
425 .TP
426 .B history \fIINTEGER\fR
427 Specifies the number of recently played tracks to remember (including
428 failed tracks and scratches).
429 .IP
430 If this is changed during the lifetime of the server, it won't actually reduce
431 the size of the list until it is next modified.
432 .TP
433 .B listen \fR[\fIFAMILY\fR] \fR[\fIHOST\fR] \fISERVICE\fR
434 Listen for connections on the address specified by \fIHOST\fR and port
435 specified by \fISERVICE\fR.
436 If \fIHOST\fR is omitted, or is \fB*\fR, then listens on all local addresses.
437 .IP
438 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
439 implied by \fIHOST\fR.
440 Note that IPv6 is not currently well tested.
441 .IP
442 Normally the server only listens on a UNIX domain socket.
443 .TP
444 .B lock yes\fR|\fBno
445 This option no longer does anything and will be removed in a future version.
446 .TP
447 .B mixer \fIDEVICE\fR
448 The mixer device name, if it needs to be specified separately from
449 \fBdevice\fR.
450 .IP
451 For \fBapi oss\fR this should be the path to the mixer device and the default
452 is \fI/dev/mixer\fR.
453 .IP
454 For \fBapi alsa\fR, this is the index of the mixer control to use.
455 The default is 0.
456 .IP
457 For \fBapi coreaudio\fR, volume setting is not currently supported.
458 .TP
459 .B mount_rescan yes\fR|\fBno
460 Determines whether mounts and unmounts will cause an automatic rescan.
461 The default is \fByes\fR.
462 .TP
463 .B multicast_loop yes\fR|\fBno
464 Determines whether multicast packets are loop backed to the sending host.
465 The default is \fByes\fR.
466 This only applies if \fBapi\fR is set to \fBrtp\fR and \fBbroadcast\fR
467 is actually a multicast address.
468 .TP
469 .B multicast_ttl \fIHOPS\fR
470 Set the maximum number of hops to send multicast packets.
471 This only applies if \fBapi\fR is set to \fBrtp\fR and
472 \fBbroadcast\fR is actually a multicast address.
473 The default is 1.
474 .TP
475 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
476 Determines how to extract trackname part \fIPART\fR from a 
477 track name (with the collection root part removed).
478 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
479 .IP
480 Track names can be different in different contexts.
481 For instance the sort string might include an initial track number,
482 but this would be stripped for the display string.
483 \fICONTEXT\fR should be a glob pattern matching the
484 contexts in which this directive will be used.
485 .IP
486 Valid contexts are \fBsort\fR and \fBdisplay\fR.
487 .IP
488 All the \fBnamepart\fR directives are considered in order.
489 The first directive for the right part, that matches the desired context,
490 and with a \fIREGEXP\fR that
491 matches the track is used, and the value chosen is constructed from
492 \fISUBST\fR according to the substitution rules below.
493 .IP
494 Note that searches use the raw track name and \fBtrackname_\fR preferences but
495 not (currently) the results of \fBnamepart\fR, so generating words via this option
496 that aren't in the original track name will lead to confusing results.
497 .IP
498 If you supply no \fBnamepart\fR directives at all then a default set will be
499 supplied automatically.
500 But if you supply even one then you must supply all of them.
501 The defaults are equivalent to:
502 .PP
503 .nf
504 namepart title  "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
505 namepart title  "/([^/]+)\\.[a-zA-Z0-9]+$"                  $1 sort
506 namepart album  "/([^/]+)/[^/]+$"                          $1 *
507 namepart artist "/([^/]+)/[^/]+/[^/]+$"                    $1 *
508 namepart ext    "(\\.[a-zA-Z0-9]+)$"                        $1 *
509 .fi
510 .IP
511 This setting cannot be changed during the lifetime of the server.
512 .TP
513 .B new_bias \fIWEIGHT\fR
514 The weight for new tracks.
515 The default is 450000, i.e. recently added tracks are a fifty times as likely
516 to be picked as normal.
517 .IP
518 New values of this option may be picked up from the configuration file even
519 without a reload.
520 .TP
521 .B new_bias_age \fISECONDS\fR
522 The maximum age of tracks that \fBnew_bias\fR applies to, in seconds.
523 The default is one week.
524 .IP
525 New values of this option may be picked up from the configuration file even
526 without a reload.
527 .TP
528 .B new_max \fIMAX\fR
529 The maximum number of tracks to list when reporting newly noticed tracks.
530 The default is 100.
531 .TP
532 .B nice_rescan \fIPRIORITY\fR
533 Set the recan subprocess priority.
534 The default is 10.
535 .IP
536 (Note that higher values mean the process gets less CPU time; UNIX priority
537 values are backwards.)
538 .TP
539 .B nice_server \fIPRIORITY\fR
540 Set the server priority.
541 This is applied to the server at startup time (and not when you reload
542 configuration).
543 The server does not use much CPU itself but this value is inherited
544 by programs it executes.
545 If you have limited CPU then it might help to set this to a small
546 negative value.
547 The default is 0.
548 .IP
549 Changes to this value during the lifetime of the server are ignored.
550 .TP
551 .B nice_speaker \fIPRIORITY\fR
552 Set the speaker process priority.
553 This is applied to the speaker process at startup time (and not when
554 you reload the configuration).
555 The speaker process is not massively CPU intensive by today's
556 standards but depends on reasonably timely scheduling.
557 If you have limited CPU then it might help to set this to a small
558 negative value.
559 The default is 0.
560 .IP
561 Changes to this value during the lifetime of the server are ignored.
562 .TP
563 .B noticed_history
564 The maximum days that a track can survive in the database of newly added
565 tracks.
566 The default is 31.
567 .TP
568 .B pause_mode \fIMODE
569 Sets the pause mode for the \fBcommand\fR backend.
570 The possible values are:
571 .RS
572 .TP
573 .B silence
574 Send silent (0-value) samples when paused.
575 This is the default.
576 .TP
577 .B suspend
578 Stop writing when paused.
579 .RE
580 .TP
581 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR...
582 Specifies the player for files matching the glob \fIPATTERN\fR.
583 \fIMODULE\fR specifies which plugin module to use.
584 .IP
585 The following options are supported:
586 .RS
587 .TP
588 .B \-\-wait\-for\-device\fR[\fB=\fIDEVICE\fR]
589 \fBThis option is deprecated\fR.
590 If you want gapless play use raw-format players and the speaker process instead.
591 (This the default in any case.)
592 .IP
593 Waits (for up to a couple of seconds) for the default, or specified, libao
594 device to become openable.
595 .TP
596 .B \-\-
597 Defines the end of the list of options.
598 Needed if the first argument to the plugin starts with a "\-".
599 .RE
600 .IP
601 The following are the standard modules:
602 .RS
603 .TP
604 .B exec \fICOMMAND\fR \fIARGS\fR...
605 The command is executed via \fBexecvp\fR(3), not via the shell.
606 The \fBPATH\fR environment variable is searched for the executable if it is not
607 an absolute path.
608 The command is expected to know how to open its own sound device.
609 .TP
610 .B execraw \fICOMMAND\fR \fIARGS\fR...
611 Identical to the \fBexec\fR except that the player is expected to use the
612 DisOrder raw player protocol.
613 .BR disorder-decode (8)
614 can decode several common audio file formats to this format.
615 .TP
616 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
617 The command is executed using the shell.
618 If \fISHELL\fR is specified then that is used, otherwise \fBsh\fR will be used.
619 In either case the \fBPATH\fR environment variable is searched for the shell
620 executable if it is not an absolute path.
621 The track name is stored in the environment variable
622 \fBTRACK\fR.
623 .IP
624 Be careful of the interaction between the configuration file quoting rules and
625 the shell quoting rules.
626 .RE
627 .IP
628 If multiple player commands match a track then the first match is used.
629 .IP
630 For the server to be able to calculate track lengths, there should be a
631 .B tracklength
632 command corresponding to each
633 .B player
634 command.
635 .IP
636 If
637 .B player
638 is used without arguments, the list of players is cleared.
639 .IP
640 Although players can be changed during the lifetime of the server, note that
641 background decoders will not be stopped and restarted using changed
642 configuration once they have been started.
643 .TP
644 .B prefsync \fISECONDS\fR
645 This option no longer does anything and will be removed in a future version.
646 .TP
647 .B queue_pad \fICOUNT\fR
648 The target size of the queue.
649 If random play is enabled then randomly picked tracks will be added until
650 the queue is at least this big.
651 The default is 10.
652 .IP
653 If this is reduced during the lifetime of the server, the queue won't be
654 reduced in size to fit; it just won't start growing again until it is under the
655 new value.
656 However, if it is increased, new tracks will start being added immediately.
657 .TP
658 .B reminder_interval \fISECONDS\fR
659 The minimum number of seconds that must elapse between password reminders.
660 The default is 600, i.e. 10 minutes.
661 .TP
662 .B remote_userman yes\fR|\fBno
663 User management over TCP connection is only allowed if this is set to
664 \fByes\fR.  By default it is set to \fBno\fR.
665 .TP
666 .B replay_min \fISECONDS\fR
667 The minimum number of seconds that must elapse after a track has been played
668 before it can be picked at random.  The default is 8 hours.  If this is set to
669 0 then there is no limit, though current \fBdisorder-choose\fR will not pick
670 anything currently listed in the recently-played list.
671 .IP
672 New values of this option may be picked up from the configuration file even
673 without a reload.
674 .TP
675 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
676 Describes the sample format expected by the \fBspeaker_command\fR (below).
677 The components of the format specification are as follows:
678 .RS
679 .TP 10
680 .I BITS
681 The number of bits per sample.
682 Optionally, may be suffixed by \fBb\fR or \fBl\fR for big-endian and
683 little-endian words.
684 If neither is used the native byte order is assumed.
685 .TP
686 .I RATE
687 The number of samples per second.
688 .TP
690 The number of channels.
691 .PP
692 The default is
693 .BR 16/44100/2 .
694 .PP
695 With the
696 .B rtp
697 backend the sample format is forced to
698 .B 16b/44100/2
699 and with the
700 .B coreaudio
701 backend it is forced to
702 .BR 16/44100/2 ,
703 in both cases regardless of what is specified in the configuration file.
704 .RE
705 .TP
706 .B signal \fINAME\fR
707 Defines the signal to be sent to track player process groups when tracks are
708 scratched.
709 The default is \fBSIGKILL\fR.
710 .IP
711 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
712 or \fBInterrupted\fR or whatever.
713 .TP
714 .B sox_generation \fB0\fR|\fB1
715 Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if
716 the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1).
717 See the documentation for your installed copy of \fBsox\fR to determine
718 which you need.
719 The default is set according to the version of sox found when DisOrder was
720 built.
721 If you run on a system with a different version of sox, you will need to
722 set this option.
723 .TP
724 .B speaker_backend \fINAME
725 This is an alias for \fBapi\fR; see above.
726 .TP
727 .B speaker_command \fICOMMAND
728 Causes the speaker subprocess to pipe audio data into shell command
729 \fICOMMAND\fR, rather than writing to a local sound card.
730 The sample format is determine by
731 .B sample_format
732 above.
733 .IP
734 Note that if the sample format is wrong then
735 .BR sox (1)
736 is invoked to translate it.
737 If
738 .B sox
739 is not installed then this will not work.
740 .TP
741 .B scratch \fIPATH\fR
742 Specifies a scratch.
743 When a track is scratched, a scratch track is played at random.
744 Scratches are played using the same logic as other tracks.
745 .IP
746 At least for the time being, path names of scratches must be encoded using
747 UTF-8 (which means that ASCII will do).
748 .IP
749 If \fBscratch\fR is used without arguments then the list of scratches is
750 cleared.
751 .TP
752 .B stopword \fIWORD\fR ...
753 Specifies one or more stopwords that should not take part in searches
754 over track names.
755 .IP
756 If \fBstopword\fR is used without arguments then the list of stopwords is
757 cleared.
758 .IP
759 There is a default set of stopwords built in, but this option can be used to
760 augment or replace that list.
761 .IP
762 This setting cannot be changed during the lifetime of the server.
763 .TP
764 .B tracklength \fIPATTERN\fR \fIMODULE\fR
765 Specifies the module used to calculate the length of files matching
766 \fIPATTERN\fR.
767 \fIMODULE\fR specifies which plugin module to use.
768 .IP
769 If \fBtracklength\fR is used without arguments then the list of modules is
770 cleared.
771 .IP
772 Track lengths are cached in the database, and changing this setting won't cause
773 them to be regenerated.
774 .TP
775 .B user \fIUSERNAME\fR
776 Specifies the user to run as.
777 Only makes sense if invoked as root (or the target user).
778 .IP
779 This setting cannot be changed during the lifetime of the server
780 (and if it is changed with a restart, you will need to adjust file permissions
781 on the server's database).
782 .SS "Client Configuration"
783 These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR
784 or
785 \fIpkgconfdir/config.\fRUSERNAME.
786 .TP
787 .B connect \fR[\fIFAMILY\fR] \fIHOST SERVICE\fR
788 Connect to the address specified by \fIHOST\fR and port specified by
789 \fISERVICE\fR.
790 .IP
791 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
792 implied by \fIHOST\fR.
793 Note that IPv6 is not currently well tested.
794 .TP
795 .B password \fIPASSWORD\fR
796 Specify password.
797 .TP
798 .B username \fIUSERNAME\fR
799 Specify username.
800 The default is inferred from the current UID.
801 .SS "Web Interface Configuration"
802 .\" TODO this section is misnamed really...
803 .TP
804 .B mail_sender \fIADDRESS\fR
805 The email address that appears in the From: field of any mail messages sent by
806 the web interface.
807 This must be set if you have online registration enabled.
808 .TP
809 .B refresh \fISECONDS\fR
810 Specifies the maximum refresh period in seconds.
811 The refresh period is the time after which the web interface's queue and manage
812 pages will automatically reload themselves.
813 Default 15.
814 .TP
815 .B refresh_min \fISECONDS\fR
816 Specifies the minimum refresh period in seconds.
817 Default 1.
818 .TP
819 .B sendmail \fIPATH\fR
820 The path to the Sendmail executable.
821 This must support the \fB-bs\fR option (Postfix, Exim and Sendmail should all
822 work).
823 The default is the sendmail executable found at compile time.
824 .TP
825 .B short_display \fICHARACTERS\fR
826 Defines the maximum number of characters to include in a \fBshort\fR name
827 part.
828 Default 30.
829 .TP
830 .B smtp_server \fIHOSTNAME\fR
831 The hostname (or address) of the SMTP server to use for sending mail.
832 The default is
833 If \fBsendmail\fR is set then that is used instead.
834 .TP
835 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
836 Determines how names are sorted and displayed in track choice displays.
837 .IP
838 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
839 \fBdir\fR but you can define your own.
840 .IP
841 \fICONTEXT\fR is a glob pattern matching the context.
842 Standard contexts are \fBsort\fR (which determines how directory names
843 are sorted) and \fBdisplay\fR (which determines how they are displayed).
844 Again, you can define your own.
845 .IP
846 All the \fBtransform\fR directives are considered in order.
847 If the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
848 then a new track name is constructed from
849 \fISUBST\fR according to the substitution rules below.
850 If several match then each is executed in order.
851 .IP
852 If you supply no \fBtransform\fR directives at all then a default set will be
853 supplied automatically.
854 But if you supply even one then you must supply all of them.
855 The defaults are:
856 .PP
857 .nf
858 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
859 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$"        $1 sort
860 transform dir   "^.*/([^/]+)$"                      $1 *
861 transform dir   "^(the) ([^/]*)"                    "$2 $1" sort i
862 transform dir   "[[:punct:]]"                       "" sort g
863 .fi
864 .TP
865 .B url \fIURL\fR
866 Specifies the URL of the web interface.
867 This URL will be used in generated web pages.
868 The default is inferred at runtime, so this option no
869 longer needs to be specified.
870 .IP
871 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
872 \fB/cgi-bin/jukebox\fR.
874 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3).
875 The only option used is \fBPCRE_UTF8\fR.
876 Remember that the configuration file syntax means you have to
877 escape backslashes and quotes inside quoted strings.
878 .PP
879 In a \fISUBST\fR string the following sequences are interpreted
880 specially:
881 .TP
882 .B $1 \fR... \fB$9
883 These expand to the first to ninth bracketed subexpression.
884 .TP
885 .B $&
886 This expands to the matched part of the subject string.
887 .TP
888 .B $$
889 This expands to a single \fB$\fR symbol.
890 .PP
891 All other pairs starting with \fB$\fR are undefined (and might be used
892 for something else in the future, so don't rely on the current
893 behaviour.)
894 .PP
895 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent.
896 If \fBg\fR is present then all matches are replaced, otherwise only the first
897 match is replaced.
899 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
900 with the obvious intended meaning.
901 These are controlled by configuration and by \fBtrackname_\fR preferences.
902 .PP
903 In addition there are two built-in parts, \fBpath\fR which is the whole path
904 name and \fBext\fR which is the filename extension, including the initial dot
905 (or the empty string if there is not extension).
906 .SH "SEE ALSO"
907 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8),
908 \fBpcrepattern\fR(3), \fBdisorder_templates\fR(5), \fBdisorder_actions\fR(5),
909 \fBdisorder.cgi\fR(8), \fBdisorder_preferences\fR(5)
910 .\" Local Variables:
911 .\" mode:nroff
912 .\" fill-column:79
913 .\" End: