Commit | Line | Data |
---|---|---|
460b9539 | 1 | .\" |
b50cfb8a | 2 | .\" Copyright (C) 2004-2009 Richard Kettlewell |
460b9539 | 3 | .\" |
e7eb3a27 | 4 | .\" This program is free software: you can redistribute it and/or modify |
460b9539 | 5 | .\" it under the terms of the GNU General Public License as published by |
e7eb3a27 | 6 | .\" the Free Software Foundation, either version 3 of the License, or |
460b9539 | 7 | .\" (at your option) any later version. |
e7eb3a27 RK |
8 | .\" |
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. | |
13 | .\" | |
460b9539 | 14 | .\" You should have received a copy of the GNU General Public License |
e7eb3a27 | 15 | .\" along with this program. If not, see <http://www.gnu.org/licenses/>. |
460b9539 | 16 | .\" |
17 | .TH disorder_config 5 | |
18 | .SH NAME | |
19 | pkgconfdir/config - DisOrder jukebox configuration | |
20 | .SH DESCRIPTION | |
21 | The purpose of DisOrder is to organize and play digital audio files, under the | |
c0c23a60 | 22 | control of multiple users. |
00753f26 RK |
23 | \fIpkgconfdir/config\fR is the primary configuration file; the web interface |
24 | uses a number of others (see \fBdisorder.cgi\fR(8)). | |
460b9539 | 25 | .SS Tracks |
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 | |
28 | instance, "*.mp3"). | |
29 | .PP | |
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 | |
c0c23a60 RK |
32 | player. |
33 | See \fBdisorder\fR(3) for more details about this. | |
460b9539 | 34 | .PP |
c0c23a60 RK |
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. | |
3d1452ab | 38 | See \fBdisorder_preferences\fR(5) for more details about these. |
460b9539 | 39 | .SS "Track Names" |
40 | Track names are derived from filenames under the control of regular | |
41 | expressions, rather than attempting to interpret format-specific embedded name | |
c0c23a60 RK |
42 | information. |
43 | They can be overridden by setting preferences. | |
460b9539 | 44 | .PP |
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. | |
48 | .SS "Server State" | |
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. | |
3d1452ab | 51 | See \fBdisorder_preferences\fR(5) for more information. |
460b9539 | 52 | .SS "Users And Access Control" |
c0c23a60 RK |
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. | |
460b9539 | 56 | .PP |
eb5dc014 | 57 | Each user has an associated set of rights which contorl which commands they may |
c0c23a60 RK |
58 | execute. |
59 | Normally you would give all users most rights, and expect them to | |
eb5dc014 RK |
60 | cooperate (they are after all presumed to be in a shared sound environment). |
61 | .PP | |
62 | The full set of rights are: | |
63 | .TP | |
64 | .B read | |
65 | User can perform read-only operations | |
66 | .TP | |
67 | .B play | |
68 | User can add tracks to the queue | |
69 | .TP | |
70 | .B "move any" | |
71 | User can move any track | |
72 | .TP | |
73 | .B "move mine" | |
74 | User can move their own tracks | |
75 | .TP | |
76 | .B "move random" | |
77 | User can move randomly chosen tracks | |
78 | .TP | |
79 | .B "remove any" | |
80 | User can remove any track | |
81 | .TP | |
82 | .B "remove mine" | |
83 | User can remove their own tracks | |
84 | .TP | |
85 | .B "remove random" | |
86 | User can remove randomly chosen tracks | |
87 | .TP | |
88 | .B "scratch any" | |
89 | User can scratch any track | |
90 | .TP | |
91 | .B "scratch mine" | |
92 | User can scratch their own tracks | |
93 | .TP | |
94 | .B "scratch random" | |
95 | User can scratch randomly chosen tracks | |
96 | .TP | |
97 | .B volume | |
98 | User can change the volume | |
99 | .TP | |
100 | .B admin | |
101 | User can perform admin operations | |
102 | .TP | |
103 | .B rescan | |
104 | User can initiate a rescan | |
105 | .TP | |
106 | .B register | |
c0c23a60 RK |
107 | User can register new users. |
108 | Normally only the | |
eb5dc014 RK |
109 | .B guest |
110 | user would have this right. | |
111 | .TP | |
112 | .B userinfo | |
113 | User can edit their own userinfo | |
114 | .TP | |
115 | .B prefs | |
116 | User can modify track preferences | |
117 | .TP | |
118 | .B "global prefs" | |
119 | User can modify global preferences | |
120 | .TP | |
121 | .B pause | |
122 | User can pause/resume | |
460b9539 | 123 | .PP |
c0c23a60 RK |
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 | |
127 | available. | |
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 | |
131 | the network layer. | |
460b9539 | 132 | .SS "Web Interface" |
133 | The web interface is controlled by a collection of template files, one for each | |
c0c23a60 RK |
134 | kind of page, and a collection of option files. |
135 | These are split up and separate from the main configuration file to | |
5c1ae3bc RK |
136 | .PP |
137 | See \fBdisorder.cgi\fR(8) for more information. | |
180dcdb0 | 138 | .SS "Searching And Tags" |
c0c23a60 RK |
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:". | |
180dcdb0 RK |
141 | .PP |
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: | |
144 | .PP | |
145 | .nf | |
146 | LATIN CAPITAL LETTER E | |
147 | LATIN SMALL 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 | |
152 | .fi | |
153 | .PP | |
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. | |
157 | .PP | |
158 | Where several tags are listed, for instance the tags preference for a track, | |
c0c23a60 RK |
159 | the tags are separated by commas. |
160 | Therefore tags may not contain commas. | |
460b9539 | 161 | .SH "CONFIGURATION FILE" |
162 | .SS "General Syntax" | |
163 | Lines are split into fields separated by whitespace (space, tab, line | |
c0c23a60 RK |
164 | feed, carriage return, form feed). |
165 | Comments are started by the number sign ("#"). | |
460b9539 | 166 | .PP |
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 | |
c0c23a60 RK |
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: | |
460b9539 | 172 | .TP |
173 | .B \e\e | |
174 | Backslash | |
175 | .TP | |
176 | .B \e" | |
177 | Quotation mark | |
178 | .\" " | |
179 | .TP | |
863c04fa | 180 | .B \e\(aq |
460b9539 | 181 | Apostrophe |
182 | .TP | |
183 | .B \en | |
184 | Line feed | |
185 | .PP | |
186 | No other escape sequences are allowed. | |
187 | .PP | |
188 | Within any line the first field is a configuration command and any | |
c0c23a60 RK |
189 | further fields are parameters. |
190 | Lines with no fields are ignored. | |
460b9539 | 191 | .PP |
192 | After editing the config file use \fBdisorder reconfigure\fR to make | |
c0c23a60 RK |
193 | it re-read it. |
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.) | |
eb5dc014 RK |
198 | .SS "Configuration Files" |
199 | Configuration files are read in the following order: | |
200 | .TP | |
201 | .I pkgconfdir/config | |
202 | .TP | |
203 | .I pkgconfdir/config.private | |
c0c23a60 RK |
204 | Should be readable only by the jukebox group. |
205 | Not really useful any more and will be abolished in future. | |
eb5dc014 | 206 | .TP |
90ad6c6e | 207 | .I ~\fRUSERNAME\fI/.disorder/passwd |
c0c23a60 RK |
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. | |
5b14453f | 211 | .TP |
90ad6c6e | 212 | .I pkgconfdir/config.\fRUSERNAME |
c0c23a60 RK |
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. | |
5b14453f RK |
216 | .IP |
217 | The prefererred location for per-user passwords is \fI~/.disorder/passwd\fR and | |
c0c23a60 | 218 | \fBdisorder authorize\fR writes there now. |
460b9539 | 219 | .SS "Global Configuration" |
220 | .TP | |
221 | .B home \fIDIRECTORY\fR | |
c0c23a60 RK |
222 | The home directory for state files. |
223 | Defaults to | |
460b9539 | 224 | .IR pkgstatedir . |
659d87e8 | 225 | The server will create this directory on startup if it does not exist. |
863c04fa RK |
226 | .IP |
227 | This setting cannot be changed during the lifetime of the server. | |
460b9539 | 228 | .TP |
0c6bcae0 | 229 | .B plugins \fIPATH\fR |
c0c23a60 RK |
230 | Adds a directory to the plugin path. |
231 | (This is also used by the web interface.) | |
460b9539 | 232 | .IP |
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. | |
40c30921 RK |
236 | .IP |
237 | If | |
238 | .B plugins | |
239 | is used without arguments the plugin path is cleared. | |
460b9539 | 240 | .SS "Server Configuration" |
241 | .TP | |
242 | .B alias \fIPATTERN\fR | |
243 | Defines the pattern use construct virtual filenames from \fBtrackname_\fR | |
244 | preferences. | |
245 | .IP | |
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 | |
248 | \fB{/\fIname\fB}\fR. | |
249 | .IP | |
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. | |
252 | .IP | |
253 | The pattern should not attempt to include the collection root, which is | |
254 | automatically included, but should include the proper extension. | |
255 | .IP | |
256 | The default is \fB{/artist}{/album}{/title}{ext}\fR. | |
863c04fa RK |
257 | .IP |
258 | This setting cannot be changed during the lifetime of the server. | |
460b9539 | 259 | .TP |
bd8895a8 | 260 | .B api \fINAME\fR |
c0c23a60 RK |
261 | Selects the backend used to play sound and to set the volume. |
262 | The following options are available: | |
bd8895a8 | 263 | .RS |
264 | .TP | |
265 | .B alsa | |
c0c23a60 RK |
266 | Use the ALSA API. |
267 | This is only available on Linux systems, on which it is the default. | |
bd8895a8 | 268 | .TP |
269 | .B coreaudio | |
c0c23a60 RK |
270 | Use Apple Core Audio. |
271 | This only available on OS X systems, on which it is the default. | |
bd8895a8 | 272 | .TP |
273 | .B oss | |
c0c23a60 RK |
274 | Use the OSS (/dev/dsp) API. |
275 | Not available on all platforms. | |
bd8895a8 | 276 | .TP |
277 | .B command | |
c0c23a60 RK |
278 | Execute a command. |
279 | This is the default if | |
bd8895a8 | 280 | .B speaker_command |
281 | is specified, or if no native is available. | |
f75ab9d3 RK |
282 | .IP |
283 | You might want to set | |
284 | .B pause_mode | |
285 | with this backend. | |
bd8895a8 | 286 | .TP |
b50cfb8a | 287 | .B rtp |
c0c23a60 RK |
288 | Transmit audio over the network. |
289 | This is the default if \fBbroadcast\fR is specified. | |
290 | You can use | |
bd8895a8 | 291 | .BR disorder-playrtp (1) |
292 | to receive and play the resulting stream on Linux and OS X. | |
b50cfb8a RK |
293 | .B network |
294 | is a deprecated synonym for this API. | |
bd8895a8 | 295 | .RE |
296 | .TP | |
25ca855b | 297 | .B authorization_algorithm \fIALGORITHM\fR |
c0c23a60 RK |
298 | Defines the algorithm used to authenticate clients. |
299 | The valid options are sha1 (the default), sha256, sha384 and sha512. | |
300 | See | |
637fdea3 RK |
301 | .BR disorder_protocol (5) |
302 | for more details. | |
303 | .TP | |
9053adc9 | 304 | .B broadcast \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR |
c0c23a60 | 305 | Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. |
b50cfb8a | 306 | This implies \fBapi rtp\fR. |
61941295 | 307 | .IP |
9053adc9 RK |
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. | |
311 | .IP | |
61941295 | 312 | See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR. |
30ad4dab | 313 | .TP |
9053adc9 | 314 | .B broadcast_from \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR |
30ad4dab | 315 | Sets the (local) source address used by \fBbroadcast\fR. |
9053adc9 RK |
316 | .IP |
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. | |
30ad4dab | 320 | .TP |
460b9539 | 321 | .B channel \fICHANNEL\fR |
bd8895a8 | 322 | The mixer channel that the volume control should use. |
323 | .IP | |
324 | For \fBapi oss\fR the possible values are: | |
460b9539 | 325 | .RS |
326 | .TP 8 | |
327 | .B pcm | |
9053adc9 | 328 | |
c0c23a60 RK |
329 | Output level for the audio device. |
330 | This is probably what you want and is the default. | |
460b9539 | 331 | .TP |
332 | .B speaker | |
333 | Output level for the PC speaker, if that is connected to the sound card. | |
334 | .TP | |
335 | .B pcm2 | |
336 | Output level for alternative codec device. | |
337 | .TP | |
338 | .B vol | |
c0c23a60 RK |
339 | Master output level. |
340 | The OSS documentation recommends against using this, as it affects all | |
341 | output devices. | |
460b9539 | 342 | .RE |
343 | .IP | |
bd8895a8 | 344 | You can also specify channels by number, if you know the right value. |
345 | .IP | |
c0c23a60 RK |
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. | |
bd8895a8 | 349 | .IP |
350 | For \fBapi coreaudio\fR, volume setting is not currently supported. | |
460b9539 | 351 | .TP |
352 | .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR | |
01cef138 RK |
353 | .TP |
354 | .B collection \fIMODULE\fR \fIROOT\fR | |
355 | .TP | |
356 | .B collection \fIROOT\fR | |
460b9539 | 357 | Define a collection of tracks. |
358 | .IP | |
359 | \fIMODULE\fR defines which plugin module should be used for this | |
c0c23a60 RK |
360 | collection. |
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. | |
364 | .IP | |
365 | \fIENCODING\fR defines the encoding of filenames in this collection. | |
366 | For \fBfs\fR this would be the encoding you use for filenames. | |
0d350ff0 | 367 | Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR. |
c0c23a60 RK |
368 | If no encoding is specified then the current locale's character encoding |
369 | is used. | |
460b9539 | 370 | .IP |
01cef138 RK |
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 | |
c0c23a60 RK |
373 | configured. |
374 | It's best to explicitly specify it to be certain. | |
460b9539 | 375 | .IP |
376 | \fIROOT\fR is the root in the filesystem of the filenames and is | |
c0c23a60 RK |
377 | passed to the plugin module. |
378 | It must be an absolute path and should not end with a "/". | |
460b9539 | 379 | .TP |
dafbdc04 RK |
380 | .B cookie_key_lifetime \fISECONDS\fR |
381 | Lifetime of the signing key used in constructing cookies. The default is one | |
382 | week. | |
863c04fa RK |
383 | .IP |
384 | If this is changed during the lifetime of the server, the current key doesn't | |
385 | hvave its lifetime retroactively changed. | |
dafbdc04 RK |
386 | .TP |
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. | |
863c04fa RK |
391 | .IP |
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. | |
dafbdc04 | 394 | .TP |
04e1fa7c | 395 | .B default_rights \fIRIGHTS\fR |
c0c23a60 RK |
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 | |
04e1fa7c RK |
399 | .B "Users And Access Control" |
400 | above. | |
401 | .IP | |
402 | The default is to allow everything except \fBadmin\fR and \fBregister\fR | |
403 | (modified in legacy configurations by the obsolete \fBrestrict\fR directive). | |
404 | .TP | |
460b9539 | 405 | .B device \fINAME\fR |
bd8895a8 | 406 | Sound output device. |
407 | .IP | |
c0c23a60 RK |
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 | |
410 | will be tried. | |
bd8895a8 | 411 | .IP |
412 | For \fBapi alsa\fR this is the device name to use. | |
413 | .IP | |
f5fd9a6b RK |
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. | |
bd8895a8 | 420 | .IP |
b25aac59 | 421 | The default is \fBdefault\fR, which is intended to map to whatever the system's |
422 | default is. | |
460b9539 | 423 | .TP |
424 | .B gap \fISECONDS\fR | |
863c04fa | 425 | This option no longer does anything and will be removed in a future version. |
460b9539 | 426 | .TP |
427 | .B history \fIINTEGER\fR | |
428 | Specifies the number of recently played tracks to remember (including | |
429 | failed tracks and scratches). | |
863c04fa RK |
430 | .IP |
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. | |
460b9539 | 433 | .TP |
9053adc9 | 434 | .B listen \fR[\fIFAMILY\fR] \fR[\fIHOST\fR] \fISERVICE\fR |
460b9539 | 435 | Listen for connections on the address specified by \fIHOST\fR and port |
c0c23a60 | 436 | specified by \fISERVICE\fR. |
9053adc9 RK |
437 | If \fIHOST\fR is omitted, or is \fB*\fR, then listens on all local addresses. |
438 | .IP | |
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. | |
460b9539 | 442 | .IP |
443 | Normally the server only listens on a UNIX domain socket. | |
444 | .TP | |
445 | .B lock yes\fR|\fBno | |
863c04fa | 446 | This option no longer does anything and will be removed in a future version. |
460b9539 | 447 | .TP |
bd8895a8 | 448 | .B mixer \fIDEVICE\fR |
449 | The mixer device name, if it needs to be specified separately from | |
450 | \fBdevice\fR. | |
451 | .IP | |
452 | For \fBapi oss\fR this should be the path to the mixer device and the default | |
453 | is \fI/dev/mixer\fR. | |
454 | .IP | |
c0c23a60 RK |
455 | For \fBapi alsa\fR, this is the index of the mixer control to use. |
456 | The default is 0. | |
bd8895a8 | 457 | .IP |
458 | For \fBapi coreaudio\fR, volume setting is not currently supported. | |
460b9539 | 459 | .TP |
61941295 | 460 | .B multicast_loop yes\fR|\fBno |
c0c23a60 RK |
461 | Determines whether multicast packets are loop backed to the sending host. |
462 | The default is \fByes\fR. | |
b50cfb8a | 463 | This only applies if \fBapi\fR is set to \fBrtp\fR and \fBbroadcast\fR |
c0c23a60 | 464 | is actually a multicast address. |
61941295 | 465 | .TP |
23205f9c | 466 | .B multicast_ttl \fIHOPS\fR |
c0c23a60 | 467 | Set the maximum number of hops to send multicast packets. |
b50cfb8a | 468 | This only applies if \fBapi\fR is set to \fBrtp\fR and |
c0c23a60 RK |
469 | \fBbroadcast\fR is actually a multicast address. |
470 | The default is 1. | |
23205f9c | 471 | .TP |
460b9539 | 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. | |
476 | .IP | |
c0c23a60 RK |
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 | |
460b9539 | 481 | contexts in which this directive will be used. |
482 | .IP | |
483 | Valid contexts are \fBsort\fR and \fBdisplay\fR. | |
484 | .IP | |
c0c23a60 RK |
485 | All the \fBnamepart\fR directives are considered in order. |
486 | The first directive for the right part, that matches the desired context, | |
460b9539 | 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. | |
490 | .IP | |
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. | |
494 | .IP | |
495 | If you supply no \fBnamepart\fR directives at all then a default set will be | |
c0c23a60 RK |
496 | supplied automatically. |
497 | But if you supply even one then you must supply all of them. | |
498 | The defaults are equivalent to: | |
25ca855b RK |
499 | .PP |
500 | .nf | |
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 * | |
506 | .fi | |
863c04fa RK |
507 | .IP |
508 | This setting cannot be changed during the lifetime of the server. | |
460b9539 | 509 | .TP |
05dcfac6 RK |
510 | .B new_bias \fIWEIGHT\fR |
511 | The weight for new tracks. | |
6151ae7e | 512 | The default is 450000, i.e. recently added tracks are a fifty times as likely |
05dcfac6 | 513 | to be picked as normal. |
863c04fa RK |
514 | .IP |
515 | New values of this option may be picked up from the configuration file even | |
516 | without a reload. | |
05dcfac6 RK |
517 | .TP |
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. | |
863c04fa RK |
521 | .IP |
522 | New values of this option may be picked up from the configuration file even | |
523 | without a reload. | |
05dcfac6 | 524 | .TP |
d742bb47 | 525 | .B new_max \fIMAX\fR |
c0c23a60 RK |
526 | The maximum number of tracks to list when reporting newly noticed tracks. |
527 | The default is 100. | |
d742bb47 | 528 | .TP |
460b9539 | 529 | .B nice_rescan \fIPRIORITY\fR |
c0c23a60 RK |
530 | Set the recan subprocess priority. |
531 | The default is 10. | |
460b9539 | 532 | .IP |
533 | (Note that higher values mean the process gets less CPU time; UNIX priority | |
04e42396 | 534 | values are backwards.) |
460b9539 | 535 | .TP |
536 | .B nice_server \fIPRIORITY\fR | |
c0c23a60 RK |
537 | Set the server priority. |
538 | This is applied to the server at startup time (and not when you reload | |
539 | configuration). | |
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 | |
543 | negative value. | |
544 | The default is 0. | |
863c04fa RK |
545 | .IP |
546 | Changes to this value during the lifetime of the server are ignored. | |
460b9539 | 547 | .TP |
548 | .B nice_speaker \fIPRIORITY\fR | |
c0c23a60 RK |
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 | |
555 | negative value. | |
556 | The default is 0. | |
863c04fa RK |
557 | .IP |
558 | Changes to this value during the lifetime of the server are ignored. | |
460b9539 | 559 | .TP |
2a10b70b RK |
560 | .B noticed_history |
561 | The maximum days that a track can survive in the database of newly added | |
c0c23a60 RK |
562 | tracks. |
563 | The default is 31. | |
2a10b70b | 564 | .TP |
f75ab9d3 RK |
565 | .B pause_mode \fIMODE |
566 | Sets the pause mode for the \fBcommand\fR backend. | |
567 | The possible values are: | |
568 | .RS | |
569 | .TP | |
570 | .B silence | |
571 | Send silent (0-value) samples when paused. | |
572 | This is the default. | |
573 | .TP | |
574 | .B suspend | |
575 | Stop writing when paused. | |
576 | .RE | |
577 | .TP | |
0d350ff0 | 578 | .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR... |
c0c23a60 RK |
579 | Specifies the player for files matching the glob \fIPATTERN\fR. |
580 | \fIMODULE\fR specifies which plugin module to use. | |
460b9539 | 581 | .IP |
582 | The following options are supported: | |
583 | .RS | |
584 | .TP | |
0d350ff0 | 585 | .B \-\-wait\-for\-device\fR[\fB=\fIDEVICE\fR] |
8c37e83b RK |
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.) | |
589 | .IP | |
460b9539 | 590 | Waits (for up to a couple of seconds) for the default, or specified, libao |
591 | device to become openable. | |
592 | .TP | |
0d350ff0 | 593 | .B \-\- |
c0c23a60 | 594 | Defines the end of the list of options. |
0d350ff0 | 595 | Needed if the first argument to the plugin starts with a "\-". |
460b9539 | 596 | .RE |
597 | .IP | |
598 | The following are the standard modules: | |
599 | .RS | |
600 | .TP | |
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 | |
604 | an absolute path. | |
605 | The command is expected to know how to open its own sound device. | |
606 | .TP | |
607 | .B execraw \fICOMMAND\fR \fIARGS\fR... | |
608 | Identical to the \fBexec\fR except that the player is expected to use the | |
ce6c36be | 609 | DisOrder raw player protocol. |
610 | .BR disorder-decode (8) | |
c0c23a60 RK |
611 | can decode several common audio file formats to this format. |
612 | If your favourite format is not supported, but you have a player | |
613 | which uses libao, there is also a libao driver which supports this format; | |
614 | see below for more information about this. | |
460b9539 | 615 | .TP |
616 | .B shell \fR[\fISHELL\fR] \fICOMMAND\fR | |
c0c23a60 RK |
617 | The command is executed using the shell. |
618 | If \fISHELL\fR is specified then that is used, otherwise \fBsh\fR will be used. | |
619 | In either case the \fBPATH\fR environment variable is searched for the shell | |
620 | executable if it is not an absolute path. | |
621 | The track name is stored in the environment variable | |
460b9539 | 622 | \fBTRACK\fR. |
623 | .IP | |
624 | Be careful of the interaction between the configuration file quoting rules and | |
625 | the shell quoting rules. | |
626 | .RE | |
627 | .IP | |
628 | If multiple player commands match a track then the first match is used. | |
62dc3748 RK |
629 | .IP |
630 | For the server to be able to calculate track lengths, there should be a | |
631 | .B tracklength | |
632 | command corresponding to each | |
633 | .B player | |
634 | command. | |
40c30921 RK |
635 | .IP |
636 | If | |
637 | .B player | |
638 | is used without arguments, the list of players is cleared. | |
863c04fa RK |
639 | .IP |
640 | Although players can be changed during the lifetime of the server, note that | |
641 | background decoders will not be stopped and restarted using changed | |
642 | configuration once they have been started. | |
460b9539 | 643 | .TP |
644 | .B prefsync \fISECONDS\fR | |
0c4101ec | 645 | This option no longer does anything and will be removed in a future version. |
460b9539 | 646 | .TP |
459d4402 | 647 | .B queue_pad \fICOUNT\fR |
c0c23a60 RK |
648 | The target size of the queue. |
649 | If random play is enabled then randomly picked tracks will be added until | |
650 | the queue is at least this big. | |
651 | The default is 10. | |
863c04fa RK |
652 | .IP |
653 | If this is reduced during the lifetime of the server, the queue won't be | |
654 | reduced in size to fit; it just won't start growing again until it is under the | |
655 | new value. | |
656 | However, if it is increased, new tracks will start being added immediately. | |
459d4402 | 657 | .TP |
6207d2f3 | 658 | .B reminder_interval \fISECONDS\fR |
c0c23a60 RK |
659 | The minimum number of seconds that must elapse between password reminders. |
660 | The default is 600, i.e. 10 minutes. | |
6207d2f3 | 661 | .TP |
810b8083 RK |
662 | .B remote_userman yes\fR|\fBno |
663 | User management over TCP connection is only allowed if this is set to | |
664 | \fByes\fR. By default it is set to \fBno\fR. | |
665 | .TP | |
cebe3127 RK |
666 | .B replay_min \fISECONDS\fR |
667 | The minimum number of seconds that must elapse after a track has been played | |
668 | before it can be picked at random. The default is 8 hours. If this is set to | |
669 | 0 then there is no limit, though current \fBdisorder-choose\fR will not pick | |
670 | anything currently listed in the recently-played list. | |
863c04fa RK |
671 | .IP |
672 | New values of this option may be picked up from the configuration file even | |
673 | without a reload. | |
cebe3127 | 674 | .TP |
405fea4e | 675 | .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS |
c0c23a60 RK |
676 | Describes the sample format expected by the \fBspeaker_command\fR (below). |
677 | The components of the format specification are as follows: | |
405fea4e | 678 | .RS |
679 | .TP 10 | |
680 | .I BITS | |
c0c23a60 RK |
681 | The number of bits per sample. |
682 | Optionally, may be suffixed by \fBb\fR or \fBl\fR for big-endian and | |
683 | little-endian words. | |
684 | If neither is used the native byte order is assumed. | |
405fea4e | 685 | .TP |
686 | .I RATE | |
687 | The number of samples per second. | |
688 | .TP | |
689 | .I CHANNELS | |
690 | The number of channels. | |
691 | .PP | |
692 | The default is | |
693 | .BR 16/44100/2 . | |
937be4c0 RK |
694 | .PP |
695 | With the | |
b50cfb8a | 696 | .B rtp |
937be4c0 | 697 | backend the sample format is forced to |
e99d42b1 | 698 | .B 16b/44100/2 |
937be4c0 RK |
699 | and with the |
700 | .B coreaudio | |
701 | backend it is forced to | |
702 | .BR 16/44100/2 , | |
703 | in both cases regardless of what is specified in the configuration file. | |
405fea4e | 704 | .RE |
705 | .TP | |
460b9539 | 706 | .B signal \fINAME\fR |
707 | Defines the signal to be sent to track player process groups when tracks are | |
c0c23a60 RK |
708 | scratched. |
709 | The default is \fBSIGKILL\fR. | |
460b9539 | 710 | .IP |
711 | Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR | |
712 | or \fBInterrupted\fR or whatever. | |
713 | .TP | |
5330d674 | 714 | .B sox_generation \fB0\fR|\fB1 |
0d350ff0 RK |
715 | Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if |
716 | the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1). | |
c0c23a60 RK |
717 | See the documentation for your installed copy of \fBsox\fR to determine |
718 | which you need. | |
419893d7 RK |
719 | The default is set according to the version of sox found when DisOrder was |
720 | built. | |
721 | If you run on a system with a different version of sox, you will need to | |
722 | set this option. | |
5330d674 | 723 | .TP |
bd8895a8 | 724 | .B speaker_backend \fINAME |
725 | This is an alias for \fBapi\fR; see above. | |
726 | .TP | |
405fea4e | 727 | .B speaker_command \fICOMMAND |
728 | Causes the speaker subprocess to pipe audio data into shell command | |
c0c23a60 RK |
729 | \fICOMMAND\fR, rather than writing to a local sound card. |
730 | The sample format is determine by | |
405fea4e | 731 | .B sample_format |
732 | above. | |
77cfc7a2 | 733 | .IP |
734 | Note that if the sample format is wrong then | |
735 | .BR sox (1) | |
c0c23a60 RK |
736 | is invoked to translate it. |
737 | If | |
77cfc7a2 | 738 | .B sox |
739 | is not installed then this will not work. | |
405fea4e | 740 | .TP |
460b9539 | 741 | .B scratch \fIPATH\fR |
c0c23a60 RK |
742 | Specifies a scratch. |
743 | When a track is scratched, a scratch track is played at random. | |
460b9539 | 744 | Scratches are played using the same logic as other tracks. |
745 | .IP | |
746 | At least for the time being, path names of scratches must be encoded using | |
747 | UTF-8 (which means that ASCII will do). | |
40c30921 RK |
748 | .IP |
749 | If \fBscratch\fR is used without arguments then the list of scratches is | |
750 | cleared. | |
460b9539 | 751 | .TP |
752 | .B stopword \fIWORD\fR ... | |
753 | Specifies one or more stopwords that should not take part in searches | |
754 | over track names. | |
40c30921 RK |
755 | .IP |
756 | If \fBstopword\fR is used without arguments then the list of stopwords is | |
757 | cleared. | |
86be0c30 | 758 | .IP |
759 | There is a default set of stopwords built in, but this option can be used to | |
760 | augment or replace that list. | |
863c04fa RK |
761 | .IP |
762 | This setting cannot be changed during the lifetime of the server. | |
62dc3748 RK |
763 | .TP |
764 | .B tracklength \fIPATTERN\fR \fIMODULE\fR | |
765 | Specifies the module used to calculate the length of files matching | |
c0c23a60 RK |
766 | \fIPATTERN\fR. |
767 | \fIMODULE\fR specifies which plugin module to use. | |
40c30921 RK |
768 | .IP |
769 | If \fBtracklength\fR is used without arguments then the list of modules is | |
770 | cleared. | |
863c04fa RK |
771 | .IP |
772 | Track lengths are cached in the database, and changing this setting won't cause | |
773 | them to be regenerated. | |
eb5dc014 | 774 | .TP |
90ad6c6e | 775 | .B user \fIUSERNAME\fR |
c0c23a60 RK |
776 | Specifies the user to run as. |
777 | Only makes sense if invoked as root (or the target user). | |
863c04fa RK |
778 | .IP |
779 | This setting cannot be changed during the lifetime of the server | |
780 | (and if it is changed with a restart, you will need to adjust file permissions | |
781 | on the server's database). | |
460b9539 | 782 | .SS "Client Configuration" |
00753f26 RK |
783 | These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR |
784 | or | |
785 | \fIpkgconfdir/config.\fRUSERNAME. | |
460b9539 | 786 | .TP |
9053adc9 | 787 | .B connect \fR[\fIFAMILY\fR] \fIHOST SERVICE\fR |
460b9539 | 788 | Connect to the address specified by \fIHOST\fR and port specified by |
ccf0aafa | 789 | \fISERVICE\fR. |
9053adc9 RK |
790 | .IP |
791 | \fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not | |
792 | implied by \fIHOST\fR. | |
793 | Note that IPv6 is not currently well tested. | |
00753f26 RK |
794 | .TP |
795 | .B password \fIPASSWORD\fR | |
796 | Specify password. | |
797 | .TP | |
798 | .B username \fIUSERNAME\fR | |
799 | Specify username. | |
3d1452ab | 800 | The default is inferred from the current UID. |
460b9539 | 801 | .SS "Web Interface Configuration" |
00753f26 | 802 | .\" TODO this section is misnamed really... |
460b9539 | 803 | .TP |
e70701e7 | 804 | .B mail_sender \fIADDRESS\fR |
805 | The email address that appears in the From: field of any mail messages sent by | |
c0c23a60 RK |
806 | the web interface. |
807 | This must be set if you have online registration enabled. | |
e70701e7 | 808 | .TP |
460b9539 | 809 | .B refresh \fISECONDS\fR |
c0c23a60 RK |
810 | Specifies the maximum refresh period in seconds. |
811 | Default 15. | |
460b9539 | 812 | .TP |
2eee4b0c RK |
813 | .B sendmail \fIPATH\fR |
814 | The path to the Sendmail executable. | |
815 | This must support the \fB-bs\fR option (Postfix, Exim and Sendmail should all | |
816 | work). | |
817 | The default is the sendmail executable found at compile time. | |
818 | .TP | |
61507e3c RK |
819 | .B short_display \fICHARACTERS\fR |
820 | Defines the maximum number of characters to include in a \fBshort\fR name | |
c0c23a60 RK |
821 | part. |
822 | Default 30. | |
61507e3c | 823 | .TP |
e70701e7 | 824 | .B smtp_server \fIHOSTNAME\fR |
c0c23a60 RK |
825 | The hostname (or address) of the SMTP server to use for sending mail. |
826 | The default is 127.0.0.1. | |
2eee4b0c | 827 | If \fBsendmail\fR is set then that is used instead. |
e70701e7 | 828 | .TP |
460b9539 | 829 | .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]] |
830 | Determines how names are sorted and displayed in track choice displays. | |
831 | .IP | |
832 | \fITYPE\fR is the type of transformation; usually \fBtrack\fR or | |
833 | \fBdir\fR but you can define your own. | |
834 | .IP | |
c0c23a60 RK |
835 | \fICONTEXT\fR is a glob pattern matching the context. |
836 | Standard contexts are \fBsort\fR (which determines how directory names | |
837 | are sorted) and \fBdisplay\fR (which determines how they are displayed). | |
838 | Again, you can define your own. | |
460b9539 | 839 | .IP |
c0c23a60 RK |
840 | All the \fBtransform\fR directives are considered in order. |
841 | If the \fITYPE\fR, \fIREGEXP\fR and the \fICONTEXT\fR match | |
460b9539 | 842 | then a new track name is constructed from |
c0c23a60 RK |
843 | \fISUBST\fR according to the substitution rules below. |
844 | If several match then each is executed in order. | |
460b9539 | 845 | .IP |
846 | If you supply no \fBtransform\fR directives at all then a default set will be | |
c0c23a60 RK |
847 | supplied automatically. |
848 | But if you supply even one then you must supply all of them. | |
849 | The defaults are: | |
25ca855b RK |
850 | .PP |
851 | .nf | |
852 | transform track "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$" $2 display | |
853 | transform track "^.*/([^/]+)\\.[a-zA-Z0-9]+$" $1 sort | |
854 | transform dir "^.*/([^/]+)$" $1 * | |
855 | transform dir "^(the) ([^/]*)" "$2 $1" sort i | |
856 | transform dir "[[:punct:]]" "" sort g | |
857 | .fi | |
460b9539 | 858 | .TP |
859 | .B url \fIURL\fR | |
c0c23a60 RK |
860 | Specifies the URL of the web interface. |
861 | This URL will be used in generated web pages. | |
862 | The default is inferred at runtime, so this option no | |
b64c2805 | 863 | longer needs to be specified. |
460b9539 | 864 | .IP |
865 | This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not | |
866 | \fB/cgi-bin/jukebox\fR. | |
460b9539 | 867 | .SH "LIBAO DRIVER" |
868 | .SS "Raw Protocol Players" | |
869 | Raw protocol players are expected to use the \fBdisorder\fR libao driver. | |
870 | Programs that use libao generally have command line options to select the | |
871 | driver and pass options to it. | |
872 | .SS "Driver Options" | |
873 | The known driver options are: | |
874 | .TP | |
875 | .B fd | |
c0c23a60 RK |
876 | The file descriptor to write to. |
877 | If this is not specified then the driver looks like the environment | |
878 | variable \fBDISORDER_RAW_FD\fR. | |
879 | If that is not set then the default is 1 (i.e. standard output). | |
460b9539 | 880 | .TP |
881 | .B fragile | |
882 | If this is set to a nonzero value then the driver will call \fB_exit\fR(2) if a | |
c0c23a60 RK |
883 | write to the output file descriptor fails. |
884 | This is a workaround for buggy players such as \fBogg123\fR that ignore | |
885 | write errors. | |
3e1616b6 RK |
886 | .SH "REGEXP SUBSTITUTION RULES" |
887 | Regexps are PCRE regexps, as defined in \fBpcrepattern\fR(3). | |
888 | The only option used is \fBPCRE_UTF8\fR. | |
889 | Remember that the configuration file syntax means you have to | |
890 | escape backslashes and quotes inside quoted strings. | |
891 | .PP | |
892 | In a \fISUBST\fR string the following sequences are interpreted | |
893 | specially: | |
894 | .TP | |
895 | .B $1 \fR... \fB$9 | |
896 | These expand to the first to ninth bracketed subexpression. | |
897 | .TP | |
898 | .B $& | |
899 | This expands to the matched part of the subject string. | |
900 | .TP | |
901 | .B $$ | |
902 | This expands to a single \fB$\fR symbol. | |
903 | .PP | |
904 | All other pairs starting with \fB$\fR are undefined (and might be used | |
905 | for something else in the future, so don't rely on the current | |
906 | behaviour.) | |
907 | .PP | |
908 | If \fBi\fR is present in \fIREFLAGS\fR then the match is case-independent. | |
909 | If \fBg\fR is present then all matches are replaced, otherwise only the first | |
910 | match is replaced. | |
460b9539 | 911 | .SH "TRACK NAME PARTS" |
912 | The traditional track name parts are \fBartist\fR, \fBalbum\fR and \fBtitle\fR, | |
c0c23a60 RK |
913 | with the obvious intended meaning. |
914 | These are controlled by configuration and by \fBtrackname_\fR preferences. | |
460b9539 | 915 | .PP |
916 | In addition there are two built-in parts, \fBpath\fR which is the whole path | |
917 | name and \fBext\fR which is the filename extension, including the initial dot | |
918 | (or the empty string if there is not extension). | |
919 | .SH "SEE ALSO" | |
0d350ff0 | 920 | \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8), |
5c1ae3bc | 921 | \fBpcrepattern\fR(3), \fBdisorder_templates\fR(5), \fBdisorder_actions\fR(5), |
3d1452ab | 922 | \fBdisorder.cgi\fR(8), \fBdisorder_preferences\fR(5) |
460b9539 | 923 | .\" Local Variables: |
924 | .\" mode:nroff | |
925 | .\" fill-column:79 | |
926 | .\" End: |