2 .\" Copyright (C) 2004-2011, 2013 Richard Kettlewell
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.
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.
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/>.
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)).
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
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
33 See \fBdisorder\fR(3) for more details about this.
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.
40 Track names are derived from filenames under the control of regular
41 expressions, rather than attempting to interpret format-specific embedded name
43 They can be overridden by setting preferences.
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.
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.
57 Each user has an associated set of rights which control which commands they may
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).
62 The full set of rights are:
65 User can perform read-only operations
68 User can add tracks to the queue
71 User can move any track
74 User can move their own tracks
77 User can move randomly chosen tracks
80 User can remove any track
83 User can remove their own tracks
86 User can remove randomly chosen tracks
89 User can scratch any track
92 User can scratch their own tracks
95 User can scratch randomly chosen tracks
98 User can change the volume
101 User can perform admin operations
104 User can initiate a rescan
107 User can register new users.
110 user would have this right.
113 User can edit their own userinfo
116 User can modify track preferences
119 User can modify global preferences
122 User can pause/resume
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
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
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
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:".
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:
146 LATIN CAPITAL 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
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.
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"
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 ("#").
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:
186 No other escape sequences are allowed.
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.
192 After editing the config file use \fBdisorder reconfigure\fR to make
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:
203 .BR $DISORDER_CONFIG ,
204 if that's set; overridden by
207 command line option, except in
208 .BR disrder-playrtp (1),
212 .I pkgconfdir/config.private
214 .BR $DISORDER_PRIVCONFIG ,
216 .BR $DISORDER_CONFIG.private .
217 Should be readable only by the jukebox group.
218 Not really useful any more and will be abolished in future.
220 .I ~\fRUSERNAME\fI/.disorder/passwd
222 .BR $DISORDER_USERCONFIG ,
224 .BR $DISORDER_HOME/passwd ;
227 .RB ( \-\-user-config )
229 Per-user client configuration.
230 Optional but if it exists must be readable only by the relevant user.
231 Would normally contain a \fBpassword\fR directive.
233 .I pkgconfdir/config.\fRUSERNAME
235 .BR $DISORDER_USERCONFIG_SYS ,
237 .BR $DISORDER_CONFIG.\fIUSERNAME .)
238 Per-user system-controlled client configuration.
239 Optional but if it exists must be readable only by the relevant user.
240 Would normally contain a \fBpassword\fR directive.
242 The prefererred location for per-user passwords is \fI~/.disorder/passwd\fR and
243 \fBdisorder authorize\fR writes there now.
244 .SS "Global Configuration"
246 .B home \fIDIRECTORY\fR
247 The home directory for state files.
250 The server will create this directory on startup if it does not exist.
252 This setting cannot be changed during the lifetime of the server.
254 .B plugins \fIPATH\fR
255 Adds a directory to the plugin path.
256 (This is also used by the web interface.)
258 Plugins are opened the first time they are required and never after,
259 so after changing a plugin you must restart the server before it is
260 guaranteed to take effect.
264 is used without arguments the plugin path is cleared.
265 .SS "Server Configuration"
267 .B alias \fIPATTERN\fR
268 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
271 Most characters stand for themselves, the exception being \fB{\fR which is used
272 to insert a track name part in the form \fB{\fIname\fB}\fR or
275 The difference is that the first form just inserts the name part while the
276 second prefixes it with a \fB/\fR if it is nonempty.
278 The pattern should not attempt to include the collection root, which is
279 automatically included, but should include the proper extension.
281 The default is \fB{/artist}{/album}{/title}{ext}\fR.
283 This setting cannot be changed during the lifetime of the server.
286 Selects the backend used to play sound and to set the volume.
287 The following options are available:
292 This is only available on Linux systems, on which it is the default.
295 Use Apple Core Audio.
296 This only available on OS X systems, on which it is the default.
299 Use the OSS (/dev/dsp) API.
300 Not available on all platforms.
304 This is the default if
306 is specified, or if no native is available.
308 You might want to set
313 Transmit audio over the network.
314 This is the default if \fBbroadcast\fR is specified.
316 .BR disorder-playrtp (1)
317 to receive and play the resulting stream on Linux and OS X.
319 is a deprecated synonym for this API.
322 .B authorization_algorithm \fIALGORITHM\fR
323 Defines the algorithm used to authenticate clients.
324 The valid options are sha1 (the default), sha256, sha384 and sha512.
326 .BR disorder_protocol (5)
329 .B broadcast \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR
330 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.
331 This implies \fBapi rtp\fR.
333 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
334 implied by \fIADDRESS\fR.
335 Note that IPv6 is not currently well tested.
337 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
339 .B broadcast_from \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR
340 Sets the (local) source address used by \fBbroadcast\fR.
342 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
343 implied by \fIADDRESS\fR.
344 Note that IPv6 is not currently well tested.
346 .B channel \fICHANNEL\fR
347 The mixer channel that the volume control should use.
349 For \fBapi oss\fR the possible values are:
353 Output level for the audio device.
354 This is probably what you want and is the default.
357 Output level for the PC speaker, if that is connected to the sound card.
360 Output level for alternative codec device.
364 The OSS documentation recommends against using this, as it affects all
368 You can also specify channels by number, if you know the right value.
370 For \fBapi alsa\fR, this is the name of the mixer control to use.
371 The default is \fBPCM\fR.
372 Use \fBamixer scontrols\fR or similar to get a full list.
374 For \fBapi coreaudio\fR, volume setting is not currently supported.
376 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
378 .B collection \fIMODULE\fR \fIROOT\fR
380 .B collection \fIROOT\fR
381 Define a collection of tracks.
383 \fIMODULE\fR defines which plugin module should be used for this
385 Use the supplied \fBfs\fR module for tracks that exist as ordinary
386 files in the filesystem.
387 If no \fIMODULE\fR is specified then \fBfs\fR is assumed.
389 \fIENCODING\fR defines the encoding of filenames in this collection.
390 For \fBfs\fR this would be the encoding you use for filenames.
391 Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR.
392 If no encoding is specified then the current locale's character encoding
395 NB that this default depends on the locale the server runs in, which is not
396 necessarily the same as that of ordinary users, depending how the system is
398 It's best to explicitly specify it to be certain.
400 \fIROOT\fR is the root in the filesystem of the filenames and is
401 passed to the plugin module.
402 It must be an absolute path and should not end with a "/".
404 .B cookie_key_lifetime \fISECONDS\fR
405 Lifetime of the signing key used in constructing cookies. The default is one
408 If this is changed during the lifetime of the server, the current key doesn't
409 hvave its lifetime retroactively changed.
411 .B cookie_login_lifetime \fISECONDS\fR
412 Lifetime of a cookie enforced by the server. When the cookie expires the user
413 will have to log in again even if their browser has remembered the cookie that
414 long. The default is one day.
416 If this is changed during the lifetime of the server, cookies that have already
417 een generated don't hvave their lifetime retroactively changed.
419 .B default_rights \fIRIGHTS\fR
420 Defines the set of rights given to new users.
421 The argument is a comma-separated list of rights.
422 For the possible values see
423 .B "Users And Access Control"
426 The default is to allow everything except \fBadmin\fR and \fBregister\fR.
431 For \fBapi oss\fR this is the path to the device to use.
432 If it is set to \fBdefault\fR then \fI/dev/dsp\fR and \fI/dev/audio\fR
435 For \fBapi alsa\fR this is the device name to use.
437 For \fBapi coreaudio\fR this can be either the UID or the human-readable
438 name of the desired device.
439 For a list of names, visit System Preferences -> Sound and look at the Type column.
440 For example, you might use "Built-in Output" for the built-in speaker
441 or "Built-in Line Output" if you have connected external speakers.
442 Remember to quote the name.
444 The default is \fBdefault\fR, which is intended to map to whatever the system's
447 .B history \fIINTEGER\fR
448 Specifies the number of recently played tracks to remember (including
449 failed tracks and scratches).
451 If this is changed during the lifetime of the server, it won't actually reduce
452 the size of the list until it is next modified.
454 .B listen \fR[\fIFAMILY\fR] \fR[\fIHOST\fR] \fISERVICE\fR
455 Listen for connections on the address specified by \fIHOST\fR and port
456 specified by \fISERVICE\fR.
457 If \fIHOST\fR is omitted, or is \fB*\fR, then listens on all local addresses.
459 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
460 implied by \fIHOST\fR.
461 Note that IPv6 is not currently well tested.
463 Normally the server only listens on a UNIX domain socket.
465 .B mixer \fIDEVICE\fR
466 The mixer device name, if it needs to be specified separately from
469 For \fBapi oss\fR this should be the path to the mixer device and the default
472 For \fBapi alsa\fR, this is the index of the mixer control to use.
475 For \fBapi coreaudio\fR, volume setting is not currently supported.
477 .B mount_rescan yes\fR|\fBno
478 Determines whether mounts and unmounts will cause an automatic rescan.
479 The default is \fByes\fR.
481 .B multicast_loop yes\fR|\fBno
482 Determines whether multicast packets are loop backed to the sending host.
483 The default is \fByes\fR.
484 This only applies if \fBapi\fR is set to \fBrtp\fR and \fBbroadcast\fR
485 is actually a multicast address.
487 .B multicast_ttl \fIHOPS\fR
488 Set the maximum number of hops to send multicast packets.
489 This only applies if \fBapi\fR is set to \fBrtp\fR and
490 \fBbroadcast\fR is actually a multicast address.
493 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
494 Determines how to extract trackname part \fIPART\fR from a
495 track name (with the collection root part removed).
496 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
498 Track names can be different in different contexts.
499 For instance the sort string might include an initial track number,
500 but this would be stripped for the display string.
501 \fICONTEXT\fR should be a glob pattern matching the
502 contexts in which this directive will be used.
504 Valid contexts are \fBsort\fR and \fBdisplay\fR.
506 All the \fBnamepart\fR directives are considered in order.
507 The first directive for the right part, that matches the desired context,
508 and with a \fIREGEXP\fR that
509 matches the track is used, and the value chosen is constructed from
510 \fISUBST\fR according to the substitution rules below.
512 Note that searches use the raw track name and \fBtrackname_\fR preferences but
513 not (currently) the results of \fBnamepart\fR, so generating words via this option
514 that aren't in the original track name will lead to confusing results.
516 If you supply no \fBnamepart\fR directives at all then a default set will be
517 supplied automatically.
518 But if you supply even one then you must supply all of them.
519 The defaults are equivalent to:
522 namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
523 namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
524 namepart album "/([^/]+)/[^/]+$" $1 *
525 namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 *
526 namepart ext "(\\.[a-zA-Z0-9]+)$" $1 *
529 This setting cannot be changed during the lifetime of the server.
531 .B new_bias \fIWEIGHT\fR
532 The weight for new tracks.
533 The default is 450000, i.e. recently added tracks are a fifty times as likely
534 to be picked as normal.
536 New values of this option may be picked up from the configuration file even
539 .B new_bias_age \fISECONDS\fR
540 The maximum age of tracks that \fBnew_bias\fR applies to, in seconds.
541 The default is one week.
543 New values of this option may be picked up from the configuration file even
547 The maximum number of tracks to list when reporting newly noticed tracks.
550 .B nice_rescan \fIPRIORITY\fR
551 Set the recan subprocess priority.
554 (Note that higher values mean the process gets less CPU time; UNIX priority
555 values are backwards.)
557 .B nice_server \fIPRIORITY\fR
558 Set the server priority.
559 This is applied to the server at startup time (and not when you reload
561 The server does not use much CPU itself but this value is inherited
562 by programs it executes.
563 If you have limited CPU then it might help to set this to a small
567 Changes to this value during the lifetime of the server are ignored.
569 .B nice_speaker \fIPRIORITY\fR
570 Set the speaker process priority.
571 This is applied to the speaker process at startup time (and not when
572 you reload the configuration).
573 The speaker process is not massively CPU intensive by today's
574 standards but depends on reasonably timely scheduling.
575 If you have limited CPU then it might help to set this to a small
579 Changes to this value during the lifetime of the server are ignored.
582 The maximum days that a track can survive in the database of newly added
586 .B pause_mode \fIMODE
587 Sets the pause mode for the \fBcommand\fR backend.
588 The possible values are:
592 Send silent (0-value) samples when paused.
596 Stop writing when paused.
599 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR...
600 Specifies the player for files matching the glob \fIPATTERN\fR.
601 \fIMODULE\fR specifies which plugin module to use.
603 The following options are supported:
607 Defines the end of the list of options.
608 Needed if the first argument to the plugin starts with a "\-".
611 The following are the standard modules:
614 .B exec \fICOMMAND\fR \fIARGS\fR...
615 The command is executed via \fBexecvp\fR(3), not via the shell.
616 The \fBPATH\fR environment variable is searched for the executable if it is not
618 The command is expected to know how to open its own sound device.
620 .B execraw \fICOMMAND\fR \fIARGS\fR...
621 Identical to the \fBexec\fR except that the player is expected to use the
622 DisOrder raw player protocol.
623 .BR disorder-decode (8)
624 can decode several common audio file formats to this format.
626 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
627 The command is executed using the shell.
628 If \fISHELL\fR is specified then that is used, otherwise \fBsh\fR will be used.
629 In either case the \fBPATH\fR environment variable is searched for the shell
630 executable if it is not an absolute path.
631 The track name is stored in the environment variable
634 Be careful of the interaction between the configuration file quoting rules and
635 the shell quoting rules.
638 If multiple player commands match a track then the first match is used.
640 For the server to be able to calculate track lengths, there should be a
642 command corresponding to each
648 is used without arguments, the list of players is cleared.
650 Although players can be changed during the lifetime of the server, note that
651 background decoders will not be stopped and restarted using changed
652 configuration once they have been started.
654 .B queue_pad \fICOUNT\fR
655 The target size of the queue.
656 If random play is enabled then randomly picked tracks will be added until
657 the queue is at least this big.
660 If this is reduced during the lifetime of the server, the queue won't be
661 reduced in size to fit; it just won't start growing again until it is under the
663 However, if it is increased, new tracks will start being added immediately.
665 .B reminder_interval \fISECONDS\fR
666 The minimum number of seconds that must elapse between password reminders.
667 The default is 600, i.e. 10 minutes.
669 .B remote_userman yes\fR|\fBno
670 User management over TCP connection is only allowed if this is set to
671 \fByes\fR. By default it is set to \fBno\fR.
673 .B replay_min \fISECONDS\fR
674 The minimum number of seconds that must elapse after a track has been played
675 before it can be picked at random. The default is 8 hours. If this is set to
676 0 then there is no limit, though current \fBdisorder-choose\fR will not pick
677 anything currently listed in the recently-played list.
679 New values of this option may be picked up from the configuration file even
682 .B rtp_always_request yes\fR|\fBno
686 .BR disorder-playrtp (1)
687 will always request a dedicated RTP stream,
688 rather than contacting the server to discover
689 a broadcast or multicast address.
690 (This behaviour can be overridden by
691 setting a suitable address on the command-line.)
695 This option is experimental,
696 and may change or be removed in a future release.
698 .B rtp_maxbuffer \fIFRAMES\fR
700 .BR disorder-playrtp (1)'s
701 buffer size to the given number of
703 If this is zero, then
705 will select a default buffer size.
706 (This setting can be overridden by passing
707 a suitable command-line option.)
711 This option is experimental,
712 and may change or be removed in a future release.
714 .B rtp_max_payload \fBYTES\fR
715 Don't send RTP packets with a UDP payload larger than
717 (including the 12-byte RTP header). If you know that you will be transmitting
718 RTP over networks with an unusually low MTU size, then it is probably useful to
721 This option is experimental,
722 and may change or be removed in a future release.
724 .B rtp_minbuffer \fIFRAMES\fR
726 .BR disorder-playrtp (1)'s
727 buffer low-water-mark to the given number of
729 If this is zero, then
731 will select a default low-water-mark.
732 (This setting can be overridden by passing
733 a suitable command-line option.)
735 This option is experimental,
736 and may change or be removed in a future release.
740 This option is experimental, and may change or be removed in a future release.
742 .B rtp_mode \fIMODE\fR
743 The network transmission mode for the \fBrtp\fR backend.
748 Unicast transmission to the address given by \fBbroadcast\fR.
751 Broadcast transmission to the address given by \fBbroadcast\fR.
754 Multicast transmission to the address given by \fBbroadcast\fR.
757 Unicast transmission to addresses requested by clients.
760 Choose one of the above based on the destination address.
761 This is the default, for backwards compatibility reasons.
764 .B rtp_mtu_discovery \fIOPTION\fR
765 Control whether the system attemps path-MTU discovery using RTP packets
766 transmitted over IPv4. (This is not configurable in IPv6.) Possible values
771 Do whatever the kernel usually does with UDP packets. This is, err, the
775 Force path-MTU disocvery. The `don't fragment' bit is set on outgoing packets
776 and we assume that the kernel will handle ICMP `fragmentation needed' errors
777 coming back and fragment accordingly.
780 Disable path-MTU discovery. Packets will be sent without the `don't fragment'
781 bit, and routers will be expected to fragment packets as necessary.
784 This option is experimental, and may change or be removed in a future release.
786 .B rtp_rcvbuf \fISIZE\fR
788 .BR disorder-playrtp (1)'s
789 socket receive buffer to at least
791 (This setting can be overridden by passing
792 a suitable command-line option.)
796 This option is experimental,
797 and may change or be removed in a future release.
799 .B rtp_request_address \fR[\fIFAMILY\fR] \fR[\fIHOST\fR] \fISERVICE\fR
801 .BR disorder-playrtp (1)
802 is to request a unicast RTP stream,
803 then it should establish its receiving socket
804 to listen on the given address.
809 may be omitted, in which case
811 uses heuristics to determine suitable values.
814 may be omitted, in which case
816 uses a kernel-allocated port.
817 (This setting can be overridden by passing
818 a suitable address on the command line.)
821 which uses a heuristically-chosen address and a kernel-allocated port.
823 This option is experimental,
824 and may change or be removed in a future release.
826 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
827 Describes the sample format expected by the \fBspeaker_command\fR (below).
828 The components of the format specification are as follows:
832 The number of bits per sample.
833 Optionally, may be suffixed by \fBb\fR or \fBl\fR for big-endian and
835 If neither is used the native byte order is assumed.
838 The number of samples per second.
841 The number of channels.
848 backend the sample format is forced to
852 backend it is forced to
854 in both cases regardless of what is specified in the configuration file.
858 Defines the signal to be sent to track player process groups when tracks are
860 The default is \fBSIGKILL\fR.
862 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
863 or \fBInterrupted\fR or whatever.
865 .B sox_generation \fB0\fR|\fB1
866 Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if
867 the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1).
868 See the documentation for your installed copy of \fBsox\fR to determine
870 The default is set according to the version of sox found when DisOrder was
872 If you run on a system with a different version of sox, you will need to
875 .B speaker_backend \fINAME
876 This is an alias for \fBapi\fR; see above.
878 .B speaker_command \fICOMMAND
879 Causes the speaker subprocess to pipe audio data into shell command
880 \fICOMMAND\fR, rather than writing to a local sound card.
881 The sample format is determine by
885 Note that if the sample format is wrong then
887 is invoked to translate it.
890 is not installed then this will not work.
892 .B scratch \fIPATH\fR
894 When a track is scratched, a scratch track is played at random.
895 Scratches are played using the same logic as other tracks.
897 At least for the time being, path names of scratches must be encoded using
898 UTF-8 (which means that ASCII will do).
900 If \fBscratch\fR is used without arguments then the list of scratches is
903 .B stopword \fIWORD\fR ...
904 Specifies one or more stopwords that should not take part in searches
907 If \fBstopword\fR is used without arguments then the list of stopwords is
910 There is a default set of stopwords built in, but this option can be used to
911 augment or replace that list.
913 This setting cannot be changed during the lifetime of the server.
915 .B tracklength \fIPATTERN\fR \fIMODULE\fR
916 Specifies the module used to calculate the length of files matching
918 \fIMODULE\fR specifies which plugin module to use.
920 If \fBtracklength\fR is used without arguments then the list of modules is
923 Track lengths are cached in the database, and changing this setting won't cause
924 them to be regenerated.
926 .B user \fIUSERNAME\fR
927 Specifies the user to run as.
928 Only makes sense if invoked as root (or the target user).
930 This setting cannot be changed during the lifetime of the server
931 (and if it is changed with a restart, you will need to adjust file permissions
932 on the server's database).
933 .SS "Client Configuration"
934 These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR
936 \fIpkgconfdir/config.\fRUSERNAME.
938 .B connect \fR[\fIFAMILY\fR] \fIHOST SERVICE\fR
939 Connect to the address specified by \fIHOST\fR and port specified by
942 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
943 implied by \fIHOST\fR.
944 Note that IPv6 is not currently well tested.
946 .B password \fIPASSWORD\fR
949 .B username \fIUSERNAME\fR
951 The default is inferred from the current UID.
952 .SS "Web Interface Configuration"
953 .\" TODO this section is misnamed really...
955 .B mail_sender \fIADDRESS\fR
956 The email address that appears in the From: field of any mail messages sent by
958 This must be set if you have online registration enabled.
960 .B refresh \fISECONDS\fR
961 Specifies the maximum refresh period in seconds.
962 The refresh period is the time after which the web interface's queue and manage
963 pages will automatically reload themselves.
966 .B refresh_min \fISECONDS\fR
967 Specifies the minimum refresh period in seconds.
970 .B sendmail \fIPATH\fR
971 The path to the Sendmail executable.
972 This must support the \fB-bs\fR option (Postfix, Exim and Sendmail should all
974 The default is the sendmail executable found at compile time.
976 .B short_display \fICHARACTERS\fR
977 Defines the maximum number of characters to include in a \fBshort\fR name
981 .B smtp_server \fIHOSTNAME\fR
982 The hostname (or address) of the SMTP server to use for sending mail.
983 The default is 127.0.0.1.
984 If \fBsendmail\fR is set then that is used instead.
986 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
987 Determines how names are sorted and displayed in track choice displays.
989 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
990 \fBdir\fR but you can define your own.
992 \fICONTEXT\fR is a glob pattern matching the context.
993 Standard contexts are \fBsort\fR (which determines how directory names
994 are sorted) and \fBdisplay\fR (which determines how they are displayed).
995 Again, you can define your own.
997 All the \fBtransform\fR directives are considered in order.
998 If the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
999 then a new track name is constructed from
1000 \fISUBST\fR according to the substitution rules below.
1001 If several match then each is executed in order.
1003 If you supply no \fBtransform\fR directives at all then a default set will be
1004 supplied automatically.
1005 But if you supply even one then you must supply all of them.
1009 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
1010 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
1011 transform dir "^.*/([^/]+)$" $1 *
1012 transform dir "^(the) ([^/]*)" "$2 $1" sort i
1013 transform dir "[[:punct:]]" "" sort g
1017 Specifies the URL of the web interface.
1018 This URL will be used in generated web pages.
1019 The default is inferred at runtime, so this option no
1020 longer needs to be specified.
1022 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
1023 \fB/cgi-bin/jukebox\fR.
1024 .SH "REGEXP SUBSTITUTION RULES"
1025 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3).
1026 The only option used is \fBPCRE_UTF8\fR.
1027 Remember that the configuration file syntax means you have to
1028 escape backslashes and quotes inside quoted strings.
1030 In a \fISUBST\fR string the following sequences are interpreted
1034 These expand to the first to ninth bracketed subexpression.
1037 This expands to the matched part of the subject string.
1040 This expands to a single \fB$\fR symbol.
1042 All other pairs starting with \fB$\fR are undefined (and might be used
1043 for something else in the future, so don't rely on the current
1046 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent.
1047 If \fBg\fR is present then all matches are replaced, otherwise only the first
1049 .SH "TRACK NAME PARTS"
1050 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1051 with the obvious intended meaning.
1052 These are controlled by configuration and by \fBtrackname_\fR preferences.
1054 In addition there are two built-in parts, \fBpath\fR which is the whole path
1055 name and \fBext\fR which is the filename extension, including the initial dot
1056 (or the empty string if there is not extension).
1058 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8),
1059 \fBpcrepattern\fR(3), \fBdisorder_templates\fR(5), \fBdisorder_actions\fR(5),
1060 \fBdisorder.cgi\fR(8), \fBdisorder_preferences\fR(5)
1061 .\" Local Variables:
~mdw / disorder / blob