aboutsummaryrefslogtreecommitdiff
path: root/doc/user.xml
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2009-07-05 06:54:45 +0200
committerMax Kellermann <max@duempel.org>2009-07-05 06:54:45 +0200
commit644fc4877642078c63cf13d6e65d6a3e7272996b (patch)
tree505e2a1c59a0c2c06b1feab10681962462113641 /doc/user.xml
parent666b1fae798f44d3fdb98d61403455ff061e39ba (diff)
conf: registered option "filter"
Add this option to the user's manual.
Diffstat (limited to 'doc/user.xml')
-rw-r--r--doc/user.xml57
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/user.xml b/doc/user.xml
index e230f383..787f3e3b 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>