Mention Unicode 5.1.0 in CHANGES.html.

[disorder] / doc / disorder_config.5.in

diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in
index 0364126..1813152 100644 (file)
--- a/doc/disorder_config.5.in
+++ b/doc/disorder_config.5.in
@@ -1,5 +1,5 @@
 .\"
 .\"

-.\" Copyright (C) 2004-2008 Richard Kettlewell
+.\" Copyright (C) 2004-2009 Richard Kettlewell

 .\"
 .\" This program is free software: you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by
 .\"
 .\" This program is free software: you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by


@@ -275,13 +275,19 @@ Execute a command.
 This is the default if
 .B speaker_command
 is specified, or if no native is available.
 This is the default if
 .B speaker_command
 is specified, or if no native is available.

+.IP
+You might want to set
+.B pause_mode
+with this backend.

 .TP
 .TP

-.B network
+.B rtp

 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.
 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.

+.B network
+is a deprecated synonym for this API.

 .RE
 .TP
 .B authorization_algorithm \fIALGORITHM\fR
 .RE
 .TP
 .B authorization_algorithm \fIALGORITHM\fR


@@ -291,14 +297,22 @@ See
 .BR disorder_protocol (5)
 for more details.
 .TP
 .BR disorder_protocol (5)
 for more details.
 .TP

-.B broadcast \fIADDRESS\fR \fIPORT\fR
+.B broadcast \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR

 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.
 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.

-This implies \fBapi network\fR.
+This implies \fBapi rtp\fR.
+.IP
+\fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
+implied by \fIADDRESS\fR.
+Note that IPv6 is not currently well tested.

 .IP
 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
 .TP
 .IP
 See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR.
 .TP

-.B broadcast_from \fIADDRESS\fR \fIPORT\fR
+.B broadcast_from \fR[\fIFAMILY\fR] \fIADDRESS\fR \fIPORT\fR

 Sets the (local) source address used by \fBbroadcast\fR.
 Sets the (local) source address used by \fBbroadcast\fR.

+.IP
+\fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
+implied by \fIADDRESS\fR.
+Note that IPv6 is not currently well tested.

 .TP
 .B channel \fICHANNEL\fR
 The mixer channel that the volume control should use.
 .TP
 .B channel \fICHANNEL\fR
 The mixer channel that the volume control should use.


@@ -307,6 +321,7 @@ For \fBapi oss\fR the possible values are:
 .RS
 .TP 8
 .B pcm
 .RS
 .TP 8
 .B pcm

+

 Output level for the audio device.
 This is probably what you want and is the default.
 .TP
 Output level for the audio device.
 This is probably what you want and is the default.
 .TP


@@ -407,10 +422,14 @@ reinstated.
 Specifies the number of recently played tracks to remember (including
 failed tracks and scratches).
 .TP
 Specifies the number of recently played tracks to remember (including
 failed tracks and scratches).
 .TP

-.B listen \fR[\fIHOST\fR] \fISERVICE\fR
+.B listen \fR[\fIFAMILY\fR] \fR[\fIHOST\fR] \fISERVICE\fR

 Listen for connections on the address specified by \fIHOST\fR and port
 specified by \fISERVICE\fR.
 Listen for connections on the address specified by \fIHOST\fR and port
 specified by \fISERVICE\fR.

-If \fIHOST\fR is omitted then listens on all local addresses.
+If \fIHOST\fR is omitted, or is \fB*\fR, then listens on all local addresses.
+.IP
+\fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
+implied by \fIHOST\fR.
+Note that IPv6 is not currently well tested.

 .IP
 Normally the server only listens on a UNIX domain socket.
 .TP
 .IP
 Normally the server only listens on a UNIX domain socket.
 .TP


@@ -435,12 +454,12 @@ For \fBapi coreaudio\fR, volume setting is not currently supported.
 .B multicast_loop yes\fR|\fBno
 Determines whether multicast packets are loop backed to the sending host.
 The default is \fByes\fR.
 .B multicast_loop yes\fR|\fBno
 Determines whether multicast packets are loop backed to the sending host.
 The default is \fByes\fR.

-This only applies if \fBapi\fR is set to \fBnetwork\fR and \fBbroadcast\fR
+This only applies if \fBapi\fR is set to \fBrtp\fR and \fBbroadcast\fR

 is actually a multicast address.
 .TP
 .B multicast_ttl \fIHOPS\fR
 Set the maximum number of hops to send multicast packets.
 is actually a multicast address.
 .TP
 .B multicast_ttl \fIHOPS\fR
 Set the maximum number of hops to send multicast packets.

-This only applies if \fBapi\fR is set to \fBnetwork\fR and
+This only applies if \fBapi\fR is set to \fBrtp\fR and

 \fBbroadcast\fR is actually a multicast address.
 The default is 1.
 .TP
 \fBbroadcast\fR is actually a multicast address.
 The default is 1.
 .TP


@@ -525,6 +544,19 @@ The maximum days that a track can survive in the database of newly added
 tracks.
 The default is 31.
 .TP
 tracks.
 The default is 31.
 .TP

+.B pause_mode \fIMODE
+Sets the pause mode for the \fBcommand\fR backend.
+The possible values are:
+.RS
+.TP
+.B silence
+Send silent (0-value) samples when paused.
+This is the default.
+.TP
+.B suspend
+Stop writing when paused.
+.RE
+.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.
 .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.


@@ -628,7 +660,7 @@ The default is
 .BR 16/44100/2 .
 .PP
 With the
 .BR 16/44100/2 .
 .PP
 With the

-.B network
+.B rtp

 backend the sample format is forced to
 .B 16b/44100/2
 and with the
 backend the sample format is forced to
 .B 16b/44100/2
 and with the


@@ -710,9 +742,13 @@ These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR
 or
 \fIpkgconfdir/config.\fRUSERNAME.
 .TP
 or
 \fIpkgconfdir/config.\fRUSERNAME.
 .TP

-.B connect \fIHOST SERVICE\fR
+.B connect \fR[\fIFAMILY\fR] \fIHOST SERVICE\fR

 Connect to the address specified by \fIHOST\fR and port specified by
 \fISERVICE\fR.
 Connect to the address specified by \fIHOST\fR and port specified by
 \fISERVICE\fR.

+.IP
+\fIFAMILY\fR can be \fB-4\fR or \fB-6\fR to force IPv4 or IPv6, if this is not
+implied by \fIHOST\fR.
+Note that IPv6 is not currently well tested.

 .TP
 .B password \fIPASSWORD\fR
 Specify password.
 .TP
 .B password \fIPASSWORD\fR
 Specify password.