+
.\"
.\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
.\"
.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
.IP
The default is \fB{/artist}{/album}{/title}{ext}\fR.
.TP
+.B authorization_algorthm \fIALGORITHM\fR
+Defines the algorithm used to authenticate clients. The valid options
+are sha1 (the default), sha256, sha384 and sha512. See
+.BR disorder_protocol (5)
+for more details.
+.TP
.B broadcast \fIADDRESS\fR \fIPORT\fR
Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. This implies
\fBspeaker_backend network\fR.
The path to the mixer device, if you want access to the volume control,
e.g. \fB/dev/mixer\fR.
.TP
+.B multicast_ttl \fIHOPS\fR
+Set the maximum number of hops to send multicast packets. This only applies is
+\fBspeaker_backend\fR is set to \fBnetwork\fR and \fBbroadcast\fR is actually a
+multicast address.
+.TP
.B namepart \fIPART\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]]
Determines how to extract trackname part \fIPART\fR from a
track name (with the collection root part removed).
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
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.
.TP
.B execraw \fICOMMAND\fR \fIARGS\fR...
Identical to the \fBexec\fR except that the player is expected to use the
-DisOrder raw player protocol (see notes below).
+DisOrder raw player protocol.
+.BR disorder-decode (8)
+can decode several common audio file formats to this format. If your favourite
+format is not supported, but you have a player which uses libao, there is also
+a libao driver which supports this format; see below for more information about
+this.
.TP
.B shell \fR[\fISHELL\fR] \fICOMMAND\fR
The command is executed using the shell. If \fISHELL\fR is specified then that
.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
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:
.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
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
.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.
.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 \fR[\fIHOST\fR] \fISERVICE\fR
+.B connect \fIHOST SERVICE\fR
Connect to the address specified by \fIHOST\fR and port specified by
-\fISERVICE\fR. If \fIHOST\fR is omitted then connects to the local host.
-Normally the UNIX domain socket is used instead.
+\fISERVICE\fR.
.SS "Web Interface Configuration"
.TP
.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
.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
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.
.B credits.html
Included at the end of the main content \fB<DIV>\fR element.
.TP
-.B sidebar.html
-Included at the start of the \fB<BODY>\fR element.
+.B topbar.html
+Included at the start of the \fB<BODY>\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<HEAD>\fR element.
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
.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
.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.
~mdw / disorder / blobdiff