update README.client text

[disorder] / doc / disorder_config.5.in

diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in
index 299233d7c82325f649bc1413d81f0a1c2e75cb11..4cde04fcf7bd388c7453a47c6cdca0580e6f50c7 100644 (file)
--- a/doc/disorder_config.5.in
+++ b/doc/disorder_config.5.in
@@ -142,24 +142,12 @@ automatically included, but should include the proper extension.
 .IP
 The default is \fB{/artist}{/album}{/title}{ext}\fR.
 .TP
-.B backend \fINAME\fR
-Selects the backend use by the speaker process.  The following options are
-available:
-.RS
+.B broadcast \fIADDRESS\fR \fIPORT\fR
+Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.  This implies
+\fBspeaker_backend network\fR.
 .TP
-.B alsa
-Use the ALSA API.  This is only available on Linux systems, on which it is the
-default.
-.TP
-.B command
-Execute a command.  This is the default if
-.B speaker_command
-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.
-.RE
+.B broadcast_from \fIADDRESS\fR \fIPORT\fR
+Sets the (local) source address used by \fBbroadcast\fR.
 .TP
 .B channel \fICHANNEL\fR
 The mixer channel that the volume control should use.  Valid names depend on
@@ -224,6 +212,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).
@@ -296,7 +289,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
@@ -346,6 +344,27 @@ scratched.  The default is \fBSIGKILL\fR.
 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
 or \fBInterrupted\fR or whatever.
 .TP
+.B speaker_backend \fINAME\fR
+Selects the backend use by the speaker process.  The following options are
+available:
+.RS
+.TP
+.B alsa
+Use the ALSA API.  This is only available on Linux systems, on which it is the
+default.
+.TP
+.B command
+Execute a command.  This is the default if
+.B speaker_command
+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.  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
 Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
 the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1).  The default
@@ -391,10 +410,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