.\"
-.\" Copyright (C) 2004, 2005, 2006 Richard Kettlewell
+.\" Copyright (C) 2004, 2005, 2006, 2007 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
.IP
The default is \fB{/artist}{/album}{/title}{ext}\fR.
.TP
+.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 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
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).
.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
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:
+.RS
+.TP 10
+.I BITS
+The number of bits per sample. Optionally, may be suffixed by \fBb\fR or
+\fBl\fR for big-endian and little-endian words. If neither is used the native
+byte order is assumed.
+.TP
+.I RATE
+The number of samples per second.
+.TP
+.I CHANNELS
+The number of channels.
+.PP
+The default is
+.BR 16/44100/2 .
+.RE
+.TP
.B signal \fINAME\fR
Defines the signal to be sent to track player process groups when tracks are
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
+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.
+.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
track. By default, no operations are restricted, i.e. anyone can
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
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
.\" fill-column:79
.\" End:
-.\" arch-tag:43b51c6f7ce647119d5409797c55908e
~mdw / disorder / blobdiff