Merge branch 'v0.18.x'

2 files changed, 97 insertions, 131 deletions

diff --git a/doc/mpd.conf.5 b/doc/mpd.conf.5
index d92033179..6e3bae7b2 100644
--- a/doc/mpd.conf.5
+++ b/doc/mpd.conf.5
@@ -316,137 +316,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
 users do not need to change this.  The default is 256000000 / sample_rate(kHz),
 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 OPTIONAL AO OUTPUT PARAMETERS
-.TP
-.B driver <driver>
-This specifies the libao driver to use for audio output.  Possible values
-depend on what libao drivers are available.  See
-<\fBhttp://www.xiph.org/ao/doc/drivers.html\fP> for information on some
-commonly used drivers.  Typical values for Linux include "oss" and "alsa09".
-The default is "default", which causes libao to select an appropriate plugin.
-.TP
-.B options <opts>
-This specifies the options to use for the selected libao driver.  For oss, the
-only option available is "dsp".  For alsa09, the available options are: "dev",
-"buf_size", and "periods".  See <\fBhttp://www.xiph.org/ao/doc/drivers.html\fP>
-for available options for some commonly used drivers.  Options are assigned
-using "=", and ";" is used to separate options.  An example for oss:
-"dsp=/dev/dsp".  An example for alsa09: "dev=hw:0,0;buf_size=4096".  The
-default is "".
-.TP
-.B write_size <size in bytes>
-This specifies how many bytes to write to the audio device at once.  This
-parameter is to work around a bug in older versions of libao on sound cards
-with very small buffers.  The default is 1024.
-.SH REQUIRED FIFO OUTPUT PARAMETERS
-.TP
-.B path <path>
-This specifies the path of the FIFO to output to.  Must be an absolute path.
-If the path does not exist it will be created when mpd is started, and removed
-when mpd is stopped.  The FIFO will be created with the same user and group as
-mpd is running as.  Default permissions can be modified by using the builtin
-shell command "umask".  If a FIFO already exists at the specified path it will
-be reused, and will \fBnot\fP be removed when mpd is stopped.  You can use the
-"mkfifo" command to create this, and then you may modify the permissions to
-your liking.
-.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
 .TP
 .BI ~/.mpdconf
diff --git a/doc/user.xml b/doc/user.xml
index 05b9825d5..f07aba6c2 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -1555,6 +1555,59 @@ systemctl start mpd.socket</programlisting>
           The <varname>ao</varname> plugin uses the portable
           <filename>libao</filename> library.
         </para>
+
+        <informaltable>
+          <tgroup cols="2">
+            <thead>
+              <row>
+                <entry>Setting</entry>
+                <entry>Description</entry>
+              </row>
+            </thead>
+            <tbody>
+              <row>
+                <entry>
+                  <varname>driver</varname>
+                  <parameter>D</parameter>
+                </entry>
+                <entry>
+                  The <filename>libao</filename> driver to use for
+                  audio output.  Possible values depend on what libao
+                  drivers are available.  See <ulink
+                  url="http://www.xiph.org/ao/doc/drivers.html">http://www.xiph.org/ao/doc/drivers.html</ulink>
+                  for information on some commonly used drivers.
+                  Typical values for Linux include "oss" and "alsa09".
+                  The default is "default", which causes libao to
+                  select an appropriate plugin.
+                </entry>
+              </row>
+
+              <row>
+                <entry>
+                  <varname>options</varname>
+                  <parameter>O</parameter>
+                </entry>
+                <entry>
+                  Options to pass to the selected
+                  <filename>libao</filename> driver.
+                </entry>
+              </row>
+
+              <row>
+                <entry>
+                  <varname>write_size</varname>
+                  <parameter>O</parameter>
+                </entry>
+                <entry>
+                  This specifies how many bytes to write to the audio
+                  device at once.  This parameter is to work around a
+                  bug in older versions of libao on sound cards with
+                  very small buffers.  The default is 1024.
+                </entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </informaltable>
       </section>
 
       <section>
@@ -1565,6 +1618,38 @@ systemctl start mpd.socket</programlisting>
           FIFO (First In, First Out) file.  The data can be read by
           another program.
         </para>
+
+        <informaltable>
+          <tgroup cols="2">
+            <thead>
+              <row>
+                <entry>Setting</entry>
+                <entry>Description</entry>
+              </row>
+            </thead>
+            <tbody>
+              <row>
+                <entry>
+                  <varname>path</varname>
+                  <parameter>P</parameter>
+                </entry>
+                <entry>
+                  This specifies the path of the FIFO to write to.
+                  Must be an absolute path.  If the path does not
+                  exist, it will be created when MPD is started, and
+                  removed when MPD is stopped.  The FIFO will be
+                  created with the same user and group as MPD is
+                  running as.  Default permissions can be modified by
+                  using the builtin shell command "umask".  If a FIFO
+                  already exists at the specified path it will be
+                  reused, and will not be removed when MPD is stopped.
+                  You can use the "mkfifo" command to create this, and
+                  then you may modify the permissions to your liking.
+                </entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </informaltable>
       </section>
 
       <section>
@@ -2042,6 +2127,18 @@ systemctl start mpd.socket</programlisting>
               </row>
               <row>
                 <entry>
+                  <varname>protocol</varname>
+                  <parameter>icecast2|icecast1|shoutcast</parameter>
+                </entry>
+                <entry>
+                  Specifies the protocol that wil be used to connect
+                  to the icecast/shoutcast server.  The default
+                  is "<parameter>icecast2</parameter>".
+
+                </entry>
+              </row>
+              <row>
+                <entry>
                   <varname>mount</varname>
                   <parameter>URI</parameter>
                 </entry>