From 644fc4877642078c63cf13d6e65d6a3e7272996b Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Sun, 5 Jul 2009 06:54:45 +0200
Subject: conf: registered option "filter"

Add this option to the user's manual.
---
 doc/user.xml | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

(limited to 'doc')

diff --git a/doc/user.xml b/doc/user.xml
index e230f3837..787f3e3bd 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -302,6 +302,63 @@ cd mpd-0.14.2</programlisting>
         </tgroup>
       </informaltable>
     </section>
+
+    <section>
+      <title>Configuring filters</title>
+
+      <para>
+        Filters are plugins which modify an audio stream.
+      </para>
+
+      <para>
+        To configure a filter, add a <varname>filter</varname> block
+        to <filename>mpd.conf</filename>:
+      </para>
+
+      <programlisting>filter {
+    plugin "volume"
+    name "software volume"
+}
+      </programlisting>
+
+      <para>
+        The following table lists the <varname>filter</varname>
+        options valid for all plugins:
+      </para>
+
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>
+                Name
+              </entry>
+              <entry>
+                Description
+              </entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry>
+                <varname>plugin</varname>
+              </entry>
+              <entry>
+                The name of the plugin.
+              </entry>
+            </row>
+            <row>
+              <entry>
+                <varname>name</varname>
+              </entry>
+              <entry>
+                The name of the filter.
+              </entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </section>
   </chapter>
 
   <chapter>
-- 
cgit v1.2.3