X-Git-Url: https://git.distorted.org.uk/~mdw/disorder/blobdiff_plain/7f824aad72d99e320abc9aee722242c693c07579..e41a99999ec696e848b8ea1c8953ae7dc88f9d6d:/doc/disorder_config.5.in diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in index 20c9e8b..85135f5 100644 --- a/doc/disorder_config.5.in +++ b/doc/disorder_config.5.in @@ -1,20 +1,18 @@ .\" -.\" Copyright (C) 2004-2008 Richard Kettlewell +.\" Copyright (C) 2004-2009 Richard Kettlewell .\" -.\" This program is free software; you can redistribute it and/or modify +.\" 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 -.\" the Free Software Foundation; either version 2 of the License, or +.\" the Free Software Foundation, either version 3 of the License, or .\" (at your option) any later version. -.\" -.\" This program is distributed in the hope that it will be useful, but -.\" WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -.\" General Public License for more details. -.\" +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" .\" You should have received a copy of the GNU General Public License -.\" along with this program; if not, write to the Free Software -.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 -.\" USA +.\" along with this program. If not, see . .\" .TH disorder_config 5 .SH NAME @@ -277,13 +275,19 @@ Execute a command. 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 -.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. +.B network +is a deprecated synonym for this API. .RE .TP .B authorization_algorithm \fIALGORITHM\fR @@ -295,7 +299,7 @@ for more details. .TP .B broadcast \fIADDRESS\fR \fIPORT\fR Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. -This implies \fBapi network\fR. +This implies \fBapi rtp\fR. .IP See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR. .TP @@ -388,7 +392,12 @@ will be tried. .IP For \fBapi alsa\fR this is the device name to use. .IP -For \fBapi coreaudio\fR this is currently ignored. +For \fBapi coreaudio\fR this can be either the UID or the human-readable +name of the desired device. +For a list of names, visit System Preferences -> Sound and look at the Type column. +For example, you might use "Built-in Output" for the built-in speaker +or "Built-in Line Output" if you have connected external speakers. +Remember to quote the name. .IP The default is \fBdefault\fR, which is intended to map to whatever the system's default is. @@ -432,12 +441,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. -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. -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 @@ -479,7 +488,7 @@ namepart ext "(\\.[a-zA-Z0-9]+)$" $1 * .TP .B new_bias \fIWEIGHT\fR The weight for new tracks. -The default is 900000, i.e. recently added tracks are a hundred times as likely +The default is 450000, i.e. recently added tracks are a fifty times as likely to be picked as normal. .TP .B new_bias_age \fISECONDS\fR @@ -522,6 +531,19 @@ The maximum days that a track can survive in the database of newly added 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. @@ -625,7 +647,7 @@ The default is .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 @@ -648,7 +670,10 @@ Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (i the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1). See the documentation for your installed copy of \fBsox\fR to determine which you need. -The default is 0. +The default is set according to the version of sox found when DisOrder was +built. +If you run on a system with a different version of sox, you will need to +set this option. .TP .B speaker_backend \fINAME This is an alias for \fBapi\fR; see above.