mention broadcast, broadcast_from in disorder_config(5)

[disorder] / doc / disorder_config.5.in

diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in
index 220b8f87c8b5d5a9fa8f7beac349278acc421604..95660eeb4f731359298c2cb56614b0cf7361a077 100644 (file)
--- a/doc/disorder_config.5.in
+++ b/doc/disorder_config.5.in
@@ -142,6 +142,32 @@ automatically included, but should include the proper extension.
 .IP
 The default is \fB{/artist}{/album}{/title}{ext}\fR.
 .TP
 .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
+.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
+.TP
+.B broadcast \fIADDRESS\fR \fIPORT\fR
+Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.  This implies
+\fBbackend network\fR.
+.TP
+.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
 your operating system and hardware, but some standard ones that might be useful
 .B channel \fICHANNEL\fR
 The mixer channel that the volume control should use.  Valid names depend on
 your operating system and hardware, but some standard ones that might be useful


@@ -296,6 +322,10 @@ If multiple player commands match a track then the first match is used.
 The interval at which the preferences log file will be synchronised.  Defaults
 to 3600, i.e. one hour.
 .TP
 The interval at which the preferences log file will be synchronised.  Defaults
 to 3600, i.e. one hour.
 .TP

+.B queue_pad \fICOUNT\fR
+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 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:
 .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:


@@ -323,12 +353,23 @@ 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
 Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR
 or \fBInterrupted\fR or whatever.
 .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
+is 0.
+.TP

 .B speaker_command \fICOMMAND
 Causes the speaker subprocess to pipe audio data into shell command
 \fICOMMAND\fR, rather than writing to a local sound card.  The sample format is
 determine by
 .B sample_format
 above.
 .B speaker_command \fICOMMAND
 Causes the speaker subprocess to pipe audio data into shell command
 \fICOMMAND\fR, rather than writing to a local sound card.  The sample format is
 determine by
 .B sample_format
 above.

+.IP
+Note that if the sample format is wrong then
+.BR sox (1)
+is invoked to translate it.  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
 .TP
 .B restrict \fR[\fBscratch\fR] [\fBremove\fR] [\fBmove\fR]
 Determine which operations are restricted to the submitter of a


@@ -1040,7 +1081,7 @@ In addition there are two built-in parts, \fBpath\fR which is the whole path
 name and \fBext\fR which is the filename extension, including the initial dot
 (or the empty string if there is not extension).
 .SH "SEE ALSO"
 name and \fBext\fR which is the filename extension, including the initial dot
 (or the empty string if there is not extension).
 .SH "SEE ALSO"

-\fBdisorder\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
+\fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),

 \fBpcrepattern\fR(3)
 .\" Local Variables:
 .\" mode:nroff
 \fBpcrepattern\fR(3)
 .\" Local Variables:
 .\" mode:nroff