2 .\" Copyright (C) 2004-2008 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 2 of the License, or
7 .\" (at your option) any later version.
9 .\" This program is distributed in the hope that it will be useful, but
10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 .\" 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, write to the Free Software
16 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 pkgconfdir/config - DisOrder jukebox configuration
23 The purpose of DisOrder is to organize and play digital audio files, under the
24 control of multiple users.
25 \fIpkgconfdir/config\fR is the primary configuration file; the web interface
26 uses a number of others (see \fBdisorder.cgi\fR(8)).
28 DisOrder can be configured with multiple collections of tracks, indexing them
29 by their filename, and picking players on the basis of filename patterns (for
32 Although the model is of filenames, it is not inherent that there are
33 corresponding real files - merely that they can be interpreted by the chosen
35 See \fBdisorder\fR(3) for more details about this.
37 Each track can have a set of preferences associated with it.
38 These are simple key-value pairs; they can be used for anything you
39 like, but a number of keys have specific meanings.
40 See \fBdisorder\fR(1) for more details about these.
42 Track names are derived from filenames under the control of regular
43 expressions, rather than attempting to interpret format-specific embedded name
45 They can be overridden by setting preferences.
47 Names for display are distinguished from names for sorting, so with the right
48 underlying filenames an album can be displayed in its original order even if
49 the displayed track titles are not lexically sorted.
51 A collection of global preferences define various bits of server state: whether
52 random play is enabled, what tags to check for when picking at random, etc.
53 .SS "Users And Access Control"
54 DisOrder distinguishes between multiple users.
55 This is for access control and reporting, not to provide different
56 views of the world: i.e. preferences and so on are global.
58 Each user has an associated set of rights which contorl which commands they may
60 Normally you would give all users most rights, and expect them to
61 cooperate (they are after all presumed to be in a shared sound environment).
63 The full set of rights are:
66 User can perform read-only operations
69 User can add tracks to the queue
72 User can move any track
75 User can move their own tracks
78 User can move randomly chosen tracks
81 User can remove any track
84 User can remove their own tracks
87 User can remove randomly chosen tracks
90 User can scratch any track
93 User can scratch their own tracks
96 User can scratch randomly chosen tracks
99 User can change the volume
102 User can perform admin operations
105 User can initiate a rescan
108 User can register new users.
111 user would have this right.
114 User can edit their own userinfo
117 User can modify track preferences
120 User can modify global preferences
123 User can pause/resume
125 Access control is entirely used-based.
126 If you configure DisOrder to listen for TCP/IP connections then it will
127 accept a connection from anywhere provided the right password is
129 Passwords are never transmitted over TCP/IP connections in clear,
130 but everything else is.
131 The expected model is that host-based access control is imposed at
134 The web interface is controlled by a collection of template files, one for each
135 kind of page, and a collection of option files.
136 These are split up and separate from the main configuration file to
138 See \fBdisorder.cgi\fR(8) for more information.
139 .SS "Searching And Tags"
140 Search strings contain a list of search terms separated by spaces.
141 A search term can either be a single word or a tag, prefixed with "tag:".
143 Search words are compared without regard to letter case or accents; thus, all
144 of the following will be considered to be equal to one another:
147 LATIN CAPITAL LETTER E
149 LATIN CAPITAL LETTER E WITH GRAVE
150 LATIN SMALL LETTER E WITH GRAVE
151 LATIN CAPITAL LETTER E plus COMBINING GRAVE ACCENT
152 LATIN SMALL LETTER E plus COMBINING GRAVE ACCENT
155 The same rules apply to tags but in addition leading and trailing whitespace is
156 disregarded and all whitespace sequences are treated as equal when they appear
157 as internal whitespace.
159 Where several tags are listed, for instance the tags preference for a track,
160 the tags are separated by commas.
161 Therefore tags may not contain commas.
162 .SH "CONFIGURATION FILE"
164 Lines are split into fields separated by whitespace (space, tab, line
165 feed, carriage return, form feed).
166 Comments are started by the number sign ("#").
168 Fields may be unquoted (in which case they may not contain spaces and
169 may not start with a quotation mark or apostrophe) or quoted by either
170 quotation marks or apostrophes.
171 Inside quoted fields every character stands for itself, except that
172 a backslash can only appear as part of one of the following escape sequences:
187 No other escape sequences are allowed.
189 Within any line the first field is a configuration command and any
190 further fields are parameters.
191 Lines with no fields are ignored.
193 After editing the config file use \fBdisorder reconfigure\fR to make
195 If there is anything wrong with it the daemon will record a log
196 message and ignore the new config file.
197 (You should fix it before next terminating and restarting the daemon,
198 as it cannot start up without a valid config file.)
199 .SS "Configuration Files"
200 Configuration files are read in the following order:
204 .I pkgconfdir/config.private
205 Should be readable only by the jukebox group.
206 Not really useful any more and will be abolished in future.
208 .I ~\fRUSERNAME\fI/.disorder/passwd
209 Per-user client configuration.
210 Optional but if it exists must be readable only by the relevant user.
211 Would normally contain a \fBpassword\fR directive.
213 .I pkgconfdir/config.\fRUSERNAME
214 Per-user system-controlled client configuration.
215 Optional but if it exists must be readable only by the relevant user.
216 Would normally contain a \fBpassword\fR directive.
218 The prefererred location for per-user passwords is \fI~/.disorder/passwd\fR and
219 \fBdisorder authorize\fR writes there now.
220 .SS "Global Configuration"
222 .B home \fIDIRECTORY\fR
223 The home directory for state files.
226 The server will create this directory on startup if it does not exist.
228 .B plugins \fIPATH\fR
229 Adds a directory to the plugin path.
230 (This is also used by the web interface.)
232 Plugins are opened the first time they are required and never after,
233 so after changing a plugin you must restart the server before it is
234 guaranteed to take effect.
238 is used without arguments the plugin path is cleared.
239 .SS "Server Configuration"
241 .B alias \fIPATTERN\fR
242 Defines the pattern use construct virtual filenames from \fBtrackname_\fR
245 Most characters stand for themselves, the exception being \fB{\fR which is used
246 to insert a track name part in the form \fB{\fIname\fB}\fR or
249 The difference is that the first form just inserts the name part while the
250 second prefixes it with a \fB/\fR if it is nonempty.
252 The pattern should not attempt to include the collection root, which is
253 automatically included, but should include the proper extension.
255 The default is \fB{/artist}{/album}{/title}{ext}\fR.
258 Selects the backend used to play sound and to set the volume.
259 The following options are available:
264 This is only available on Linux systems, on which it is the default.
267 Use Apple Core Audio.
268 This only available on OS X systems, on which it is the default.
271 Use the OSS (/dev/dsp) API.
272 Not available on all platforms.
276 This is the default if
278 is specified, or if no native is available.
281 Transmit audio over the network.
282 This is the default if \fBbroadcast\fR is specified.
284 .BR disorder-playrtp (1)
285 to receive and play the resulting stream on Linux and OS X.
288 .B authorization_algorithm \fIALGORITHM\fR
289 Defines the algorithm used to authenticate clients.
290 The valid options are sha1 (the default), sha256, sha384 and sha512.
292 .BR disorder_protocol (5)
295 .B broadcast \fIADDRESS\fR \fIPORT\fR
296 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.
297 This implies \fBapi network\fR.
299 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
301 .B broadcast_from \fIADDRESS\fR \fIPORT\fR
302 Sets the (local) source address used by \fBbroadcast\fR.
304 .B channel \fICHANNEL\fR
305 The mixer channel that the volume control should use.
307 For \fBapi oss\fR the possible values are:
311 Output level for the audio device.
312 This is probably what you want and is the default.
315 Output level for the PC speaker, if that is connected to the sound card.
318 Output level for alternative codec device.
322 The OSS documentation recommends against using this, as it affects all
326 You can also specify channels by number, if you know the right value.
328 For \fBapi alsa\fR, this is the name of the mixer control to use.
329 The default is \fBPCM\fR.
330 Use \fBamixer scontrols\fR or similar to get a full list.
332 For \fBapi coreaudio\fR, volume setting is not currently supported.
334 .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
336 .B collection \fIMODULE\fR \fIROOT\fR
338 .B collection \fIROOT\fR
339 Define a collection of tracks.
341 \fIMODULE\fR defines which plugin module should be used for this
343 Use the supplied \fBfs\fR module for tracks that exist as ordinary
344 files in the filesystem.
345 If no \fIMODULE\fR is specified then \fBfs\fR is assumed.
347 \fIENCODING\fR defines the encoding of filenames in this collection.
348 For \fBfs\fR this would be the encoding you use for filenames.
349 Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR.
350 If no encoding is specified then the current locale's character encoding
353 NB that this default depends on the locale the server runs in, which is not
354 necessarily the same as that of ordinary users, depending how the system is
356 It's best to explicitly specify it to be certain.
358 \fIROOT\fR is the root in the filesystem of the filenames and is
359 passed to the plugin module.
360 It must be an absolute path and should not end with a "/".
362 .B cookie_key_lifetime \fISECONDS\fR
363 Lifetime of the signing key used in constructing cookies. The default is one
366 .B cookie_login_lifetime \fISECONDS\fR
367 Lifetime of a cookie enforced by the server. When the cookie expires the user
368 will have to log in again even if their browser has remembered the cookie that
369 long. The default is one day.
371 .B default_rights \fIRIGHTS\fR
372 Defines the set of rights given to new users.
373 The argument is a comma-separated list of rights.
374 For the possible values see
375 .B "Users And Access Control"
378 The default is to allow everything except \fBadmin\fR and \fBregister\fR
379 (modified in legacy configurations by the obsolete \fBrestrict\fR directive).
384 For \fBapi oss\fR this is the path to the device to use.
385 If it is set to \fBdefault\fR then \fI/dev/dsp\fR and \fI/dev/audio\fR
388 For \fBapi alsa\fR this is the device name to use.
390 For \fBapi coreaudio\fR this is currently ignored.
392 The default is \fBdefault\fR, which is intended to map to whatever the system's
396 Specifies the number of seconds to leave between tracks.
399 NB this option currently DOES NOT WORK. If there is genuine demand it might be
402 .B history \fIINTEGER\fR
403 Specifies the number of recently played tracks to remember (including
404 failed tracks and scratches).
406 .B listen \fR[\fIHOST\fR] \fISERVICE\fR
407 Listen for connections on the address specified by \fIHOST\fR and port
408 specified by \fISERVICE\fR.
409 If \fIHOST\fR is omitted then listens on all local addresses.
411 Normally the server only listens on a UNIX domain socket.
414 Determines whether the server locks against concurrent operation.
415 Default is \fByes\fR.
416 There is no good reason to set this to \fBno\fR and the option will
417 probably be removed in a future version.
419 .B mixer \fIDEVICE\fR
420 The mixer device name, if it needs to be specified separately from
423 For \fBapi oss\fR this should be the path to the mixer device and the default
426 For \fBapi alsa\fR, this is the index of the mixer control to use.
429 For \fBapi coreaudio\fR, volume setting is not currently supported.
431 .B multicast_loop yes\fR|\fBno
432 Determines whether multicast packets are loop backed to the sending host.
433 The default is \fByes\fR.
434 This only applies if \fBapi\fR is set to \fBnetwork\fR and \fBbroadcast\fR
435 is actually a multicast address.
437 .B multicast_ttl \fIHOPS\fR
438 Set the maximum number of hops to send multicast packets.
439 This only applies if \fBapi\fR is set to \fBnetwork\fR and
440 \fBbroadcast\fR is actually a multicast address.
443 .B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
444 Determines how to extract trackname part \fIPART\fR from a
445 track name (with the collection root part removed).
446 Used in \fB@recent@\fR, \fB@playing@\fR and \fB@search@\fR.
448 Track names can be different in different contexts.
449 For instance the sort string might include an initial track number,
450 but this would be stripped for the display string.
451 \fICONTEXT\fR should be a glob pattern matching the
452 contexts in which this directive will be used.
454 Valid contexts are \fBsort\fR and \fBdisplay\fR.
456 All the \fBnamepart\fR directives are considered in order.
457 The first directive for the right part, that matches the desired context,
458 and with a \fIREGEXP\fR that
459 matches the track is used, and the value chosen is constructed from
460 \fISUBST\fR according to the substitution rules below.
462 Note that searches use the raw track name and \fBtrackname_\fR preferences but
463 not (currently) the results of \fBnamepart\fR, so generating words via this option
464 that aren't in the original track name will lead to confusing results.
466 If you supply no \fBnamepart\fR directives at all then a default set will be
467 supplied automatically.
468 But if you supply even one then you must supply all of them.
469 The defaults are equivalent to:
472 namepart title "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
473 namepart title "/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
474 namepart album "/([^/]+)/[^/]+$" $1 *
475 namepart artist "/([^/]+)/[^/]+/[^/]+$" $1 *
476 namepart ext "(\\.[a-zA-Z0-9]+)$" $1 *
479 .B new_bias \fIWEIGHT\fR
480 The weight for new tracks.
481 The default is 900000, i.e. recently added tracks are a hundred times as likely
482 to be picked as normal.
484 .B new_bias_age \fISECONDS\fR
485 The maximum age of tracks that \fBnew_bias\fR applies to, in seconds.
486 The default is one week.
489 The maximum number of tracks to list when reporting newly noticed tracks.
492 .B nice_rescan \fIPRIORITY\fR
493 Set the recan subprocess priority.
496 (Note that higher values mean the process gets less CPU time; UNIX priority
497 values are backwards.)
499 .B nice_server \fIPRIORITY\fR
500 Set the server priority.
501 This is applied to the server at startup time (and not when you reload
503 The server does not use much CPU itself but this value is inherited
504 by programs it executes.
505 If you have limited CPU then it might help to set this to a small
509 .B nice_speaker \fIPRIORITY\fR
510 Set the speaker process priority.
511 This is applied to the speaker process at startup time (and not when
512 you reload the configuration).
513 The speaker process is not massively CPU intensive by today's
514 standards but depends on reasonably timely scheduling.
515 If you have limited CPU then it might help to set this to a small
520 The maximum days that a track can survive in the database of newly added
524 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR...
525 Specifies the player for files matching the glob \fIPATTERN\fR.
526 \fIMODULE\fR specifies which plugin module to use.
528 The following options are supported:
531 .B \-\-wait\-for\-device\fR[\fB=\fIDEVICE\fR]
532 Waits (for up to a couple of seconds) for the default, or specified, libao
533 device to become openable.
536 Defines the end of the list of options.
537 Needed if the first argument to the plugin starts with a "\-".
540 The following are the standard modules:
543 .B exec \fICOMMAND\fR \fIARGS\fR...
544 The command is executed via \fBexecvp\fR(3), not via the shell.
545 The \fBPATH\fR environment variable is searched for the executable if it is not
547 The command is expected to know how to open its own sound device.
549 .B execraw \fICOMMAND\fR \fIARGS\fR...
550 Identical to the \fBexec\fR except that the player is expected to use the
551 DisOrder raw player protocol.
552 .BR disorder-decode (8)
553 can decode several common audio file formats to this format.
554 If your favourite format is not supported, but you have a player
555 which uses libao, there is also a libao driver which supports this format;
556 see below for more information about this.
558 .B shell \fR[\fISHELL\fR] \fICOMMAND\fR
559 The command is executed using the shell.
560 If \fISHELL\fR is specified then that is used, otherwise \fBsh\fR will be used.
561 In either case the \fBPATH\fR environment variable is searched for the shell
562 executable if it is not an absolute path.
563 The track name is stored in the environment variable
566 Be careful of the interaction between the configuration file quoting rules and
567 the shell quoting rules.
570 If multiple player commands match a track then the first match is used.
572 For the server to be able to calculate track lengths, there should be a
574 command corresponding to each
580 is used without arguments, the list of players is cleared.
582 .B prefsync \fISECONDS\fR
583 The interval at which the preferences log file will be synchronised.
584 Defaults to 3600, i.e. one hour.
586 .B queue_pad \fICOUNT\fR
587 The target size of the queue.
588 If random play is enabled then randomly picked tracks will be added until
589 the queue is at least this big.
592 .B reminder_interval \fISECONDS\fR
593 The minimum number of seconds that must elapse between password reminders.
594 The default is 600, i.e. 10 minutes.
596 .B remote_userman yes\fR|\fBno
597 User management over TCP connection is only allowed if this is set to
598 \fByes\fR. By default it is set to \fBno\fR.
600 .B replay_min \fISECONDS\fR
601 The minimum number of seconds that must elapse after a track has been played
602 before it can be picked at random. The default is 8 hours. If this is set to
603 0 then there is no limit, though current \fBdisorder-choose\fR will not pick
604 anything currently listed in the recently-played list.
606 .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS
607 Describes the sample format expected by the \fBspeaker_command\fR (below).
608 The components of the format specification are as follows:
612 The number of bits per sample.
613 Optionally, may be suffixed by \fBb\fR or \fBl\fR for big-endian and
615 If neither is used the native byte order is assumed.
618 The number of samples per second.
621 The number of channels.
628 backend the sample format is forced to
632 backend it is forced to
634 in both cases regardless of what is specified in the configuration file.
638 Defines the signal to be sent to track player process groups when tracks are
640 The default is \fBSIGKILL\fR.
642 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
643 or \fBInterrupted\fR or whatever.
645 .B sox_generation \fB0\fR|\fB1
646 Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if
647 the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1).
648 See the documentation for your installed copy of \fBsox\fR to determine
652 .B speaker_backend \fINAME
653 This is an alias for \fBapi\fR; see above.
655 .B speaker_command \fICOMMAND
656 Causes the speaker subprocess to pipe audio data into shell command
657 \fICOMMAND\fR, rather than writing to a local sound card.
658 The sample format is determine by
662 Note that if the sample format is wrong then
664 is invoked to translate it.
667 is not installed then this will not work.
669 .B scratch \fIPATH\fR
671 When a track is scratched, a scratch track is played at random.
672 Scratches are played using the same logic as other tracks.
674 At least for the time being, path names of scratches must be encoded using
675 UTF-8 (which means that ASCII will do).
677 If \fBscratch\fR is used without arguments then the list of scratches is
680 .B stopword \fIWORD\fR ...
681 Specifies one or more stopwords that should not take part in searches
684 If \fBstopword\fR is used without arguments then the list of stopwords is
687 There is a default set of stopwords built in, but this option can be used to
688 augment or replace that list.
690 .B tracklength \fIPATTERN\fR \fIMODULE\fR
691 Specifies the module used to calculate the length of files matching
693 \fIMODULE\fR specifies which plugin module to use.
695 If \fBtracklength\fR is used without arguments then the list of modules is
698 .B user \fIUSERNAME\fR
699 Specifies the user to run as.
700 Only makes sense if invoked as root (or the target user).
701 .SS "Client Configuration"
702 These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR
704 \fIpkgconfdir/config.\fRUSERNAME.
706 .B connect \fIHOST SERVICE\fR
707 Connect to the address specified by \fIHOST\fR and port specified by
710 .B password \fIPASSWORD\fR
713 .B username \fIUSERNAME\fR
715 The default is taken from the environment variable \fBLOGNAME\fR.
716 .SS "Web Interface Configuration"
717 .\" TODO this section is misnamed really...
719 .B mail_sender \fIADDRESS\fR
720 The email address that appears in the From: field of any mail messages sent by
722 This must be set if you have online registration enabled.
724 .B refresh \fISECONDS\fR
725 Specifies the maximum refresh period in seconds.
728 .B sendmail \fIPATH\fR
729 The path to the Sendmail executable.
730 This must support the \fB-bs\fR option (Postfix, Exim and Sendmail should all
732 The default is the sendmail executable found at compile time.
734 .B short_display \fICHARACTERS\fR
735 Defines the maximum number of characters to include in a \fBshort\fR name
739 .B smtp_server \fIHOSTNAME\fR
740 The hostname (or address) of the SMTP server to use for sending mail.
741 The default is 127.0.0.1.
742 If \fBsendmail\fR is set then that is used instead.
744 .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
745 Determines how names are sorted and displayed in track choice displays.
747 \fITYPE\fR is the type of transformation; usually \fBtrack\fR or
748 \fBdir\fR but you can define your own.
750 \fICONTEXT\fR is a glob pattern matching the context.
751 Standard contexts are \fBsort\fR (which determines how directory names
752 are sorted) and \fBdisplay\fR (which determines how they are displayed).
753 Again, you can define your own.
755 All the \fBtransform\fR directives are considered in order.
756 If the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match
757 then a new track name is constructed from
758 \fISUBST\fR according to the substitution rules below.
759 If several match then each is executed in order.
761 If you supply no \fBtransform\fR directives at all then a default set will be
762 supplied automatically.
763 But if you supply even one then you must supply all of them.
767 transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display
768 transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort
769 transform dir "^.*/([^/]+)$" $1 *
770 transform dir "^(the) ([^/]*)" "$2 $1" sort i
771 transform dir "[[:punct:]]" "" sort g
775 Specifies the URL of the web interface.
776 This URL will be used in generated web pages.
777 The default is inferred at runtime, so this option no
778 longer needs to be specified.
780 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
781 \fB/cgi-bin/jukebox\fR.
782 .SH "GLOBAL PREFERENCES"
783 These are the values set with \fBset\-global\fR.
786 If this is set an nonempty then randomly played tracks will always have at
787 least one of the listed tags.
790 If this is set an nonempty then randomly played tracks will never have any of
794 If unset or \fByes\fR then play is enabled.
795 Otherwise it is disabled.
796 Use \fBdisable\fR rather than setting it directly.
799 If unset or \fByes\fR then random play is enabled.
800 Otherwise it is disabled.
801 Use \fBdisable\fR rather than setting it directly.
803 Global preferences starting '_' are read-only (in the sense that you cannot
804 modify them; the server may modify them as part of its normal operation).
808 The database version string.
809 This is used by DisOrder to detect when it must
810 modify the database after an upgrade.
812 .SS "Raw Protocol Players"
813 Raw protocol players are expected to use the \fBdisorder\fR libao driver.
814 Programs that use libao generally have command line options to select the
815 driver and pass options to it.
817 The known driver options are:
820 The file descriptor to write to.
821 If this is not specified then the driver looks like the environment
822 variable \fBDISORDER_RAW_FD\fR.
823 If that is not set then the default is 1 (i.e. standard output).
826 If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a
827 write to the output file descriptor fails.
828 This is a workaround for buggy players such as \fBogg123\fR that ignore
830 .SH "REGEXP SUBSTITUTION RULES"
831 Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3).
832 The only option used is \fBPCRE_UTF8\fR.
833 Remember that the configuration file syntax means you have to
834 escape backslashes and quotes inside quoted strings.
836 In a \fISUBST\fR string the following sequences are interpreted
840 These expand to the first to ninth bracketed subexpression.
843 This expands to the matched part of the subject string.
846 This expands to a single \fB$\fR symbol.
848 All other pairs starting with \fB$\fR are undefined (and might be used
849 for something else in the future, so don't rely on the current
852 If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent.
853 If \fBg\fR is present then all matches are replaced, otherwise only the first
855 .SH "TRACK NAME PARTS"
856 The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR,
857 with the obvious intended meaning.
858 These are controlled by configuration and by \fBtrackname_\fR preferences.
860 In addition there are two built-in parts, \fBpath\fR which is the whole path
861 name and \fBext\fR which is the filename extension, including the initial dot
862 (or the empty string if there is not extension).
864 \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8),
865 \fBpcrepattern\fR(3), \fBdisorder_templates\fR(5), \fBdisorder_actions\fR(5),
866 \fBdisorder.cgi\fR(8)
~mdw / disorder / blob