2 .\" Copyright (C) 2004-2009 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 contorl 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:
329 Output level for the audio device.
330 This is probably what you want and is the default.
333 Output level for the PC speaker, if that is connected to the sound card.
336 Output level for alternative codec device.
340 The OSS documentation recommends against using this, as it affects all
344 You can also specify channels by number, if you know the right value.
346 For \fBapi alsa\fR, this is the name of the mixer control to use.
347 The default is \fBPCM\fR.
348 Use \fBamixer scontrols\fR or similar to get a full list.
350 For \fBapi coreaudio\fR, volume setting is not currently supported.
352 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
354 .B collection \fIMODULE\fR \fIROOT\fR
356 .B collection \fIROOT\fR
357 Define a collection of tracks.
359 \fIMODULE\fR defines which plugin module should be used for this
361 Use the supplied \fBfs\fR module for tracks that exist as ordinary
362 files in the filesystem.
363 If no \fIMODULE\fR is specified then \fBfs\fR is assumed.
365 \fIENCODING\fR defines the encoding of filenames in this collection.
366 For \fBfs\fR this would be the encoding you use for filenames.
367 Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR.
368 If no encoding is specified then the current locale's character encoding
371 NB that this default depends on the locale the server runs in, which is not
372 necessarily the same as that of ordinary users, depending how the system is
374 It's best to explicitly specify it to be certain.
376 \fIROOT\fR is the root in the filesystem of the filenames and is
377 passed to the plugin module.
378 It must be an absolute path and should not end with a "/".
380 .B cookie_key_lifetime \fISECONDS\fR
381 Lifetime of the signing key used in constructing cookies. The default is one
384 If this is changed during the lifetime of the server, the current key doesn't
385 hvave its lifetime retroactively changed.
387 .B cookie_login_lifetime \fISECONDS\fR
388 Lifetime of a cookie enforced by the server. When the cookie expires the user
389 will have to log in again even if their browser has remembered the cookie that
390 long. The default is one day.
392 If this is changed during the lifetime of the server, cookies that have already
393 een generated don't hvave their lifetime retroactively changed.
395 .B default_rights \fIRIGHTS\fR
396 Defines the set of rights given to new users.
397 The argument is a comma-separated list of rights.
398 For the possible values see
399 .B "Users And Access Control"
402 The default is to allow everything except \fBadmin\fR and \fBregister\fR
403 (modified in legacy configurations by the obsolete \fBrestrict\fR directive).
408 For \fBapi oss\fR this is the path to the device to use.
409 If it is set to \fBdefault\fR then \fI/dev/dsp\fR and \fI/dev/audio\fR
412 For \fBapi alsa\fR this is the device name to use.
414 For \fBapi coreaudio\fR this can be either the UID or the human-readable
415 name of the desired device.
416 For a list of names, visit System Preferences -> Sound and look at the Type column.
417 For example, you might use "Built-in Output" for the built-in speaker
418 or "Built-in Line Output" if you have connected external speakers.
419 Remember to quote the name.
421 The default is \fBdefault\fR, which is intended to map to whatever the system's
425 This option no longer does anything and will be removed in a future version.
427 .B history \fIINTEGER\fR
428 Specifies the number of recently played tracks to remember (including
429 failed tracks and scratches).
431 If this is changed during the lifetime of the server, it won't actually reduce
432 the size of the list until it is next modified.
434 .B listen \fR[\fIFAMILY\fR] \fR[\fIHOST\fR] \fISERVICE\fR
435 Listen for connections on the address specified by \fIHOST\fR and port
436 specified by \fISERVICE\fR.
437 If \fIHOST\fR is omitted, or is \fB*\fR, then listens on all local addresses.
439 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
440 implied by \fIHOST\fR.
441 Note that IPv6 is not currently well tested.
443 Normally the server only listens on a UNIX domain socket.
446 This option no longer does anything and will be removed in a future version.
448 .B mixer \fIDEVICE\fR
449 The mixer device name, if it needs to be specified separately from
452 For \fBapi oss\fR this should be the path to the mixer device and the default
455 For \fBapi alsa\fR, this is the index of the mixer control to use.
458 For \fBapi coreaudio\fR, volume setting is not currently supported.
460 .B multicast_loop yes\fR|\fBno
461 Determines whether multicast packets are loop backed to the sending host.
462 The default is \fByes\fR.
463 This only applies if \fBapi\fR is set to \fBrtp\fR and \fBbroadcast\fR
464 is actually a multicast address.
466 .B multicast_ttl \fIHOPS\fR
467 Set the maximum number of hops to send multicast packets.
468 This only applies if \fBapi\fR is set to \fBrtp\fR and
469 \fBbroadcast\fR is actually a multicast address.
472 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
473 Determines how to extract trackname part \fIPART\fR from a
474 track name (with the collection root part removed).
475 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
477 Track names can be different in different contexts.
478 For instance the sort string might include an initial track number,
479 but this would be stripped for the display string.
480 \fICONTEXT\fR should be a glob pattern matching the
481 contexts in which this directive will be used.
483 Valid contexts are \fBsort\fR and \fBdisplay\fR.
485 All the \fBnamepart\fR directives are considered in order.
486 The first directive for the right part, that matches the desired context,
487 and with a \fIREGEXP\fR that
488 matches the track is used, and the value chosen is constructed from
489 \fISUBST\fR according to the substitution rules below.
491 Note that searches use the raw track name and \fBtrackname_\fR preferences but
492 not (currently) the results of \fBnamepart\fR, so generating words via this option
493 that aren't in the original track name will lead to confusing results.
495 If you supply no \fBnamepart\fR directives at all then a default set will be
496 supplied automatically.
497 But if you supply even one then you must supply all of them.
498 The defaults are equivalent to:
501 namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
502 namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
503 namepart album "/([^/]+)/[^/]+$" $1 *
504 namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 *
505 namepart ext "(\\.[a-zA-Z0-9]+)$" $1 *
508 This setting cannot be changed during the lifetime of the server.
510 .B new_bias \fIWEIGHT\fR
511 The weight for new tracks.
512 The default is 450000, i.e. recently added tracks are a fifty times as likely
513 to be picked as normal.
515 New values of this option may be picked up from the configuration file even
518 .B new_bias_age \fISECONDS\fR
519 The maximum age of tracks that \fBnew_bias\fR applies to, in seconds.
520 The default is one week.
522 New values of this option may be picked up from the configuration file even
526 The maximum number of tracks to list when reporting newly noticed tracks.
529 .B nice_rescan \fIPRIORITY\fR
530 Set the recan subprocess priority.
533 (Note that higher values mean the process gets less CPU time; UNIX priority
534 values are backwards.)
536 .B nice_server \fIPRIORITY\fR
537 Set the server priority.
538 This is applied to the server at startup time (and not when you reload
540 The server does not use much CPU itself but this value is inherited
541 by programs it executes.
542 If you have limited CPU then it might help to set this to a small
546 Changes to this value during the lifetime of the server are ignored.
548 .B nice_speaker \fIPRIORITY\fR
549 Set the speaker process priority.
550 This is applied to the speaker process at startup time (and not when
551 you reload the configuration).
552 The speaker process is not massively CPU intensive by today's
553 standards but depends on reasonably timely scheduling.
554 If you have limited CPU then it might help to set this to a small
558 Changes to this value during the lifetime of the server are ignored.
561 The maximum days that a track can survive in the database of newly added
565 .B pause_mode \fIMODE
566 Sets the pause mode for the \fBcommand\fR backend.
567 The possible values are:
571 Send silent (0-value) samples when paused.
575 Stop writing when paused.
578 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR...
579 Specifies the player for files matching the glob \fIPATTERN\fR.
580 \fIMODULE\fR specifies which plugin module to use.
582 The following options are supported:
585 .B \-\-wait\-for\-device\fR[\fB=\fIDEVICE\fR]
586 \fBThis option is deprecated\fR.
587 If you want gapless play use raw-format players and the speaker process instead.
588 (This the default in any case.)
590 Waits (for up to a couple of seconds) for the default, or specified, libao
591 device to become openable.
594 Defines the end of the list of options.
595 Needed if the first argument to the plugin starts with a "\-".
598 The following are the standard modules:
601 .B exec \fICOMMAND\fR \fIARGS\fR...
602 The command is executed via \fBexecvp\fR(3), not via the shell.
603 The \fBPATH\fR environment variable is searched for the executable if it is not
605 The command is expected to know how to open its own sound device.
607 .B execraw \fICOMMAND\fR \fIARGS\fR...
608 Identical to the \fBexec\fR except that the player is expected to use the
609 DisOrder raw player protocol.
610 .BR disorder-decode (8)
611 can decode several common audio file formats to this format.
613 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
614 The command is executed using the shell.
615 If \fISHELL\fR is specified then that is used, otherwise \fBsh\fR will be used.
616 In either case the \fBPATH\fR environment variable is searched for the shell
617 executable if it is not an absolute path.
618 The track name is stored in the environment variable
621 Be careful of the interaction between the configuration file quoting rules and
622 the shell quoting rules.
625 If multiple player commands match a track then the first match is used.
627 For the server to be able to calculate track lengths, there should be a
629 command corresponding to each
635 is used without arguments, the list of players is cleared.
637 Although players can be changed during the lifetime of the server, note that
638 background decoders will not be stopped and restarted using changed
639 configuration once they have been started.
641 .B prefsync \fISECONDS\fR
642 This option no longer does anything and will be removed in a future version.
644 .B queue_pad \fICOUNT\fR
645 The target size of the queue.
646 If random play is enabled then randomly picked tracks will be added until
647 the queue is at least this big.
650 If this is reduced during the lifetime of the server, the queue won't be
651 reduced in size to fit; it just won't start growing again until it is under the
653 However, if it is increased, new tracks will start being added immediately.
655 .B reminder_interval \fISECONDS\fR
656 The minimum number of seconds that must elapse between password reminders.
657 The default is 600, i.e. 10 minutes.
659 .B remote_userman yes\fR|\fBno
660 User management over TCP connection is only allowed if this is set to
661 \fByes\fR. By default it is set to \fBno\fR.
663 .B replay_min \fISECONDS\fR
664 The minimum number of seconds that must elapse after a track has been played
665 before it can be picked at random. The default is 8 hours. If this is set to
666 0 then there is no limit, though current \fBdisorder-choose\fR will not pick
667 anything currently listed in the recently-played list.
669 New values of this option may be picked up from the configuration file even
672 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
673 Describes the sample format expected by the \fBspeaker_command\fR (below).
674 The components of the format specification are as follows:
678 The number of bits per sample.
679 Optionally, may be suffixed by \fBb\fR or \fBl\fR for big-endian and
681 If neither is used the native byte order is assumed.
684 The number of samples per second.
687 The number of channels.
694 backend the sample format is forced to
698 backend it is forced to
700 in both cases regardless of what is specified in the configuration file.
704 Defines the signal to be sent to track player process groups when tracks are
706 The default is \fBSIGKILL\fR.
708 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
709 or \fBInterrupted\fR or whatever.
711 .B sox_generation \fB0\fR|\fB1
712 Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if
713 the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1).
714 See the documentation for your installed copy of \fBsox\fR to determine
716 The default is set according to the version of sox found when DisOrder was
718 If you run on a system with a different version of sox, you will need to
721 .B speaker_backend \fINAME
722 This is an alias for \fBapi\fR; see above.
724 .B speaker_command \fICOMMAND
725 Causes the speaker subprocess to pipe audio data into shell command
726 \fICOMMAND\fR, rather than writing to a local sound card.
727 The sample format is determine by
731 Note that if the sample format is wrong then
733 is invoked to translate it.
736 is not installed then this will not work.
738 .B scratch \fIPATH\fR
740 When a track is scratched, a scratch track is played at random.
741 Scratches are played using the same logic as other tracks.
743 At least for the time being, path names of scratches must be encoded using
744 UTF-8 (which means that ASCII will do).
746 If \fBscratch\fR is used without arguments then the list of scratches is
749 .B stopword \fIWORD\fR ...
750 Specifies one or more stopwords that should not take part in searches
753 If \fBstopword\fR is used without arguments then the list of stopwords is
756 There is a default set of stopwords built in, but this option can be used to
757 augment or replace that list.
759 This setting cannot be changed during the lifetime of the server.
761 .B tracklength \fIPATTERN\fR \fIMODULE\fR
762 Specifies the module used to calculate the length of files matching
764 \fIMODULE\fR specifies which plugin module to use.
766 If \fBtracklength\fR is used without arguments then the list of modules is
769 Track lengths are cached in the database, and changing this setting won't cause
770 them to be regenerated.
772 .B user \fIUSERNAME\fR
773 Specifies the user to run as.
774 Only makes sense if invoked as root (or the target user).
776 This setting cannot be changed during the lifetime of the server
777 (and if it is changed with a restart, you will need to adjust file permissions
778 on the server's database).
779 .SS "Client Configuration"
780 These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR
782 \fIpkgconfdir/config.\fRUSERNAME.
784 .B connect \fR[\fIFAMILY\fR] \fIHOST SERVICE\fR
785 Connect to the address specified by \fIHOST\fR and port specified by
788 \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
789 implied by \fIHOST\fR.
790 Note that IPv6 is not currently well tested.
792 .B password \fIPASSWORD\fR
795 .B username \fIUSERNAME\fR
797 The default is inferred from the current UID.
798 .SS "Web Interface Configuration"
799 .\" TODO this section is misnamed really...
801 .B mail_sender \fIADDRESS\fR
802 The email address that appears in the From: field of any mail messages sent by
804 This must be set if you have online registration enabled.
806 .B refresh \fISECONDS\fR
807 Specifies the maximum refresh period in seconds.
808 The refresh period is the time after which the web interface's queue and manage
809 pages will automatically reload themselves.
812 .B refresh_min \fISECONDS\fR
813 Specifies the minimum refresh period in seconds.
816 .B sendmail \fIPATH\fR
817 The path to the Sendmail executable.
818 This must support the \fB-bs\fR option (Postfix, Exim and Sendmail should all
820 The default is the sendmail executable found at compile time.
822 .B short_display \fICHARACTERS\fR
823 Defines the maximum number of characters to include in a \fBshort\fR name
827 .B smtp_server \fIHOSTNAME\fR
828 The hostname (or address) of the SMTP server to use for sending mail.
829 The default is 127.0.0.1.
830 If \fBsendmail\fR is set then that is used instead.
832 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
833 Determines how names are sorted and displayed in track choice displays.
835 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
836 \fBdir\fR but you can define your own.
838 \fICONTEXT\fR is a glob pattern matching the context.
839 Standard contexts are \fBsort\fR (which determines how directory names
840 are sorted) and \fBdisplay\fR (which determines how they are displayed).
841 Again, you can define your own.
843 All the \fBtransform\fR directives are considered in order.
844 If the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
845 then a new track name is constructed from
846 \fISUBST\fR according to the substitution rules below.
847 If several match then each is executed in order.
849 If you supply no \fBtransform\fR directives at all then a default set will be
850 supplied automatically.
851 But if you supply even one then you must supply all of them.
855 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
856 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
857 transform dir "^.*/([^/]+)$" $1 *
858 transform dir "^(the) ([^/]*)" "$2 $1" sort i
859 transform dir "[[:punct:]]" "" sort g
863 Specifies the URL of the web interface.
864 This URL will be used in generated web pages.
865 The default is inferred at runtime, so this option no
866 longer needs to be specified.
868 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
869 \fB/cgi-bin/jukebox\fR.
870 .SH "REGEXP SUBSTITUTION RULES"
871 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3).
872 The only option used is \fBPCRE_UTF8\fR.
873 Remember that the configuration file syntax means you have to
874 escape backslashes and quotes inside quoted strings.
876 In a \fISUBST\fR string the following sequences are interpreted
880 These expand to the first to ninth bracketed subexpression.
883 This expands to the matched part of the subject string.
886 This expands to a single \fB$\fR symbol.
888 All other pairs starting with \fB$\fR are undefined (and might be used
889 for something else in the future, so don't rely on the current
892 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent.
893 If \fBg\fR is present then all matches are replaced, otherwise only the first
895 .SH "TRACK NAME PARTS"
896 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
897 with the obvious intended meaning.
898 These are controlled by configuration and by \fBtrackname_\fR preferences.
900 In addition there are two built-in parts, \fBpath\fR which is the whole path
901 name and \fBext\fR which is the filename extension, including the initial dot
902 (or the empty string if there is not extension).
904 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8),
905 \fBpcrepattern\fR(3), \fBdisorder_templates\fR(5), \fBdisorder_actions\fR(5),
906 \fBdisorder.cgi\fR(8), \fBdisorder_preferences\fR(5)
~mdw / disorder / blob