conf: registered option "filter"

Add this option to the user's manual.
This commit is contained in:
Max Kellermann 2009-07-05 06:54:45 +02:00
parent 666b1fae79
commit 644fc48776
2 changed files with 58 additions and 0 deletions

View File

@ -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>

View File

@ -94,6 +94,7 @@ static struct config_entry config_entries[] = {
{ .name = CONF_DECODER, true, true },
{ .name = CONF_INPUT, true, true },
{ .name = CONF_GAPLESS_MP3_PLAYBACK, false, false },
{ .name = "filter", true, true },
};
static bool