chiark / gitweb /
relax config file checking for non-server programs
[disorder] / doc / disorder_config.5.in
index be922d2eb582e5dda1d9c750a9622a48de07231c..efb7a306a19701d92347c8bfc12c7574f9714174 100644 (file)
@@ -142,6 +142,12 @@ automatically included, but should include the proper extension.
 .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.
@@ -212,6 +218,11 @@ Determines whether the server locks against concurrent operation.  Default is
 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).
@@ -242,7 +253,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
@@ -284,7 +295,12 @@ The command is expected to know how to open its own sound device.
 .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
@@ -350,7 +366,9 @@ is specified, or (currently) on non-Linux systems.
 .TP
 .B network
 Transmit audio over the network.  This is the default if
-\fBbroadcast\fR is specified.
+\fBbroadcast\fR is specified.  You can use
+.BR disorder-playrtp (1)
+to receive and play the resulting stream on Linux and OS X.
 .RE
 .TP
 .B sox_generation \fB0\fR|\fB1
@@ -398,10 +416,9 @@ Specifies one or more stopwords that should not take part in searches
 over track names.
 .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