diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer.xml | 2 | ||||
| -rw-r--r-- | doc/doxygen.conf.in | 2 | ||||
| -rw-r--r-- | doc/mpd.1 | 4 | ||||
| -rw-r--r-- | doc/mpd.conf.5 | 10 | ||||
| -rw-r--r-- | doc/protocol.xml | 14 | ||||
| -rw-r--r-- | doc/user.xml | 248 |
6 files changed, 156 insertions, 124 deletions
diff --git a/doc/developer.xml b/doc/developer.xml index 010b85064..eb318fa5a 100644 --- a/doc/developer.xml +++ b/doc/developer.xml @@ -61,7 +61,7 @@ foo(const char *abc, int xyz) { if (abc == NULL) { - g_warning("Foo happened!\n"); + LogWarning("Foo happened!"); return -1; } diff --git a/doc/doxygen.conf.in b/doc/doxygen.conf.in index 95dca9a3c..1d9d0ca7c 100644 --- a/doc/doxygen.conf.in +++ b/doc/doxygen.conf.in @@ -1158,7 +1158,7 @@ INCLUDE_FILE_PATTERNS = # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = G_GNUC_UNUSED= +PREDEFINED = # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. @@ -12,8 +12,8 @@ stores info about all available music, and this info can be easily searched and retrieved. Player control, info retrieval, and playlist management can all be managed remotely. -MPD searches for a config file in \fB~/.mpdconf\fP then \fB/etc/mpd.conf\fP or -uses CONF_FILE. +MPD searches for a config file in \fB$XDG_CONFIG_HOME/mpd/mpd.conf\fP then +\fB~/.mpdconf\fP then \fB/etc/mpd.conf\fP or uses CONF_FILE. Read more about MPD at <\fBhttp://www.musicpd.org/\fP>. .SH OPTIONS diff --git a/doc/mpd.conf.5 b/doc/mpd.conf.5 index 62f5565e1..b3a46e157 100644 --- a/doc/mpd.conf.5 +++ b/doc/mpd.conf.5 @@ -3,8 +3,9 @@ mpd.conf \- Music Player Daemon configuration file .SH DESCRIPTION \fBmpd.conf\fP is the configuration file for mpd(1). If not specified on the -command line, MPD first searches for it at \fB~/.mpdconf\fP then at -\fB~/.mpd/mpd.conf\fP and then in \fB/etc/mpd.conf\fP. +command line, MPD first searches for it at \fB$XDG_CONFIG_HOME/mpd/mpd.conf\fP +then at \fB~/.mpdconf\fP then at \fB~/.mpd/mpd.conf\fP and then in +\fB/etc/mpd.conf\fP. Lines beginning with a "#" character are comments. All other non-empty lines specify parameters and their values. These lines contain the parameter name @@ -76,8 +77,9 @@ You can set a port that is different from the global port setting, e.g. "localhost:6602". IPv6 addresses must be enclosed in square brackets if you want to configure a port, e.g. "[::1]:6602". -To bind to a Unix domain socket, specify an absolute path. For a -system-wide MPD, we suggest the path "\fB/var/run/mpd/socket\fP". +To bind to a Unix domain socket, specify an absolute path or a path starting +with a tilde (~). For a system-wide MPD, we suggest the path +"\fB/var/run/mpd/socket\fP". .TP .B port <port> This specifies the port that mpd listens on. The default is 6600. diff --git a/doc/protocol.xml b/doc/protocol.xml index c03388a24..50e58db63 100644 --- a/doc/protocol.xml +++ b/doc/protocol.xml @@ -1876,6 +1876,20 @@ OK </para> </listitem> </varlistentry> + <varlistentry id="command_toggleoutput"> + <term> + <cmdsynopsis> + <command>toggleoutput</command> + <arg choice="req"><replaceable>ID</replaceable></arg> + </cmdsynopsis> + </term> + <listitem> + <para> + Turns an output on or off, depending on the current + state. + </para> + </listitem> + </varlistentry> <varlistentry id="command_outputs"> <term> <cmdsynopsis> diff --git a/doc/user.xml b/doc/user.xml index 38d8a9d85..61d02c162 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> @@ -173,7 +220,7 @@ systemctl start mpd.socket</programlisting> </para> <programlisting>input { - plugin "lastfm" + plugin "despotify" user "foo" password "bar" } @@ -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> @@ -1889,45 +1944,6 @@ systemctl start mpd.socket</programlisting> <title>Playlist plugins</title> <section> - <title><varname>lastfm</varname></title> - - <para> - Plays last.fm radio. - </para> - - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>Setting</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry> - <varname>user</varname> - <parameter>USERNAME</parameter> - </entry> - <entry> - The last.fm user name. - </entry> - </row> - <row> - <entry> - <varname>password</varname> - <parameter>PWD</parameter> - </entry> - <entry> - The last.fm password. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </section> - - <section> <title><varname>embcue</varname></title> <para> |