doc/mpd.conf.5: remove redundant documentation
The real and detailed documentation is in the user manual.
This commit is contained in:
Max Kellermann
parent
82a89c6bfe
commit
db4ae19246
@ -363,104 +363,6 @@ errors on bandwidth-limited devices. Some users have reported good results
|
|||||||
with this set to 50000, but not all devices support values this high. Most
|
with this set to 50000, but not all devices support values this high. Most
|
||||||
users do not need to change this. The default is 256000000 / sample_rate(kHz),
|
users do not need to change this. The default is 256000000 / sample_rate(kHz),
|
||||||
or 5804 microseconds for CD-quality audio.
|
or 5804 microseconds for CD-quality audio.
|
||||||
.SH OPTIONAL OSS OUTPUT PARAMETERS
|
|
||||||
.TP
|
|
||||||
.B device <dev>
|
|
||||||
This specifies the device to use for audio output. The default is "/dev/dsp".
|
|
||||||
.TP
|
|
||||||
.B mixer_device <mixer dev>
|
|
||||||
This specifies which mixer to use. The default is "/dev/mixer".
|
|
||||||
.TP
|
|
||||||
.B mixer_control <mixer ctrl>
|
|
||||||
This specifies which mixer control to use (sometimes referred to as the
|
|
||||||
"device"). The default is to use the main PCM mixer. An example is "Pcm".
|
|
||||||
.SH OPTIONAL PULSE OUTPUT PARAMETERS
|
|
||||||
.TP
|
|
||||||
.B server <server list>
|
|
||||||
A space separated list of servers to try to connect to. See
|
|
||||||
<\fBhttp://www.pulseaudio.org/wiki/ServerStrings\fP> for more details. The
|
|
||||||
default is to let PulseAudio choose a server.
|
|
||||||
If you specify more than one server name, MPD tries to connect to one
|
|
||||||
after another until it successfully establishes a connection.
|
|
||||||
.TP
|
|
||||||
.B sink <sink>
|
|
||||||
The sink to output to. The default is to let PulseAudio choose a sink.
|
|
||||||
.SH OPTIONAL JACK OUTPUT PARAMETERS
|
|
||||||
.TP
|
|
||||||
.B client_name <name>
|
|
||||||
The client name to use when connecting to JACK. The output ports <name>:left
|
|
||||||
and <name>:right will also be created for the left and right channels,
|
|
||||||
respectively.
|
|
||||||
.TP
|
|
||||||
.B ports <left_port,right_port>
|
|
||||||
This specifies the left and right ports to connect to for the left and right
|
|
||||||
channels, respectively. The default is to let JACK choose a pair of ports.
|
|
||||||
.TP
|
|
||||||
.B ringbuffer_size <size in bytes>
|
|
||||||
This specifies the size of the ringbuffer in bytes. The default is 32768.
|
|
||||||
.SH REQUIRED SHOUT OUTPUT PARAMETERS
|
|
||||||
.TP
|
|
||||||
.B name <name>
|
|
||||||
This specifies not only the unique audio output name, but also the stream
|
|
||||||
title.
|
|
||||||
.TP
|
|
||||||
.B host <hostname>
|
|
||||||
This specifies the hostname of the icecast server to connect to.
|
|
||||||
.TP
|
|
||||||
.B port <port>
|
|
||||||
This specifies the port of the icecast server to connect to.
|
|
||||||
.TP
|
|
||||||
.B mount <mountpoint>
|
|
||||||
This specifies the icecast mountpoint to use.
|
|
||||||
.TP
|
|
||||||
.B password <password>
|
|
||||||
This specifies the password to use when logging in to the icecast server.
|
|
||||||
.TP
|
|
||||||
.B quality <quality>
|
|
||||||
This specifies the encoding quality to use. The value must be between 0
|
|
||||||
and 10. Fractional values, such as 2.5, are permitted. Either the quality or
|
|
||||||
the bitrate parameter must be specified, but not both. For Ogg, a
|
|
||||||
higher quality number produces higher quality output. For MP3, it's
|
|
||||||
just the opposite, with lower numbers producing higher quality output.
|
|
||||||
.TP
|
|
||||||
.B bitrate <kbps>
|
|
||||||
This specifies the bitrate to use for encoding. Either the quality or the
|
|
||||||
bitrate parameter must be specified, but not both.
|
|
||||||
.TP
|
|
||||||
.B format <sample_rate:bits:channels>
|
|
||||||
This specifies the sample rate, bits per sample, and number of channels to use
|
|
||||||
for encoding.
|
|
||||||
.SH OPTIONAL SHOUT OUTPUT PARAMETERS
|
|
||||||
.TP
|
|
||||||
.B encoding <encoding>
|
|
||||||
This specifies which output encoding to use. Should be either "ogg"
|
|
||||||
or "mp3", "mp3" is needed for shoutcast streaming. The default is "ogg".
|
|
||||||
.TP
|
|
||||||
.B protocol <protocol>
|
|
||||||
This specifies the protocol that wil be used to connect to the
|
|
||||||
icecast/shoutcast server. The options are "shoutcast", "icecast1" and
|
|
||||||
"icecast2". The default is "icecast2".
|
|
||||||
.TP
|
|
||||||
.B user <username>
|
|
||||||
This specifies the username to use when logging in to the icecast server. The
|
|
||||||
default is "source".
|
|
||||||
.TP
|
|
||||||
.B public <yes or no>
|
|
||||||
This specifies whether to request that the stream be listed in all public
|
|
||||||
stream directories that the icecast server knows about. The default is no.
|
|
||||||
.TP
|
|
||||||
.B timeout <seconds>
|
|
||||||
This specifies the number of seconds to wait before giving up on trying to
|
|
||||||
connect to the icecast server. The default is 2 seconds.
|
|
||||||
.TP
|
|
||||||
.B description <description>
|
|
||||||
This specifies a description of the stream.
|
|
||||||
.TP
|
|
||||||
.B url <url>
|
|
||||||
This specifies a URL associated with the stream.
|
|
||||||
.TP
|
|
||||||
.B genre <genre>
|
|
||||||
This specifies the genre(s) of the stream.
|
|
||||||
.SH FILES
|
.SH FILES
|
||||||
.TP
|
.TP
|
||||||
.BI ~/.mpdconf
|
.BI ~/.mpdconf
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user