X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/04e42396542e4f8bf7cb553528cb426f5fa44206..397ef7bbc2074fb81f540d0d72dcf0fc3b1a5cf5:/doc/disorder_config.5.in diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in index efb7a30..743bb51 100644 --- a/doc/disorder_config.5.in +++ b/doc/disorder_config.5.in @@ -1,3 +1,4 @@ + .\" .\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell .\" @@ -116,6 +117,7 @@ start up without a valid config file.) .B home \fIDIRECTORY\fR The home directory for state files. Defaults to .IR pkgstatedir . +The server will create this directory on startup if it does not exist. .TP .B plugin \fIPATH\fR Adds a directory to the plugin path. (This is also used by the web @@ -268,6 +270,10 @@ is not massively CPU intensive by today's standards but depends on reasonably timely scheduling. If you have limited CPU then it might help to set this to a small negative value. The default is 0. .TP +.B noticed_history +The maximum days that a track can survive in the database of newly added +tracks. The default is 31. +.TP .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR... Specifies the player for files matching the glob \fIPATTERN\fR. \fIMODULE\fR specifies which plugin module to use. @@ -314,6 +320,12 @@ the shell quoting rules. .RE .IP If multiple player commands match a track then the first match is used. +.IP +For the server to be able to calculate track lengths, there should be a +.B tracklength +command corresponding to each +.B player +command. .TP .B prefsync \fISECONDS\fR The interval at which the preferences log file will be synchronised. Defaults @@ -323,6 +335,20 @@ to 3600, i.e. one hour. The target size of the queue. If random play is enabled then randomly picked tracks will be added until the queue is at least this big. .TP +.B restrict \fR[\fBscratch\fR] [\fBremove\fR] [\fBmove\fR] +Determine which operations are restricted to the submitter of a +track. By default, no operations are restricted, i.e. anyone can +scratch or remove anything. +.IP +If \fBrestrict scratch\fR or \fBrestrict remove\fR are set then only the user +that submitted a track can scratch or remove it, respectively. +.IP +If \fBrestrict move\fR is set then only trusted users can move tracks around in +the queue. +.IP +If \fBrestrict\fR is used more than once then only the final use has any +effect. +.TP .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS Describes the sample format expected by the \fBspeaker_command\fR (below). The components of the format specification are as follows: @@ -341,6 +367,16 @@ The number of channels. .PP The default is .BR 16/44100/2 . +.PP +With the +.B network +backend the sample format is forced to +.B 16b/44100/2 +and with the +.B coreaudio +backend it is forced to +.BR 16/44100/2 , +in both cases regardless of what is specified in the configuration file. .RE .TP .B signal \fINAME\fR @@ -359,10 +395,18 @@ available: Use the ALSA API. This is only available on Linux systems, on which it is the default. .TP +.B coreaudio +Use Apple Core Audio. This only available on OS X systems, on which it is the +default. +.TP +.B oss +Use the OSS (/dev/dsp) API. Not available on all platforms. Not well +maintained at the moment. +.TP .B command Execute a command. This is the default if .B speaker_command -is specified, or (currently) on non-Linux systems. +is specified, or if no native is available. .TP .B network Transmit audio over the network. This is the default if @@ -389,20 +433,6 @@ is invoked to translate it. If .B sox is not installed then this will not work. .TP -.B restrict \fR[\fBscratch\fR] [\fBremove\fR] [\fBmove\fR] -Determine which operations are restricted to the submitter of a -track. By default, no operations are restricted, i.e. anyone can -scratch or remove anything. -.IP -If \fBrestrict scratch\fR or \fBrestrict remove\fR are set then only the user -that submitted a track can scratch or remove it, respectively. -.IP -If \fBrestrict move\fR is set then only trusted users can move tracks around in -the queue. -.IP -If \fBrestrict\fR is used more than once then only the final use has any -effect. -.TP .B scratch \fIPATH\fR Specifies a scratch. When a track is scratched, a scratch track is played at random. @@ -414,6 +444,10 @@ UTF-8 (which means that ASCII will do). .B stopword \fIWORD\fR ... Specifies one or more stopwords that should not take part in searches over track names. +.TP +.B tracklength \fIPATTERN\fR \fIMODULE\fR +Specifies the module used to calculate the length of files matching +\fIPATTERN\fR. \fIMODULE\fR specifies which plugin module to use. .SS "Client Configuration" .TP .B connect \fIHOST SERVICE\fR @@ -424,6 +458,10 @@ Connect to the address specified by \fIHOST\fR and port specified by .B refresh \fISECONDS\fR Specifies the maximum refresh period in seconds. Default 15. .TP +.B short_display \fICHARACTERS\fR +Defines the maximum number of characters to include in a \fBshort\fR name +part. Default 30. +.TP .B templates \fIPATH\fR ... Specifies the directory containing templates used by the web interface. If a template appears in more than one template directory @@ -485,6 +523,9 @@ Configuration files are read in the following order: .I pkgconfdir/config.private Should be readable only by the jukebox group, and contain \fBallow\fR commands for authorised users. +.IP +If this file does not exist at startup then the server will create it with a +randomly chosen password for the root user. .TP .I pkgconfdir/config.\fRUSER Per-user system-controlled client configuration. Optional but if it @@ -554,6 +595,9 @@ then the root directory is used. Provides a front end to \fBchoose.html\fR which allows subsets of the top level directories to be selected by initial letter. .TP +.B new.html +Lists newly added tracks. +.TP .B playing.html The "front page", which usually shows the currently playing tracks and the queue. @@ -584,8 +628,10 @@ Additionally, other standard files are included by these: .B credits.html Included at the end of the main content \fB
\fR element. .TP -.B sidebar.html -Included at the start of the \fB\fR element. +.B topbar.html +Included at the start of the \fB\fR element. (This supplants +\fBsidebar.html\fR, though the latter is still available; override label +\fBmenu\fR to choose between them.) .TP .B stdhead.html Included in the \fB\fR element. @@ -724,6 +770,10 @@ argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR. Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a loop, otherwise to \fBfalse\fR. .TP +.B @isnew@ +Expands to \fBtrue\fR if the newly added tracks list has any tracks in it, +otherwise to \fBfalse\fR. +.TP .B @isplaying@ Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR. .TP @@ -751,6 +801,10 @@ Usually used in \fBchoose.html\fR. .B @ne{\fIA\fB}{\fIB\fB} Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR. .TP +.B @new{\fITEMPLATE\fB} +Expands \fITEMPLATE\fR for each track in the newly added tracks list, starting +with the most recent. Used in \fBnew.html\fR. +.TP .B @nfiles@ Expands to the number of files from \fB@files\fR (above). .TP @@ -772,12 +826,18 @@ an even or odd position in \fB@queue@\fR, \fB@recent@\fR or \fB@files@\fR. .TP .B @part{\fICONTEXT\fB}{\fIPART\fB}@ Expands to track name part \fIPART\fR using context \fICONTEXT\fR for the -current track. The context may be omitted (and normally would be) and defaults +current track. The context may be omitted and defaults to \fBdisplay\fR. +.IP +The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to +the \fBshort_display\fR limit. .TP .B @part{\fICONTEXT\fB}{\fIPART\fB}{\fITRACK\fB}@ Expands to track name part \fIPART\fR using context \fICONTEXT\fR for \fITRACK\fR. In this usage the context may not be omitted. +.IP +The special context \fBshort\fR is equivalent to \fBdisplay\fR but limited to +the \fBshort_display\fR limit. .TP .B @paused@ Expands to \fBtrue\fR if the current track is paused, else \fBfalse\fR.