oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

doc/user: add links

Browse Source
This commit is contained in:
Max Kellermann 2014-09-02 10:22:48 +02:00
parent 3ee59e454c
commit 7facad41b7
1 changed files with 130 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

195
doc/user.xml
View File

@ -190,10 +190,11 @@ systemctl start mpd.socket</programlisting>
</para> </para>
<para> <para>
Instead of using local files, you can use storage plugins to Instead of using local files, you can use <link
access files on a remote file server. For example, to use linkend="storage_plugins">storage plugins</link> to access
music from the SMB/CIFS server "myfileserver" on the share files on a remote file server. For example, to use music from
called "Music", configure the music directory the SMB/CIFS server "myfileserver" on the share called
"Music", configure the music directory
"<parameter>smb://myfileserver/Music</parameter>". "<parameter>smb://myfileserver/Music</parameter>".
</para> </para>
</section> </section>
@ -243,6 +244,11 @@ systemctl start mpd.socket</programlisting>
</tbody> </tbody>
</tgroup> </tgroup>
</informaltable> </informaltable>
<para>
More information can be found in the <link
linkend="database_plugins">database plugin reference</link>.
</para>
</section> </section>
<section> <section>
@ -299,6 +305,11 @@ systemctl start mpd.socket</programlisting>
</tbody> </tbody>
</tgroup> </tgroup>
</informaltable> </informaltable>
<para>
More information can be found in the <link
linkend="input_plugins">input plugin reference</link>.
</para>
</section> </section>
<section> <section>
@ -355,19 +366,27 @@ systemctl start mpd.socket</programlisting>
</tbody> </tbody>
</tgroup> </tgroup>
</informaltable> </informaltable>
<para>
More information can be found in the <link
linkend="decoder_plugins">decoder plugin reference</link>.
</para>
</section> </section>
<section> <section>
<title>Configuring encoder plugins</title> <title>Configuring encoder plugins</title>
<para> <para>
Encoders are used by some of the output plugins (such as Encoders are used by some of the output plugins (such as <link
<varname>shout</varname>). The encoder settings are included linkend="shout_output"><varname>shout</varname></link>). The
in the <varname>audio_output</varname> section. encoder settings are included in the
<varname>audio_output</varname> section. More information can
be found in the <link linkend="encoder_plugins">encoder plugin
reference</link>.
</para> </para>
</section> </section>
<section> <section id="audio_output">
<title>Configuring audio outputs</title> <title>Configuring audio outputs</title>
<para> <para>
@ -475,10 +494,12 @@ systemctl start mpd.socket</programlisting>
<parameter>yes|no</parameter> <parameter>yes|no</parameter>
</entry> </entry>
<entry> <entry>
If set to <parameter>no</parameter>, then <application>MPD</application> If set to <parameter>no</parameter>, then
will not send tags to this output. This is only <application>MPD</application> will not send tags to
useful for output plugins that can receive tags, for this output. This is only useful for output plugins
example the <varname>httpd</varname> output plugin. that can receive tags, for example the <link
linkend="httpd_output"><varname>httpd</varname></link>
output plugin.
</entry> </entry>
</row> </row>
<row> <row>
@ -502,8 +523,11 @@ systemctl start mpd.socket</programlisting>
</entry> </entry>
<entry> <entry>
Specifies which mixer should be used for this audio Specifies which mixer should be used for this audio
output: the hardware mixer (available for ALSA, OSS output: the hardware mixer (available for <link
and PulseAudio), the software mixer or no mixer linkend="alsa_output">ALSA</link>, <link
linkend="oss_output">OSS</link> and <link
linkend="pulse_output">PulseAudio</link>), the
software mixer or no mixer
(<parameter>none</parameter>). By default, the (<parameter>none</parameter>). By default, the
hardware mixer is used for devices which support it, hardware mixer is used for devices which support it,
and none for the others. and none for the others.
@ -646,6 +670,11 @@ systemctl start mpd.socket</programlisting>
</tbody> </tbody>
</tgroup> </tgroup>
</informaltable> </informaltable>
<para>
More information can be found in the <link
linkend="playlist_plugins">playlist plugin reference</link>.
</para>
</section> </section>
<section> <section>
@ -659,8 +688,9 @@ systemctl start mpd.socket</programlisting>
<application>MPD</application> to use one audio format for <application>MPD</application> to use one audio format for
all outputs. Doing that is usually not a good idea. The all outputs. Doing that is usually not a good idea. The
values are the same as in <link values are the same as in <link
linkend="ao_format"><varname>format</varname> in the linkend="ao_format"><varname>format</varname> in the <link
<varname>audio_output</varname> section</link>. linkend="audio_output"><varname>audio_output</varname></link>
section</link>.
</para> </para>
</section> </section>
@ -1116,7 +1146,7 @@ systemctl start mpd.socket</programlisting>
<chapter> <chapter>
<title>Plugin reference</title> <title>Plugin reference</title>
<section> <section id="database_plugins">
<title>Database plugins</title> <title>Database plugins</title>
<section> <section>
@ -1215,7 +1245,7 @@ systemctl start mpd.socket</programlisting>
</section> </section>
</section> </section>
<section> <section id="storage_plugins">
<title>Storage plugins</title> <title>Storage plugins</title>
<section> <section>
@ -1229,7 +1259,7 @@ systemctl start mpd.socket</programlisting>
</para> </para>
</section> </section>
<section> <section id="smbclient_storage">
<title><varname>smbclient</varname></title> <title><varname>smbclient</varname></title>
<para> <para>
@ -1253,7 +1283,7 @@ systemctl start mpd.socket</programlisting>
</section> </section>
</section> </section>
<section> <section id="input_plugins">
<title>Input plugins</title> <title>Input plugins</title>
<section> <section>
@ -1494,7 +1524,7 @@ systemctl start mpd.socket</programlisting>
</section> </section>
</section> </section>
<section> <section id="decoder_plugins">
<title>Decoder plugins</title> <title>Decoder plugins</title>
<section> <section>
@ -1541,7 +1571,8 @@ systemctl start mpd.socket</programlisting>
<title><varname>fluidsynth</varname></title> <title><varname>fluidsynth</varname></title>
<para> <para>
MIDI decoder based on libfluidsynth. MIDI decoder based on <ulink
url="http://www.fluidsynth.org/"><application>FluidSynth</application></ulink>.
</para> </para>
<informaltable> <informaltable>
@ -1581,7 +1612,8 @@ systemctl start mpd.socket</programlisting>
<title><varname>mikmod</varname></title> <title><varname>mikmod</varname></title>
<para> <para>
Module player based on MikMod. Module player based on <ulink
url="http://mikmod.sourceforge.net/"><application>MikMod</application></ulink>.
</para> </para>
<informaltable> <informaltable>
@ -1621,7 +1653,7 @@ systemctl start mpd.socket</programlisting>
<title><varname>modplug</varname></title> <title><varname>modplug</varname></title>
<para> <para>
Module player based on MODPlug. Module player based on <application>MODPlug</application>.
</para> </para>
<informaltable> <informaltable>
@ -1652,7 +1684,8 @@ systemctl start mpd.socket</programlisting>
<title><varname>wildmidi</varname></title> <title><varname>wildmidi</varname></title>
<para> <para>
MIDI decoder based on libwildmidi. MIDI decoder based on <ulink
url="http://www.mindwerks.net/projects/wildmidi/"><application>libwildmidi</application></ulink>.
</para> </para>
<informaltable> <informaltable>
@ -1680,14 +1713,15 @@ systemctl start mpd.socket</programlisting>
</section> </section>
</section> </section>
<section> <section id="encoder_plugins">
<title>Encoder plugins</title> <title>Encoder plugins</title>
<section> <section>
<title><varname>flac</varname></title> <title><varname>flac</varname></title>
<para> <para>
Encodes into FLAC (lossless). Encodes into <ulink
url="https://xiph.org/flac/">FLAC</ulink> (lossless).
</para> </para>
<informaltable> <informaltable>
@ -1718,7 +1752,9 @@ systemctl start mpd.socket</programlisting>
<title><varname>lame</varname></title> <title><varname>lame</varname></title>
<para> <para>
Encodes into MP3 using the LAME library. Encodes into MP3 using the <ulink
url="http://lame.sourceforge.net/"><application>LAME</application></ulink>
library.
</para> </para>
<informaltable> <informaltable>
@ -1766,7 +1802,9 @@ systemctl start mpd.socket</programlisting>
<title><varname>shine</varname></title> <title><varname>shine</varname></title>
<para> <para>
Encodes into MP3 using the shine library. Encodes into MP3 using the <ulink
url="https://github.com/savonet/shine"><application>Shine</application></ulink>
library.
</para> </para>
<informaltable> <informaltable>
@ -1795,7 +1833,8 @@ systemctl start mpd.socket</programlisting>
<title><varname>twolame</varname></title> <title><varname>twolame</varname></title>
<para> <para>
Encodes into MP2 using the <filename>twolame</filename> Encodes into MP2 using the <ulink
url="http://www.twolame.org/"><application>TwoLAME</application></ulink>
library. library.
</para> </para>
@ -1832,11 +1871,12 @@ systemctl start mpd.socket</programlisting>
</informaltable> </informaltable>
</section> </section>
<section> <section id="vorbis_encoder">
<title><varname>vorbis</varname></title> <title><varname>vorbis</varname></title>
<para> <para>
Encodes into Ogg Vorbis. Encodes into <ulink url="http://www.vorbis.com/">Ogg
Vorbis</ulink>.
</para> </para>
<informaltable> <informaltable>
@ -1888,7 +1928,10 @@ systemctl start mpd.socket</programlisting>
<title><varname>alsa</varname></title> <title><varname>alsa</varname></title>
<para> <para>
The "Advanced Linux Sound Architecture" plugin uses The <ulink
url="http://www.alsa-project.org/"><application>Advanced
Linux Sound Architecture</application>
(<application>ALSA</application>)</ulink> plugin uses
<filename>libasound</filename>. It is recommended if you <filename>libasound</filename>. It is recommended if you
are using Linux. are using Linux.
</para> </para>
@ -2072,9 +2115,10 @@ systemctl start mpd.socket</programlisting>
<title><varname>ao</varname></title> <title><varname>ao</varname></title>
<para> <para>
The <varname>ao</varname> plugin uses the portable The <varname>ao</varname> plugin uses the portable <ulink
<filename>libao</filename> library. Use only if there is no url="https://www.xiph.org/ao/"><filename>libao</filename></ulink>
native plugin for your operating system. library. Use only if there is no native plugin for your
operating system.
</para> </para>
<informaltable> <informaltable>
@ -2181,8 +2225,9 @@ systemctl start mpd.socket</programlisting>
<title><varname>jack</varname></title> <title><varname>jack</varname></title>
<para> <para>
The <varname>jack</varname> plugin connects to a The <varname>jack</varname> plugin connects to a <ulink
<application>JACK</application> server. url="http://jackaudio.org/"><application>JACK</application></ulink>
server.
</para> </para>
<informaltable> <informaltable>
@ -2264,14 +2309,17 @@ systemctl start mpd.socket</programlisting>
</informaltable> </informaltable>
</section> </section>
<section> <section id="httpd_output">
<title><varname>httpd</varname></title> <title><varname>httpd</varname></title>
<para> <para>
The <varname>httpd</varname> plugin creates a HTTP server, The <varname>httpd</varname> plugin creates a HTTP server,
similar to <application>ShoutCast</application> / similar to <ulink
<application>IceCast</application>. HTTP streaming clients url="http://www.shoutcast.com/"><application>ShoutCast</application></ulink>
like <application>mplayer</application> can connect to it. / <ulink
url="http://icecast.org/"><application>IceCast</application></ulink>.
HTTP streaming clients like
<application>mplayer</application> can connect to it.
</para> </para>
<para> <para>
@ -2314,8 +2362,10 @@ systemctl start mpd.socket</programlisting>
<parameter>NAME</parameter> <parameter>NAME</parameter>
</entry> </entry>
<entry> <entry>
Chooses an encoder plugin, Chooses an encoder plugin. A list of encoder
e.g. <parameter>vorbis</parameter>. plugins can be found in the <link
linkend="encoder_plugins">encoder plugin
reference</link>.
</entry> </entry>
</row> </row>
<row> <row>
@ -2367,7 +2417,7 @@ systemctl start mpd.socket</programlisting>
</informaltable> </informaltable>
</section> </section>
<section> <section id="oss_output">
<title><varname>oss</varname></title> <title><varname>oss</varname></title>
<para> <para>
@ -2454,8 +2504,9 @@ systemctl start mpd.socket</programlisting>
<title><varname>openal</varname></title> <title><varname>openal</varname></title>
<para> <para>
The "OpenAL" plugin uses <filename>libopenal</filename>. It The "OpenAL" plugin uses <ulink
is supported on many platforms. Use only if there is no url="http://kcat.strangesoft.net/openal.html"><filename>libopenal</filename></ulink>.
It is supported on many platforms. Use only if there is no
native plugin for your operating system. native plugin for your operating system.
</para> </para>
@ -2523,11 +2574,12 @@ systemctl start mpd.socket</programlisting>
</informaltable> </informaltable>
</section> </section>
<section> <section id="pulse_output">
<title><varname>pulse</varname></title> <title><varname>pulse</varname></title>
<para> <para>
The <varname>pulse</varname> plugin connects to a PulseAudio The <varname>pulse</varname> plugin connects to a <ulink
url="http://www.freedesktop.org/wiki/Software/PulseAudio/"><application>PulseAudio</application></ulink>
server. server.
</para> </para>
@ -2546,9 +2598,11 @@ systemctl start mpd.socket</programlisting>
<parameter>HOSTNAME</parameter> <parameter>HOSTNAME</parameter>
</entry> </entry>
<entry> <entry>
Sets the host name of the PulseAudio server. By Sets the host name of the
<application>PulseAudio</application> server. By
default, <application>MPD</application> connects to default, <application>MPD</application> connects to
the local PulseAudio server. the local <application>PulseAudio</application>
server.
</entry> </entry>
</row> </row>
<row> <row>
@ -2557,7 +2611,8 @@ systemctl start mpd.socket</programlisting>
<parameter>NAME</parameter> <parameter>NAME</parameter>
</entry> </entry>
<entry> <entry>
Specifies the name of the PulseAudio sink Specifies the name of the
<application>PulseAudio</application> sink
<application>MPD</application> should play on. <application>MPD</application> should play on.
</entry> </entry>
</row> </row>
@ -2645,8 +2700,10 @@ systemctl start mpd.socket</programlisting>
<parameter>NAME</parameter> <parameter>NAME</parameter>
</entry> </entry>
<entry> <entry>
Chooses an encoder plugin, Chooses an encoder plugin. A list of encoder
e.g. <parameter>vorbis</parameter>. plugins can be found in the <link
linkend="encoder_plugins">encoder plugin
reference</link>.
</entry> </entry>
</row> </row>
</tbody> </tbody>
@ -2654,12 +2711,15 @@ systemctl start mpd.socket</programlisting>
</informaltable> </informaltable>
</section> </section>
<section> <section id="shout_output">
<title><varname>shout</varname></title> <title><varname>shout</varname></title>
<para> <para>
The <varname>shout</varname> plugin connects to a ShoutCast The <varname>shout</varname> plugin connects to a <ulink
or IceCast server. It forwards tags to this server. url="http://www.shoutcast.com/"><application>ShoutCast</application></ulink>
or <ulink
url="http://icecast.org/"><application>IceCast</application></ulink>
server. It forwards tags to this server.
</para> </para>
<para> <para>
@ -2681,7 +2741,11 @@ systemctl start mpd.socket</programlisting>
<parameter>HOSTNAME</parameter> <parameter>HOSTNAME</parameter>
</entry> </entry>
<entry> <entry>
Sets the host name of the Shoutcast/Icecast server. Sets the host name of the <ulink
url="http://www.shoutcast.com/"><application>ShoutCast</application></ulink>
/ <ulink
url="http://icecast.org/"><application>IceCast</application></ulink>
server.
</entry> </entry>
</row> </row>
<row> <row>
@ -2710,8 +2774,8 @@ systemctl start mpd.socket</programlisting>
</entry> </entry>
<entry> <entry>
Specifies the protocol that wil be used to connect Specifies the protocol that wil be used to connect
to the icecast/shoutcast server. The default to the server. The default is
is "<parameter>icecast2</parameter>". "<parameter>icecast2</parameter>".
</entry> </entry>
</row> </row>
@ -2797,10 +2861,11 @@ systemctl start mpd.socket</programlisting>
<parameter>PLUGIN</parameter> <parameter>PLUGIN</parameter>
</entry> </entry>
<entry> <entry>
Sets the name of the encoder plugin. Default is Chooses an encoder plugin. Default is <link
"vorbis". "vorbis" and "lame" are valid encoder linkend="vorbis_encoder"><parameter>vorbis</parameter></link>.
plugins (provided that you enabled them at compile A list of encoder plugins can be found in the <link
time). linkend="encoder_plugins">encoder plugin
reference</link>.
</entry> </entry>
</row> </row>
</tbody> </tbody>
@ -2841,7 +2906,7 @@ systemctl start mpd.socket</programlisting>
</section> </section>
</section> </section>
<section> <section id="playlist_plugins">
<title>Playlist plugins</title> <title>Playlist plugins</title>
<section> <section>