From 82a89c6bfe152cea692ad143f9557016102f742d Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Wed, 11 Dec 2013 21:03:11 +0100
Subject: doc/user: document the "ao" output

Move from doc/mpd.conf.5.
---
 doc/mpd.conf.5 | 22 ----------------------
 doc/user.xml   | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 53 insertions(+), 22 deletions(-)

(limited to 'doc')

diff --git a/doc/mpd.conf.5 b/doc/mpd.conf.5
index c697eba88..eafff086a 100644
--- a/doc/mpd.conf.5
+++ b/doc/mpd.conf.5
@@ -398,28 +398,6 @@ 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 SHOUT OUTPUT PARAMETERS
 .TP
 .B name <name>
diff --git a/doc/user.xml b/doc/user.xml
index d90fce9c6..99278a69b 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -1398,6 +1398,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>
-- 
cgit v1.2.3