X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/637fdea366a8a87024322d283eba89067a403493..8439fcfd559f48968cb88d7efd671e6e4bd664a2:/doc/disorder_config.5.in diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in index b1ea0b1..744bf13 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 @@ -253,7 +255,7 @@ them. See the example config file for the defaults. Set the recan subprocess priority. The default is 10. .IP (Note that higher values mean the process gets less CPU time; UNIX priority -values are the backwards.) +values are backwards.) .TP .B nice_server \fIPRIORITY\fR Set the server priority. This is applied to the server at startup time (and @@ -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. @@ -341,6 +347,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 +375,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 @@ -485,6 +509,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 +581,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 +614,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 +756,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 +787,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