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 .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.
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.
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.
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"
221 .B home \fIDIRECTORY\fR
222 The home directory for state files.
225 The server will create this directory on startup if it does not exist.
227 This setting cannot be changed during the lifetime of the server.
229 .B plugins \fIPATH\fR
230 Adds a directory to the plugin path.
231 (This is also used by the web interface.)
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.
239 is used without arguments the plugin path is cleared.
240 .SS "Server Configuration"
242 .B alias \fIPATTERN\fR
243 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
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
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.
253 The pattern should not attempt to include the collection root, which is
254 automatically included, but should include the proper extension.
256 The default is \fB{/artist}{/album}{/title}{ext}\fR.
258 This setting cannot be changed during the lifetime of the server.
261 Selects the backend used to play sound and to set the volume.
262 The following options are available:
267 This is only available on Linux systems, on which it is the default.
270 Use Apple Core Audio.
271 This only available on OS X systems, on which it is the default.
274 Use the OSS (/dev/dsp) API.
275 Not available on all platforms.
279 This is the default if
281 is specified, or if no native is available.
283 You might want to set
288 Transmit audio over the network.
289 This is the default if \fBbroadcast\fR is specified.
291 .BR disorder-playrtp (1)
292 to receive and play the resulting stream on Linux and OS X.
294 is a deprecated synonym for this API.
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.
301 .BR disorder_protocol (5)
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.
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.
312 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
314 .B broadcast_from \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR
315 Sets the (local) source address used by \fBbroadcast\fR.
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.
321 .B channel \fICHANNEL\fR
322 The mixer channel that the volume control should use.
324 For \fBapi oss\fR the possible values are:
328 Output level for the audio device.
329 This is probably what you want and is the default.
332 Output level for the PC speaker, if that is connected to the sound card.
335 Output level for alternative codec device.
339 The OSS documentation recommends against using this, as it affects all
343 You can also specify channels by number, if you know the right value.
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.
349 For \fBapi coreaudio\fR, volume setting is not currently supported.
351 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
353 .B collection \fIMODULE\fR \fIROOT\fR
355 .B collection \fIROOT\fR
356 Define a collection of tracks.
358 \fIMODULE\fR defines which plugin module should be used for this
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.
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
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
373 It's best to explicitly specify it to be certain.
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 "/".
379 .B cookie_key_lifetime \fISECONDS\fR
380 Lifetime of the signing key used in constructing cookies. The default is one
383 If this is changed during the lifetime of the server, the current key doesn't
384 hvave its lifetime retroactively changed.
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.
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.
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"
401 The default is to allow everything except \fBadmin\fR and \fBregister\fR.
406 For \fBapi oss\fR this is the path to the device to use.
407 If it is set to \fBdefault\fR then \fI/dev/dsp\fR and \fI/dev/audio\fR
410 For \fBapi alsa\fR this is the device name to use.
412 For \fBapi coreaudio\fR this can be either the UID or the human-readable
413 name of the desired device.
414 For a list of names, visit System Preferences -> Sound and look at the Type column.
415 For example, you might use "Built-in Output" for the built-in speaker
416 or "Built-in Line Output" if you have connected external speakers.
417 Remember to quote the name.
419 The default is \fBdefault\fR, which is intended to map to whatever the system's
422 .B history \fIINTEGER\fR
423 Specifies the number of recently played tracks to remember (including
424 failed tracks and scratches).
426 If this is changed during the lifetime of the server, it won't actually reduce
427 the size of the list until it is next modified.
429 .B listen \fR[\fIFAMILY\fR] \fR[\fIHOST\fR] \fISERVICE\fR
430 Listen for connections on the address specified by \fIHOST\fR and port
431 specified by \fISERVICE\fR.
432 If \fIHOST\fR is omitted, or is \fB*\fR, then listens on all local addresses.
434 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
435 implied by \fIHOST\fR.
436 Note that IPv6 is not currently well tested.
438 Normally the server only listens on a UNIX domain socket.
440 .B mixer \fIDEVICE\fR
441 The mixer device name, if it needs to be specified separately from
444 For \fBapi oss\fR this should be the path to the mixer device and the default
447 For \fBapi alsa\fR, this is the index of the mixer control to use.
450 For \fBapi coreaudio\fR, volume setting is not currently supported.
452 .B mount_rescan yes\fR|\fBno
453 Determines whether mounts and unmounts will cause an automatic rescan.
454 The default is \fByes\fR.
456 .B multicast_loop yes\fR|\fBno
457 Determines whether multicast packets are loop backed to the sending host.
458 The default is \fByes\fR.
459 This only applies if \fBapi\fR is set to \fBrtp\fR and \fBbroadcast\fR
460 is actually a multicast address.
462 .B multicast_ttl \fIHOPS\fR
463 Set the maximum number of hops to send multicast packets.
464 This only applies if \fBapi\fR is set to \fBrtp\fR and
465 \fBbroadcast\fR is actually a multicast address.
468 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
469 Determines how to extract trackname part \fIPART\fR from a
470 track name (with the collection root part removed).
471 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
473 Track names can be different in different contexts.
474 For instance the sort string might include an initial track number,
475 but this would be stripped for the display string.
476 \fICONTEXT\fR should be a glob pattern matching the
477 contexts in which this directive will be used.
479 Valid contexts are \fBsort\fR and \fBdisplay\fR.
481 All the \fBnamepart\fR directives are considered in order.
482 The first directive for the right part, that matches the desired context,
483 and with a \fIREGEXP\fR that
484 matches the track is used, and the value chosen is constructed from
485 \fISUBST\fR according to the substitution rules below.
487 Note that searches use the raw track name and \fBtrackname_\fR preferences but
488 not (currently) the results of \fBnamepart\fR, so generating words via this option
489 that aren't in the original track name will lead to confusing results.
491 If you supply no \fBnamepart\fR directives at all then a default set will be
492 supplied automatically.
493 But if you supply even one then you must supply all of them.
494 The defaults are equivalent to:
497 namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
498 namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
499 namepart album "/([^/]+)/[^/]+$" $1 *
500 namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 *
501 namepart ext "(\\.[a-zA-Z0-9]+)$" $1 *
504 This setting cannot be changed during the lifetime of the server.
506 .B new_bias \fIWEIGHT\fR
507 The weight for new tracks.
508 The default is 450000, i.e. recently added tracks are a fifty times as likely
509 to be picked as normal.
511 New values of this option may be picked up from the configuration file even
514 .B new_bias_age \fISECONDS\fR
515 The maximum age of tracks that \fBnew_bias\fR applies to, in seconds.
516 The default is one week.
518 New values of this option may be picked up from the configuration file even
522 The maximum number of tracks to list when reporting newly noticed tracks.
525 .B nice_rescan \fIPRIORITY\fR
526 Set the recan subprocess priority.
529 (Note that higher values mean the process gets less CPU time; UNIX priority
530 values are backwards.)
532 .B nice_server \fIPRIORITY\fR
533 Set the server priority.
534 This is applied to the server at startup time (and not when you reload
536 The server does not use much CPU itself but this value is inherited
537 by programs it executes.
538 If you have limited CPU then it might help to set this to a small
542 Changes to this value during the lifetime of the server are ignored.
544 .B nice_speaker \fIPRIORITY\fR
545 Set the speaker process priority.
546 This is applied to the speaker process at startup time (and not when
547 you reload the configuration).
548 The speaker process is not massively CPU intensive by today's
549 standards but depends on reasonably timely scheduling.
550 If you have limited CPU then it might help to set this to a small
554 Changes to this value during the lifetime of the server are ignored.
557 The maximum days that a track can survive in the database of newly added
561 .B pause_mode \fIMODE
562 Sets the pause mode for the \fBcommand\fR backend.
563 The possible values are:
567 Send silent (0-value) samples when paused.
571 Stop writing when paused.
574 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR...
575 Specifies the player for files matching the glob \fIPATTERN\fR.
576 \fIMODULE\fR specifies which plugin module to use.
578 The following options are supported:
582 Defines the end of the list of options.
583 Needed if the first argument to the plugin starts with a "\-".
586 The following are the standard modules:
589 .B exec \fICOMMAND\fR \fIARGS\fR...
590 The command is executed via \fBexecvp\fR(3), not via the shell.
591 The \fBPATH\fR environment variable is searched for the executable if it is not
593 The command is expected to know how to open its own sound device.
595 .B execraw \fICOMMAND\fR \fIARGS\fR...
596 Identical to the \fBexec\fR except that the player is expected to use the
597 DisOrder raw player protocol.
598 .BR disorder-decode (8)
599 can decode several common audio file formats to this format.
601 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
602 The command is executed using the shell.
603 If \fISHELL\fR is specified then that is used, otherwise \fBsh\fR will be used.
604 In either case the \fBPATH\fR environment variable is searched for the shell
605 executable if it is not an absolute path.
606 The track name is stored in the environment variable
609 Be careful of the interaction between the configuration file quoting rules and
610 the shell quoting rules.
613 If multiple player commands match a track then the first match is used.
615 For the server to be able to calculate track lengths, there should be a
617 command corresponding to each
623 is used without arguments, the list of players is cleared.
625 Although players can be changed during the lifetime of the server, note that
626 background decoders will not be stopped and restarted using changed
627 configuration once they have been started.
629 .B queue_pad \fICOUNT\fR
630 The target size of the queue.
631 If random play is enabled then randomly picked tracks will be added until
632 the queue is at least this big.
635 If this is reduced during the lifetime of the server, the queue won't be
636 reduced in size to fit; it just won't start growing again until it is under the
638 However, if it is increased, new tracks will start being added immediately.
640 .B reminder_interval \fISECONDS\fR
641 The minimum number of seconds that must elapse between password reminders.
642 The default is 600, i.e. 10 minutes.
644 .B remote_userman yes\fR|\fBno
645 User management over TCP connection is only allowed if this is set to
646 \fByes\fR. By default it is set to \fBno\fR.
648 .B replay_min \fISECONDS\fR
649 The minimum number of seconds that must elapse after a track has been played
650 before it can be picked at random. The default is 8 hours. If this is set to
651 0 then there is no limit, though current \fBdisorder-choose\fR will not pick
652 anything currently listed in the recently-played list.
654 New values of this option may be picked up from the configuration file even
657 .B rtp_always_request yes\fR|\fBno
661 .BR disorder-playrtp (1)
662 will always request a dedicated RTP stream,
663 rather than contacting the server to discover
664 a broadcast or multicast address.
665 (This behaviour can be overridden by
666 setting a suitable address on the command-line.)
670 This option is experimental,
671 and may change or be removed in a future release.
673 .B rtp_maxbuffer \fIFRAMES\fR
675 .BR disorder-playrtp (1)'s
676 buffer size to the given number of
678 If this is zero, then
680 will select a default buffer size.
681 (This setting can be overridden by passing
682 a suitable command-line option.)
686 This option is experimental,
687 and may change or be removed in a future release.
689 .B rtp_minbuffer \fIFRAMES\fR
691 .BR disorder-playrtp (1)'s
692 buffer low-water-mark to the given number of
694 If this is zero, then
696 will select a default low-water-mark.
697 (This setting can be overridden by passing
698 a suitable command-line option.)
700 This option is experimental,
701 and may change or be removed in a future release.
705 This option is experimental, and may change or be removed in a future release.
707 .B rtp_mode \fIMODE\fR
708 The network transmission mode for the \fBrtp\fR backend.
713 Unicast transmission to the address given by \fBbroadcast\fR.
716 Broadcast transmission to the address given by \fBbroadcast\fR.
719 Multicast transmission to the address given by \fBbroadcast\fR.
722 Unicast transmission to addresses requested by clients.
725 Choose one of the above based on the destination address.
726 This is the default, for backwards compatibility reasons.
729 .B rtp_rcvbuf \fISIZE\fR
731 .BR disorder-playrtp (1)'s
732 socket receive buffer to at least
734 (This setting can be overridden by passing
735 a suitable command-line option.)
739 This option is experimental,
740 and may change or be removed in a future release.
742 .B rtp_request_address \fR[\fIFAMILY\fR] \fR[\fIHOST\fR] \fISERVICE\fR
744 .BR disorder-playrtp (1)
745 is to request a unicast RTP stream,
746 then it should establish its receiving socket
747 to listen on the given address.
752 may be omitted, in which case
754 uses heuristics to determine suitable values.
757 may be omitted, in which case
759 uses a kernel-allocated port.
760 (This setting can be overridden by passing
761 a suitable address on the command line.)
764 which uses a heuristically-chosen address and a kernel-allocated port.
766 This option is experimental,
767 and may change or be removed in a future release.
769 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
770 Describes the sample format expected by the \fBspeaker_command\fR (below).
771 The components of the format specification are as follows:
775 The number of bits per sample.
776 Optionally, may be suffixed by \fBb\fR or \fBl\fR for big-endian and
778 If neither is used the native byte order is assumed.
781 The number of samples per second.
784 The number of channels.
791 backend the sample format is forced to
795 backend it is forced to
797 in both cases regardless of what is specified in the configuration file.
801 Defines the signal to be sent to track player process groups when tracks are
803 The default is \fBSIGKILL\fR.
805 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
806 or \fBInterrupted\fR or whatever.
808 .B sox_generation \fB0\fR|\fB1
809 Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if
810 the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1).
811 See the documentation for your installed copy of \fBsox\fR to determine
813 The default is set according to the version of sox found when DisOrder was
815 If you run on a system with a different version of sox, you will need to
818 .B speaker_backend \fINAME
819 This is an alias for \fBapi\fR; see above.
821 .B speaker_command \fICOMMAND
822 Causes the speaker subprocess to pipe audio data into shell command
823 \fICOMMAND\fR, rather than writing to a local sound card.
824 The sample format is determine by
828 Note that if the sample format is wrong then
830 is invoked to translate it.
833 is not installed then this will not work.
835 .B scratch \fIPATH\fR
837 When a track is scratched, a scratch track is played at random.
838 Scratches are played using the same logic as other tracks.
840 At least for the time being, path names of scratches must be encoded using
841 UTF-8 (which means that ASCII will do).
843 If \fBscratch\fR is used without arguments then the list of scratches is
846 .B stopword \fIWORD\fR ...
847 Specifies one or more stopwords that should not take part in searches
850 If \fBstopword\fR is used without arguments then the list of stopwords is
853 There is a default set of stopwords built in, but this option can be used to
854 augment or replace that list.
856 This setting cannot be changed during the lifetime of the server.
858 .B tracklength \fIPATTERN\fR \fIMODULE\fR
859 Specifies the module used to calculate the length of files matching
861 \fIMODULE\fR specifies which plugin module to use.
863 If \fBtracklength\fR is used without arguments then the list of modules is
866 Track lengths are cached in the database, and changing this setting won't cause
867 them to be regenerated.
869 .B user \fIUSERNAME\fR
870 Specifies the user to run as.
871 Only makes sense if invoked as root (or the target user).
873 This setting cannot be changed during the lifetime of the server
874 (and if it is changed with a restart, you will need to adjust file permissions
875 on the server's database).
876 .SS "Client Configuration"
877 These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR
879 \fIpkgconfdir/config.\fRUSERNAME.
881 .B connect \fR[\fIFAMILY\fR] \fIHOST SERVICE\fR
882 Connect to the address specified by \fIHOST\fR and port specified by
885 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
886 implied by \fIHOST\fR.
887 Note that IPv6 is not currently well tested.
889 .B password \fIPASSWORD\fR
892 .B username \fIUSERNAME\fR
894 The default is inferred from the current UID.
895 .SS "Web Interface Configuration"
896 .\" TODO this section is misnamed really...
898 .B mail_sender \fIADDRESS\fR
899 The email address that appears in the From: field of any mail messages sent by
901 This must be set if you have online registration enabled.
903 .B refresh \fISECONDS\fR
904 Specifies the maximum refresh period in seconds.
905 The refresh period is the time after which the web interface's queue and manage
906 pages will automatically reload themselves.
909 .B refresh_min \fISECONDS\fR
910 Specifies the minimum refresh period in seconds.
913 .B sendmail \fIPATH\fR
914 The path to the Sendmail executable.
915 This must support the \fB-bs\fR option (Postfix, Exim and Sendmail should all
917 The default is the sendmail executable found at compile time.
919 .B short_display \fICHARACTERS\fR
920 Defines the maximum number of characters to include in a \fBshort\fR name
924 .B smtp_server \fIHOSTNAME\fR
925 The hostname (or address) of the SMTP server to use for sending mail.
926 The default is 127.0.0.1.
927 If \fBsendmail\fR is set then that is used instead.
929 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
930 Determines how names are sorted and displayed in track choice displays.
932 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
933 \fBdir\fR but you can define your own.
935 \fICONTEXT\fR is a glob pattern matching the context.
936 Standard contexts are \fBsort\fR (which determines how directory names
937 are sorted) and \fBdisplay\fR (which determines how they are displayed).
938 Again, you can define your own.
940 All the \fBtransform\fR directives are considered in order.
941 If the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
942 then a new track name is constructed from
943 \fISUBST\fR according to the substitution rules below.
944 If several match then each is executed in order.
946 If you supply no \fBtransform\fR directives at all then a default set will be
947 supplied automatically.
948 But if you supply even one then you must supply all of them.
952 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
953 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
954 transform dir "^.*/([^/]+)$" $1 *
955 transform dir "^(the) ([^/]*)" "$2 $1" sort i
956 transform dir "[[:punct:]]" "" sort g
960 Specifies the URL of the web interface.
961 This URL will be used in generated web pages.
962 The default is inferred at runtime, so this option no
963 longer needs to be specified.
965 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
966 \fB/cgi-bin/jukebox\fR.
967 .SH "REGEXP SUBSTITUTION RULES"
968 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3).
969 The only option used is \fBPCRE_UTF8\fR.
970 Remember that the configuration file syntax means you have to
971 escape backslashes and quotes inside quoted strings.
973 In a \fISUBST\fR string the following sequences are interpreted
977 These expand to the first to ninth bracketed subexpression.
980 This expands to the matched part of the subject string.
983 This expands to a single \fB$\fR symbol.
985 All other pairs starting with \fB$\fR are undefined (and might be used
986 for something else in the future, so don't rely on the current
989 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent.
990 If \fBg\fR is present then all matches are replaced, otherwise only the first
992 .SH "TRACK NAME PARTS"
993 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
994 with the obvious intended meaning.
995 These are controlled by configuration and by \fBtrackname_\fR preferences.
997 In addition there are two built-in parts, \fBpath\fR which is the whole path
998 name and \fBext\fR which is the filename extension, including the initial dot
999 (or the empty string if there is not extension).
1001 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8),
1002 \fBpcrepattern\fR(3), \fBdisorder_templates\fR(5), \fBdisorder_actions\fR(5),
1003 \fBdisorder.cgi\fR(8), \fBdisorder_preferences\fR(5)
1004 .\" Local Variables:
~mdw / disorder / blob