diff options
Diffstat (limited to 'doc/user.xml')
| -rw-r--r-- | doc/user.xml | 207 |
1 files changed, 131 insertions, 76 deletions
diff --git a/doc/user.xml b/doc/user.xml index 38d8a9d85..0f84800c1 100644 --- a/doc/user.xml +++ b/doc/user.xml @@ -165,6 +165,53 @@ systemctl start mpd.socket</programlisting> </section> <section> + <title>Configuring database plugins</title> + + <para> + If a music directory is configured, one database plugin is + used. To configure this plugin, add a + <varname>database</varname> block to + <filename>mpd.conf</filename>: + </para> + + <programlisting>database { + plugin "simple" + path "/var/lib/mpd/db" +} + </programlisting> + + <para> + The following table lists the <varname>database</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> + </tbody> + </tgroup> + </informaltable> + </section> + + <section> <title>Configuring input plugins</title> <para> @@ -391,6 +438,18 @@ systemctl start mpd.socket</programlisting> </row> <row> <entry> + <varname>tags</varname> + <parameter>yes|no</parameter> + </entry> + <entry> + If set to "no", then MPD will not send tags to this + output. This is only useful for output plugins that + can receive tags, for example the + <varname>httpd</varname> output plugin. + </entry> + </row> + <row> + <entry> <varname>always_on</varname> <parameter>yes|no</parameter> </entry> @@ -618,6 +677,78 @@ systemctl start mpd.socket</programlisting> <title>Plugin reference</title> <section> + <title>Database plugins</title> + + <section> + <title><varname>simple</varname></title> + + <para> + The default plugin. Stores a copy of the database in + memory. A file is used for permanent storage. + </para> + + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Setting</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <varname>path</varname> + </entry> + <entry> + The path of the database file. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </section> + + <section> + <title><varname>proxy</varname></title> + + <para> + Provides access to the database of another MPD instance + using <filename>libmpdclient</filename>. Experimental! + </para> + + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Setting</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <varname>host</varname> + </entry> + <entry> + The host name of the "master" MPD instance. + </entry> + </row> + <row> + <entry> + <varname>port</varname> + </entry> + <entry> + The port number of the "master" MPD instance. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </section> + </section> + + <section> <title>Input plugins</title> <section> @@ -744,35 +875,6 @@ systemctl start mpd.socket</programlisting> </tgroup> </informaltable> </section> - - <section> - <title><varname>soup</varname></title> - - <para> - Opens remote files or streams over HTTP. - </para> - - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>Setting</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry> - <varname>proxy</varname> - </entry> - <entry> - Sets the address of the HTTP proxy server. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </section> </section> <section> @@ -1241,43 +1343,6 @@ systemctl start mpd.socket</programlisting> </section> <section> - <title><varname>ffado</varname></title> - - <para> - The <varname>ffado</varname> plugin connects to FireWire - audio devices via <filename>libffado</filename>. - </para> - - <para> - Warning: this plugin was not tested successfully. I just - couldn't keep libffado2 from crashing. Use at your own - risk. - </para> - - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>Setting</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry> - <varname>device</varname> - <parameter>NAME</parameter> - </entry> - <entry> - Sets the device which should be used, e.g. "hw:0". - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </section> - - <section> <title><varname>jack</varname></title> <para> @@ -1362,16 +1427,6 @@ systemctl start mpd.socket</programlisting> </section> <section> - <title><varname>mvp</varname></title> - - <para> - The <varname>mvp</varname> plugin uses the proprietary - Hauppauge Media MVP interface. We do not know any user of - this plugin, and we do not know if it actually works. - </para> - </section> - - <section> <title><varname>httpd</varname></title> <para> |