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 .
225 Per-user client configuration.
226 Optional but if it exists must be readable only by the relevant user.
227 Would normally contain a \fBpassword\fR directive.
229 .I pkgconfdir/config.\fRUSERNAME
231 .BR $DISORDER_USERCONFIG_SYS ,
233 .BR $DISORDER_CONFIG.\fIUSERNAME .)
234 Per-user system-controlled client configuration.
235 Optional but if it exists must be readable only by the relevant user.
236 Would normally contain a \fBpassword\fR directive.
238 The prefererred location for per-user passwords is \fI~/.disorder/passwd\fR and
239 \fBdisorder authorize\fR writes there now.
240 .SS "Global Configuration"
242 .B home \fIDIRECTORY\fR
243 The home directory for state files.
246 The server will create this directory on startup if it does not exist.
248 This setting cannot be changed during the lifetime of the server.
250 .B plugins \fIPATH\fR
251 Adds a directory to the plugin path.
252 (This is also used by the web interface.)
254 Plugins are opened the first time they are required and never after,
255 so after changing a plugin you must restart the server before it is
256 guaranteed to take effect.
260 is used without arguments the plugin path is cleared.
261 .SS "Server Configuration"
263 .B alias \fIPATTERN\fR
264 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
267 Most characters stand for themselves, the exception being \fB{\fR which is used
268 to insert a track name part in the form \fB{\fIname\fB}\fR or
271 The difference is that the first form just inserts the name part while the
272 second prefixes it with a \fB/\fR if it is nonempty.
274 The pattern should not attempt to include the collection root, which is
275 automatically included, but should include the proper extension.
277 The default is \fB{/artist}{/album}{/title}{ext}\fR.
279 This setting cannot be changed during the lifetime of the server.
282 Selects the backend used to play sound and to set the volume.
283 The following options are available:
288 This is only available on Linux systems, on which it is the default.
291 Use Apple Core Audio.
292 This only available on OS X systems, on which it is the default.
295 Use the OSS (/dev/dsp) API.
296 Not available on all platforms.
300 This is the default if
302 is specified, or if no native is available.
304 You might want to set
309 Transmit audio over the network.
310 This is the default if \fBbroadcast\fR is specified.
312 .BR disorder-playrtp (1)
313 to receive and play the resulting stream on Linux and OS X.
315 is a deprecated synonym for this API.
318 .B authorization_algorithm \fIALGORITHM\fR
319 Defines the algorithm used to authenticate clients.
320 The valid options are sha1 (the default), sha256, sha384 and sha512.
322 .BR disorder_protocol (5)
325 .B broadcast \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR
326 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.
327 This implies \fBapi rtp\fR.
329 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
330 implied by \fIADDRESS\fR.
331 Note that IPv6 is not currently well tested.
333 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
335 .B broadcast_from \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR
336 Sets the (local) source address used by \fBbroadcast\fR.
338 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
339 implied by \fIADDRESS\fR.
340 Note that IPv6 is not currently well tested.
342 .B channel \fICHANNEL\fR
343 The mixer channel that the volume control should use.
345 For \fBapi oss\fR the possible values are:
349 Output level for the audio device.
350 This is probably what you want and is the default.
353 Output level for the PC speaker, if that is connected to the sound card.
356 Output level for alternative codec device.
360 The OSS documentation recommends against using this, as it affects all
364 You can also specify channels by number, if you know the right value.
366 For \fBapi alsa\fR, this is the name of the mixer control to use.
367 The default is \fBPCM\fR.
368 Use \fBamixer scontrols\fR or similar to get a full list.
370 For \fBapi coreaudio\fR, volume setting is not currently supported.
372 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
374 .B collection \fIMODULE\fR \fIROOT\fR
376 .B collection \fIROOT\fR
377 Define a collection of tracks.
379 \fIMODULE\fR defines which plugin module should be used for this
381 Use the supplied \fBfs\fR module for tracks that exist as ordinary
382 files in the filesystem.
383 If no \fIMODULE\fR is specified then \fBfs\fR is assumed.
385 \fIENCODING\fR defines the encoding of filenames in this collection.
386 For \fBfs\fR this would be the encoding you use for filenames.
387 Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR.
388 If no encoding is specified then the current locale's character encoding
391 NB that this default depends on the locale the server runs in, which is not
392 necessarily the same as that of ordinary users, depending how the system is
394 It's best to explicitly specify it to be certain.
396 \fIROOT\fR is the root in the filesystem of the filenames and is
397 passed to the plugin module.
398 It must be an absolute path and should not end with a "/".
400 .B cookie_key_lifetime \fISECONDS\fR
401 Lifetime of the signing key used in constructing cookies. The default is one
404 If this is changed during the lifetime of the server, the current key doesn't
405 hvave its lifetime retroactively changed.
407 .B cookie_login_lifetime \fISECONDS\fR
408 Lifetime of a cookie enforced by the server. When the cookie expires the user
409 will have to log in again even if their browser has remembered the cookie that
410 long. The default is one day.
412 If this is changed during the lifetime of the server, cookies that have already
413 een generated don't hvave their lifetime retroactively changed.
415 .B default_rights \fIRIGHTS\fR
416 Defines the set of rights given to new users.
417 The argument is a comma-separated list of rights.
418 For the possible values see
419 .B "Users And Access Control"
422 The default is to allow everything except \fBadmin\fR and \fBregister\fR.
427 For \fBapi oss\fR this is the path to the device to use.
428 If it is set to \fBdefault\fR then \fI/dev/dsp\fR and \fI/dev/audio\fR
431 For \fBapi alsa\fR this is the device name to use.
433 For \fBapi coreaudio\fR this can be either the UID or the human-readable
434 name of the desired device.
435 For a list of names, visit System Preferences -> Sound and look at the Type column.
436 For example, you might use "Built-in Output" for the built-in speaker
437 or "Built-in Line Output" if you have connected external speakers.
438 Remember to quote the name.
440 The default is \fBdefault\fR, which is intended to map to whatever the system's
443 .B history \fIINTEGER\fR
444 Specifies the number of recently played tracks to remember (including
445 failed tracks and scratches).
447 If this is changed during the lifetime of the server, it won't actually reduce
448 the size of the list until it is next modified.
450 .B listen \fR[\fIFAMILY\fR] \fR[\fIHOST\fR] \fISERVICE\fR
451 Listen for connections on the address specified by \fIHOST\fR and port
452 specified by \fISERVICE\fR.
453 If \fIHOST\fR is omitted, or is \fB*\fR, then listens on all local addresses.
455 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
456 implied by \fIHOST\fR.
457 Note that IPv6 is not currently well tested.
459 Normally the server only listens on a UNIX domain socket.
461 .B mixer \fIDEVICE\fR
462 The mixer device name, if it needs to be specified separately from
465 For \fBapi oss\fR this should be the path to the mixer device and the default
468 For \fBapi alsa\fR, this is the index of the mixer control to use.
471 For \fBapi coreaudio\fR, volume setting is not currently supported.
473 .B mount_rescan yes\fR|\fBno
474 Determines whether mounts and unmounts will cause an automatic rescan.
475 The default is \fByes\fR.
477 .B multicast_loop yes\fR|\fBno
478 Determines whether multicast packets are loop backed to the sending host.
479 The default is \fByes\fR.
480 This only applies if \fBapi\fR is set to \fBrtp\fR and \fBbroadcast\fR
481 is actually a multicast address.
483 .B multicast_ttl \fIHOPS\fR
484 Set the maximum number of hops to send multicast packets.
485 This only applies if \fBapi\fR is set to \fBrtp\fR and
486 \fBbroadcast\fR is actually a multicast address.
489 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
490 Determines how to extract trackname part \fIPART\fR from a
491 track name (with the collection root part removed).
492 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
494 Track names can be different in different contexts.
495 For instance the sort string might include an initial track number,
496 but this would be stripped for the display string.
497 \fICONTEXT\fR should be a glob pattern matching the
498 contexts in which this directive will be used.
500 Valid contexts are \fBsort\fR and \fBdisplay\fR.
502 All the \fBnamepart\fR directives are considered in order.
503 The first directive for the right part, that matches the desired context,
504 and with a \fIREGEXP\fR that
505 matches the track is used, and the value chosen is constructed from
506 \fISUBST\fR according to the substitution rules below.
508 Note that searches use the raw track name and \fBtrackname_\fR preferences but
509 not (currently) the results of \fBnamepart\fR, so generating words via this option
510 that aren't in the original track name will lead to confusing results.
512 If you supply no \fBnamepart\fR directives at all then a default set will be
513 supplied automatically.
514 But if you supply even one then you must supply all of them.
515 The defaults are equivalent to:
518 namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
519 namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
520 namepart album "/([^/]+)/[^/]+$" $1 *
521 namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 *
522 namepart ext "(\\.[a-zA-Z0-9]+)$" $1 *
525 This setting cannot be changed during the lifetime of the server.
527 .B new_bias \fIWEIGHT\fR
528 The weight for new tracks.
529 The default is 450000, i.e. recently added tracks are a fifty times as likely
530 to be picked as normal.
532 New values of this option may be picked up from the configuration file even
535 .B new_bias_age \fISECONDS\fR
536 The maximum age of tracks that \fBnew_bias\fR applies to, in seconds.
537 The default is one week.
539 New values of this option may be picked up from the configuration file even
543 The maximum number of tracks to list when reporting newly noticed tracks.
546 .B nice_rescan \fIPRIORITY\fR
547 Set the recan subprocess priority.
550 (Note that higher values mean the process gets less CPU time; UNIX priority
551 values are backwards.)
553 .B nice_server \fIPRIORITY\fR
554 Set the server priority.
555 This is applied to the server at startup time (and not when you reload
557 The server does not use much CPU itself but this value is inherited
558 by programs it executes.
559 If you have limited CPU then it might help to set this to a small
563 Changes to this value during the lifetime of the server are ignored.
565 .B nice_speaker \fIPRIORITY\fR
566 Set the speaker process priority.
567 This is applied to the speaker process at startup time (and not when
568 you reload the configuration).
569 The speaker process is not massively CPU intensive by today's
570 standards but depends on reasonably timely scheduling.
571 If you have limited CPU then it might help to set this to a small
575 Changes to this value during the lifetime of the server are ignored.
578 The maximum days that a track can survive in the database of newly added
582 .B pause_mode \fIMODE
583 Sets the pause mode for the \fBcommand\fR backend.
584 The possible values are:
588 Send silent (0-value) samples when paused.
592 Stop writing when paused.
595 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR...
596 Specifies the player for files matching the glob \fIPATTERN\fR.
597 \fIMODULE\fR specifies which plugin module to use.
599 The following options are supported:
603 Defines the end of the list of options.
604 Needed if the first argument to the plugin starts with a "\-".
607 The following are the standard modules:
610 .B exec \fICOMMAND\fR \fIARGS\fR...
611 The command is executed via \fBexecvp\fR(3), not via the shell.
612 The \fBPATH\fR environment variable is searched for the executable if it is not
614 The command is expected to know how to open its own sound device.
616 .B execraw \fICOMMAND\fR \fIARGS\fR...
617 Identical to the \fBexec\fR except that the player is expected to use the
618 DisOrder raw player protocol.
619 .BR disorder-decode (8)
620 can decode several common audio file formats to this format.
622 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
623 The command is executed using the shell.
624 If \fISHELL\fR is specified then that is used, otherwise \fBsh\fR will be used.
625 In either case the \fBPATH\fR environment variable is searched for the shell
626 executable if it is not an absolute path.
627 The track name is stored in the environment variable
630 Be careful of the interaction between the configuration file quoting rules and
631 the shell quoting rules.
634 If multiple player commands match a track then the first match is used.
636 For the server to be able to calculate track lengths, there should be a
638 command corresponding to each
644 is used without arguments, the list of players is cleared.
646 Although players can be changed during the lifetime of the server, note that
647 background decoders will not be stopped and restarted using changed
648 configuration once they have been started.
650 .B queue_pad \fICOUNT\fR
651 The target size of the queue.
652 If random play is enabled then randomly picked tracks will be added until
653 the queue is at least this big.
656 If this is reduced during the lifetime of the server, the queue won't be
657 reduced in size to fit; it just won't start growing again until it is under the
659 However, if it is increased, new tracks will start being added immediately.
661 .B reminder_interval \fISECONDS\fR
662 The minimum number of seconds that must elapse between password reminders.
663 The default is 600, i.e. 10 minutes.
665 .B remote_userman yes\fR|\fBno
666 User management over TCP connection is only allowed if this is set to
667 \fByes\fR. By default it is set to \fBno\fR.
669 .B replay_min \fISECONDS\fR
670 The minimum number of seconds that must elapse after a track has been played
671 before it can be picked at random. The default is 8 hours. If this is set to
672 0 then there is no limit, though current \fBdisorder-choose\fR will not pick
673 anything currently listed in the recently-played list.
675 New values of this option may be picked up from the configuration file even
678 .B rtp_always_request yes\fR|\fBno
682 .BR disorder-playrtp (1)
683 will always request a dedicated RTP stream,
684 rather than contacting the server to discover
685 a broadcast or multicast address.
686 (This behaviour can be overridden by
687 setting a suitable address on the command-line.)
691 This option is experimental,
692 and may change or be removed in a future release.
694 .B rtp_maxbuffer \fIFRAMES\fR
696 .BR disorder-playrtp (1)'s
697 buffer size to the given number of
699 If this is zero, then
701 will select a default buffer size.
702 (This setting can be overridden by passing
703 a suitable command-line option.)
707 This option is experimental,
708 and may change or be removed in a future release.
710 .B rtp_max_payload \fBYTES\fR
711 Don't send RTP packets with a UDP payload larger than
713 (including the 12-byte RTP header). If you know that you will be transmitting
714 RTP over networks with an unusually low MTU size, then it is probably useful to
717 This option is experimental,
718 and may change or be removed in a future release.
720 .B rtp_minbuffer \fIFRAMES\fR
722 .BR disorder-playrtp (1)'s
723 buffer low-water-mark to the given number of
725 If this is zero, then
727 will select a default low-water-mark.
728 (This setting can be overridden by passing
729 a suitable command-line option.)
731 This option is experimental,
732 and may change or be removed in a future release.
736 This option is experimental, and may change or be removed in a future release.
738 .B rtp_mode \fIMODE\fR
739 The network transmission mode for the \fBrtp\fR backend.
744 Unicast transmission to the address given by \fBbroadcast\fR.
747 Broadcast transmission to the address given by \fBbroadcast\fR.
750 Multicast transmission to the address given by \fBbroadcast\fR.
753 Unicast transmission to addresses requested by clients.
756 Choose one of the above based on the destination address.
757 This is the default, for backwards compatibility reasons.
760 .B rtp_mtu_discovery \fIOPTION\fR
761 Control whether the system attemps path-MTU discovery using RTP packets
762 transmitted over IPv4. (This is not configurable in IPv6.) Possible values
767 Do whatever the kernel usually does with UDP packets. This is, err, the
771 Force path-MTU disocvery. The `don't fragment' bit is set on outgoing packets
772 and we assume that the kernel will handle ICMP `fragmentation needed' errors
773 coming back and fragment accordingly.
776 Disable path-MTU discovery. Packets will be sent without the `don't fragment'
777 bit, and routers will be expected to fragment packets as necessary.
780 This option is experimental, and may change or be removed in a future release.
782 .B rtp_rcvbuf \fISIZE\fR
784 .BR disorder-playrtp (1)'s
785 socket receive buffer to at least
787 (This setting can be overridden by passing
788 a suitable command-line option.)
792 This option is experimental,
793 and may change or be removed in a future release.
795 .B rtp_request_address \fR[\fIFAMILY\fR] \fR[\fIHOST\fR] \fISERVICE\fR
797 .BR disorder-playrtp (1)
798 is to request a unicast RTP stream,
799 then it should establish its receiving socket
800 to listen on the given address.
805 may be omitted, in which case
807 uses heuristics to determine suitable values.
810 may be omitted, in which case
812 uses a kernel-allocated port.
813 (This setting can be overridden by passing
814 a suitable address on the command line.)
817 which uses a heuristically-chosen address and a kernel-allocated port.
819 This option is experimental,
820 and may change or be removed in a future release.
822 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
823 Describes the sample format expected by the \fBspeaker_command\fR (below).
824 The components of the format specification are as follows:
828 The number of bits per sample.
829 Optionally, may be suffixed by \fBb\fR or \fBl\fR for big-endian and
831 If neither is used the native byte order is assumed.
834 The number of samples per second.
837 The number of channels.
844 backend the sample format is forced to
848 backend it is forced to
850 in both cases regardless of what is specified in the configuration file.
854 Defines the signal to be sent to track player process groups when tracks are
856 The default is \fBSIGKILL\fR.
858 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
859 or \fBInterrupted\fR or whatever.
861 .B sox_generation \fB0\fR|\fB1
862 Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if
863 the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1).
864 See the documentation for your installed copy of \fBsox\fR to determine
866 The default is set according to the version of sox found when DisOrder was
868 If you run on a system with a different version of sox, you will need to
871 .B speaker_backend \fINAME
872 This is an alias for \fBapi\fR; see above.
874 .B speaker_command \fICOMMAND
875 Causes the speaker subprocess to pipe audio data into shell command
876 \fICOMMAND\fR, rather than writing to a local sound card.
877 The sample format is determine by
881 Note that if the sample format is wrong then
883 is invoked to translate it.
886 is not installed then this will not work.
888 .B scratch \fIPATH\fR
890 When a track is scratched, a scratch track is played at random.
891 Scratches are played using the same logic as other tracks.
893 At least for the time being, path names of scratches must be encoded using
894 UTF-8 (which means that ASCII will do).
896 If \fBscratch\fR is used without arguments then the list of scratches is
899 .B stopword \fIWORD\fR ...
900 Specifies one or more stopwords that should not take part in searches
903 If \fBstopword\fR is used without arguments then the list of stopwords is
906 There is a default set of stopwords built in, but this option can be used to
907 augment or replace that list.
909 This setting cannot be changed during the lifetime of the server.
911 .B tracklength \fIPATTERN\fR \fIMODULE\fR
912 Specifies the module used to calculate the length of files matching
914 \fIMODULE\fR specifies which plugin module to use.
916 If \fBtracklength\fR is used without arguments then the list of modules is
919 Track lengths are cached in the database, and changing this setting won't cause
920 them to be regenerated.
922 .B user \fIUSERNAME\fR
923 Specifies the user to run as.
924 Only makes sense if invoked as root (or the target user).
926 This setting cannot be changed during the lifetime of the server
927 (and if it is changed with a restart, you will need to adjust file permissions
928 on the server's database).
929 .SS "Client Configuration"
930 These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR
932 \fIpkgconfdir/config.\fRUSERNAME.
934 .B connect \fR[\fIFAMILY\fR] \fIHOST SERVICE\fR
935 Connect to the address specified by \fIHOST\fR and port specified by
938 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
939 implied by \fIHOST\fR.
940 Note that IPv6 is not currently well tested.
942 .B password \fIPASSWORD\fR
945 .B username \fIUSERNAME\fR
947 The default is inferred from the current UID.
948 .SS "Web Interface Configuration"
949 .\" TODO this section is misnamed really...
951 .B mail_sender \fIADDRESS\fR
952 The email address that appears in the From: field of any mail messages sent by
954 This must be set if you have online registration enabled.
956 .B refresh \fISECONDS\fR
957 Specifies the maximum refresh period in seconds.
958 The refresh period is the time after which the web interface's queue and manage
959 pages will automatically reload themselves.
962 .B refresh_min \fISECONDS\fR
963 Specifies the minimum refresh period in seconds.
966 .B sendmail \fIPATH\fR
967 The path to the Sendmail executable.
968 This must support the \fB-bs\fR option (Postfix, Exim and Sendmail should all
970 The default is the sendmail executable found at compile time.
972 .B short_display \fICHARACTERS\fR
973 Defines the maximum number of characters to include in a \fBshort\fR name
977 .B smtp_server \fIHOSTNAME\fR
978 The hostname (or address) of the SMTP server to use for sending mail.
979 The default is 127.0.0.1.
980 If \fBsendmail\fR is set then that is used instead.
982 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
983 Determines how names are sorted and displayed in track choice displays.
985 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
986 \fBdir\fR but you can define your own.
988 \fICONTEXT\fR is a glob pattern matching the context.
989 Standard contexts are \fBsort\fR (which determines how directory names
990 are sorted) and \fBdisplay\fR (which determines how they are displayed).
991 Again, you can define your own.
993 All the \fBtransform\fR directives are considered in order.
994 If the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
995 then a new track name is constructed from
996 \fISUBST\fR according to the substitution rules below.
997 If several match then each is executed in order.
999 If you supply no \fBtransform\fR directives at all then a default set will be
1000 supplied automatically.
1001 But if you supply even one then you must supply all of them.
1005 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
1006 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
1007 transform dir "^.*/([^/]+)$" $1 *
1008 transform dir "^(the) ([^/]*)" "$2 $1" sort i
1009 transform dir "[[:punct:]]" "" sort g
1013 Specifies the URL of the web interface.
1014 This URL will be used in generated web pages.
1015 The default is inferred at runtime, so this option no
1016 longer needs to be specified.
1018 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
1019 \fB/cgi-bin/jukebox\fR.
1020 .SH "REGEXP SUBSTITUTION RULES"
1021 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3).
1022 The only option used is \fBPCRE_UTF8\fR.
1023 Remember that the configuration file syntax means you have to
1024 escape backslashes and quotes inside quoted strings.
1026 In a \fISUBST\fR string the following sequences are interpreted
1030 These expand to the first to ninth bracketed subexpression.
1033 This expands to the matched part of the subject string.
1036 This expands to a single \fB$\fR symbol.
1038 All other pairs starting with \fB$\fR are undefined (and might be used
1039 for something else in the future, so don't rely on the current
1042 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent.
1043 If \fBg\fR is present then all matches are replaced, otherwise only the first
1045 .SH "TRACK NAME PARTS"
1046 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
1047 with the obvious intended meaning.
1048 These are controlled by configuration and by \fBtrackname_\fR preferences.
1050 In addition there are two built-in parts, \fBpath\fR which is the whole path
1051 name and \fBext\fR which is the filename extension, including the initial dot
1052 (or the empty string if there is not extension).
1054 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8),
1055 \fBpcrepattern\fR(3), \fBdisorder_templates\fR(5), \fBdisorder_actions\fR(5),
1056 \fBdisorder.cgi\fR(8), \fBdisorder_preferences\fR(5)
1057 .\" Local Variables:
~mdw / disorder / blob