Skip to content

M
mpd
Commit c6be661b authored by Max Kellermann's avatar Max Kellermann
Browse files
Options

doc/user: more markup

parent c84508ae
Hide whitespace changes
Inline Side-by-side
Showing with 206 additions and 156 deletions
doc/user.xml
View file @ c6be661b
...@@ -13,10 +13,10 @@ ...@@ -13,10 +13,10 @@
</para> </para>
<para> <para>
MPD (Music Player Daemon) is, as the name suggests, a server <application>MPD</application> (Music Player Daemon) is, as the
software allowing you to remotely play your music, handle name suggests, a server software allowing you to remotely play
playlists, deliver music (HTTP STREAMS with various your music, handle playlists, deliver music (HTTP streams with
sub-protocols) and organizze playlists. various sub-protocols) and organizze playlists.
</para> </para>
<para> <para>
...@@ -26,8 +26,8 @@ ...@@ -26,8 +26,8 @@
</para> </para>
<para> <para>
MPD supports also Gapless playback, buffered audio output, and <application>MPD</application> supports also gapless playback,
crossfading! buffered audio output, and crossfading!
</para> </para>
<para> <para>
...@@ -42,23 +42,26 @@ ...@@ -42,23 +42,26 @@
<para> <para>
We recommend that you use the software installation routines of We recommend that you use the software installation routines of
your distribution to install MPD. Most operating systems have a your distribution to install <application>MPD</application>.
MPD package, which is very easy to install. Most operating systems have a <application>MPD</application>
package, which is very easy to install.
</para> </para>
<section> <section>
<title>Installing on Debian/Ubuntu</title> <title>Installing on Debian/Ubuntu</title>
<para> <para>
Install the package <filename>mpd</filename> via APT: Install the package <application>MPD</application> via APT:
</para> </para>
<programlisting>apt-get install mpd</programlisting> <programlisting>apt-get install mpd</programlisting>
<para> <para>
When installed this way, MPD by default looks for music in When installed this way, <application>MPD</application> by
/var/lib/mpd/music/; this may not be correct. Look at your default looks for music in
/etc/mpd.conf file... <filename>/var/lib/mpd/music/</filename>; this may not be
correct. Look at your <filename>/etc/mpd.conf</filename>
file...
</para> </para>
</section> </section>
...@@ -67,8 +70,9 @@ ...@@ -67,8 +70,9 @@
<para> <para>
Download the source tarball from <ulink Download the source tarball from <ulink
url="http://www.musicpd.org/download.html">the MPD home url="http://www.musicpd.org/download.html">the
page</ulink> and unpack it: <application>MPD</application> home page</ulink> and unpack
it:
</para> </para>
<programlisting>tar xf mpd-version.tar.xz <programlisting>tar xf mpd-version.tar.xz
...@@ -135,14 +139,15 @@ apt-get install g++ automake autoconf \ ...@@ -135,14 +139,15 @@ apt-get install g++ automake autoconf \
<para> <para>
Using <filename>systemd</filename>, you can launch Using <filename>systemd</filename>, you can launch
<filename>mpd</filename> on demand when the first client <application>MPD</application> on demand when the first client
attempts to connect. attempts to connect.
</para> </para>
<para> <para>
MPD comes with two <filename>systemd</filename> unit files: a <application>MPD</application> comes with two
"service" unit and a "socket" unit. These will only be <application>systemd</application> unit files: a "service"
installed when MPD was configured with unit and a "socket" unit. These will only be installed when
<application>MPD</application> was configured with
<parameter>--with-systemdsystemunitdir=/lib/systemd</parameter>. <parameter>--with-systemdsystemunitdir=/lib/systemd</parameter>.
</para> </para>
...@@ -154,8 +159,8 @@ apt-get install g++ automake autoconf \ ...@@ -154,8 +159,8 @@ apt-get install g++ automake autoconf \
systemctl start mpd.socket</programlisting> systemctl start mpd.socket</programlisting>
<para> <para>
In this configuration, <filename>mpd</filename> will ignore In this configuration, <application>MPD</application> will
the <varname>bind_to_address</varname> and ignore the <varname>bind_to_address</varname> and
<varname>port</varname> settings. <varname>port</varname> settings.
</para> </para>
</section> </section>
...@@ -170,16 +175,18 @@ systemctl start mpd.socket</programlisting> ...@@ -170,16 +175,18 @@ systemctl start mpd.socket</programlisting>
<para> <para>
When you play local files, you should organize them within a When you play local files, you should organize them within a
directory called the "music directory". This is configured in directory called the "music directory". This is configured in
MPD with the <varname>music_directory</varname> setting. <application>MPD</application> with the
<varname>music_directory</varname> setting.
</para> </para>
<para> <para>
By default, MPD follows symbolic links in the music directory. By default, <application>MPD</application> follows symbolic
This behavior can be switched off: links in the music directory. This behavior can be switched
<varname>follow_outside_symlinks</varname> controls whether off: <varname>follow_outside_symlinks</varname> controls
MPD follows links pointing to files outside of the music whether <application>MPD</application> follows links pointing
directory, and <varname>follow_inside_symlinks</varname> lets to files outside of the music directory, and
you disable symlinks to files inside the music directory. <varname>follow_inside_symlinks</varname> lets you disable
symlinks to files inside the music directory.
</para> </para>
<para> <para>
...@@ -365,10 +372,11 @@ systemctl start mpd.socket</programlisting> ...@@ -365,10 +372,11 @@ systemctl start mpd.socket</programlisting>
<para> <para>
Audio outputs are devices which actually play the audio chunks Audio outputs are devices which actually play the audio chunks
produced by MPD. You can configure any number of audio output produced by <application>MPD</application>. You can configure
devices, but there must be at least one. If none is any number of audio output devices, but there must be at least
configured, MPD attempts to auto-detect. Usually, this works one. If none is configured, <application>MPD</application>
quite well with ALSA, OSS and on Mac OS X. attempts to auto-detect. Usually, this works quite well with
ALSA, OSS and on Mac OS X.
</para> </para>
<para> <para>
...@@ -457,8 +465,8 @@ systemctl start mpd.socket</programlisting> ...@@ -457,8 +465,8 @@ systemctl start mpd.socket</programlisting>
</entry> </entry>
<entry> <entry>
Specifies whether this audio output is enabled when Specifies whether this audio output is enabled when
MPD is started. By default, all audio outputs are <application>MPD</application> is started. By
enabled. default, all audio outputs are enabled.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -467,10 +475,10 @@ systemctl start mpd.socket</programlisting> ...@@ -467,10 +475,10 @@ systemctl start mpd.socket</programlisting>
<parameter>yes|no</parameter> <parameter>yes|no</parameter>
</entry> </entry>
<entry> <entry>
If set to "no", then MPD will not send tags to this If set to <parameter>no</parameter>, then <application>MPD</application>
output. This is only useful for output plugins that will not send tags to this output. This is only
can receive tags, for example the useful for output plugins that can receive tags, for
<varname>httpd</varname> output plugin. example the <varname>httpd</varname> output plugin.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -479,10 +487,12 @@ systemctl start mpd.socket</programlisting> ...@@ -479,10 +487,12 @@ systemctl start mpd.socket</programlisting>
<parameter>yes|no</parameter> <parameter>yes|no</parameter>
</entry> </entry>
<entry> <entry>
If set to "yes", then MPD attempts to keep this audio If set to <parameter>yes</parameter>, then
output always open. This may be useful for streaming <application>MPD</application> attempts to keep this
servers, when you don't want to disconnect all audio output always open. This may be useful for
listeners even when playback is accidentally stopped. streaming servers, when you don't want to disconnect
all listeners even when playback is accidentally
stopped.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -494,8 +504,9 @@ systemctl start mpd.socket</programlisting> ...@@ -494,8 +504,9 @@ systemctl start mpd.socket</programlisting>
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 ALSA, OSS
and PulseAudio), the software mixer or no mixer and PulseAudio), the software mixer or no mixer
("none"). By default, the hardware mixer is used for (<parameter>none</parameter>). By default, the
devices which support it, and none for the others. hardware mixer is used for devices which support it,
and none for the others.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -505,10 +516,11 @@ systemctl start mpd.socket</programlisting> ...@@ -505,10 +516,11 @@ systemctl start mpd.socket</programlisting>
</entry> </entry>
<entry> <entry>
Specifies how replay gain is applied. The default is Specifies how replay gain is applied. The default is
"software", which uses an internal software volume <parameter>software</parameter>, which uses an
control. "mixer" uses the configured (hardware) mixer internal software volume control.
control. "none" disables replay gain on this audio <parameter>mixer</parameter> uses the configured
output. (hardware) mixer control. <parameter>none</parameter>
disables replay gain on this audio output.
</entry> </entry>
</row> </row>
</tbody> </tbody>
...@@ -578,7 +590,8 @@ systemctl start mpd.socket</programlisting> ...@@ -578,7 +590,8 @@ systemctl start mpd.socket</programlisting>
<para> <para>
Playlist plugins are used to load remote playlists. This is Playlist plugins are used to load remote playlists. This is
not related to MPD's playlist directory. not related to <application>MPD</application>'s playlist
directory.
</para> </para>
<para> <para>
...@@ -643,9 +656,10 @@ systemctl start mpd.socket</programlisting> ...@@ -643,9 +656,10 @@ systemctl start mpd.socket</programlisting>
<para> <para>
The setting <varname>audio_output_format</varname> forces The setting <varname>audio_output_format</varname> forces
MPD to use one audio format for all outputs. Doing that is <application>MPD</application> to use one audio format for
usually not a good idea. The values are the same as in all outputs. Doing that is usually not a good idea. The
<link linkend="ao_format"><varname>format</varname> in the values are the same as in <link
linkend="ao_format"><varname>format</varname> in the
<varname>audio_output</varname> section</link>. <varname>audio_output</varname> section</link>.
</para> </para>
</section> </section>
...@@ -661,9 +675,11 @@ systemctl start mpd.socket</programlisting> ...@@ -661,9 +675,11 @@ systemctl start mpd.socket</programlisting>
There are different options, some of them optimized for high There are different options, some of them optimized for high
quality and others for low CPU usage, but you can't have quality and others for low CPU usage, but you can't have
both at the same time. Often, the resampler is the both at the same time. Often, the resampler is the
component that is responsible for most of MPD's CPU usage. component that is responsible for most of
Since MPD comes with high quality defaults, it may appear <application>MPD</application>'s CPU usage. Since
that MPD consumes more CPU than other software. <application>MPD</application> comes with high quality
defaults, it may appear that <application>MPD</application>
consumes more CPU than other software.
</para> </para>
<para> <para>
...@@ -675,7 +691,7 @@ systemctl start mpd.socket</programlisting> ...@@ -675,7 +691,7 @@ systemctl start mpd.socket</programlisting>
<listitem> <listitem>
<para> <para>
<ulink <ulink
url="http://www.mega-nerd.com/SRC/">libsamplerate</ulink> url="http://www.mega-nerd.com/SRC/"><application>libsamplerate</application></ulink>
a.k.a. Secret Rabbit Code (SRC). a.k.a. Secret Rabbit Code (SRC).
</para> </para>
</listitem> </listitem>
...@@ -683,7 +699,7 @@ systemctl start mpd.socket</programlisting> ...@@ -683,7 +699,7 @@ systemctl start mpd.socket</programlisting>
<listitem> <listitem>
<para> <para>
<ulink <ulink
url="http://sourceforge.net/projects/soxr/">libsoxr</ulink>, url="http://sourceforge.net/projects/soxr/"><application>libsoxr</application></ulink>,
the SoX Resampler library the SoX Resampler library
</para> </para>
</listitem> </listitem>
...@@ -691,15 +707,16 @@ systemctl start mpd.socket</programlisting> ...@@ -691,15 +707,16 @@ systemctl start mpd.socket</programlisting>
<listitem> <listitem>
<para> <para>
internal: low CPU usage, but very poor quality. This is internal: low CPU usage, but very poor quality. This is
the fallback if MPD was compiled without an external the fallback if <application>MPD</application> was
resampler. compiled without an external resampler.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para> <para>
The setting <varname>samplerate_converter</varname> controls The setting <varname>samplerate_converter</varname> controls
how MPD shall resample music. Possible values: how <application>MPD</application> shall resample music.
Possible values:
</para> </para>
<informaltable> <informaltable>
...@@ -730,7 +747,8 @@ systemctl start mpd.socket</programlisting> ...@@ -730,7 +747,8 @@ systemctl start mpd.socket</programlisting>
"<parameter>soxr very high</parameter>" "<parameter>soxr very high</parameter>"
</entry> </entry>
<entry> <entry>
Use libsoxr with "Very High Quality" setting. Use <application>libsoxr</application> with "Very
High Quality" setting.
</entry> </entry>
</row> </row>
...@@ -740,7 +758,8 @@ systemctl start mpd.socket</programlisting> ...@@ -740,7 +758,8 @@ systemctl start mpd.socket</programlisting>
"<parameter>soxr</parameter>" "<parameter>soxr</parameter>"
</entry> </entry>
<entry> <entry>
Use libsoxr with "High Quality" setting. Use <application>libsoxr</application> with "High
Quality" setting.
</entry> </entry>
</row> </row>
...@@ -749,7 +768,8 @@ systemctl start mpd.socket</programlisting> ...@@ -749,7 +768,8 @@ systemctl start mpd.socket</programlisting>
"<parameter>soxr medium</parameter>" "<parameter>soxr medium</parameter>"
</entry> </entry>
<entry> <entry>
Use libsoxr with "Medium Quality" setting. Use <application>libsoxr</application> with "Medium
Quality" setting.
</entry> </entry>
</row> </row>
...@@ -758,7 +778,8 @@ systemctl start mpd.socket</programlisting> ...@@ -758,7 +778,8 @@ systemctl start mpd.socket</programlisting>
"<parameter>soxr low</parameter>" "<parameter>soxr low</parameter>"
</entry> </entry>
<entry> <entry>
Use libsoxr with "Low Quality" setting. Use <application>libsoxr</application> with "Low
Quality" setting.
</entry> </entry>
</row> </row>
...@@ -767,7 +788,8 @@ systemctl start mpd.socket</programlisting> ...@@ -767,7 +788,8 @@ systemctl start mpd.socket</programlisting>
"<parameter>soxr quick</parameter>" "<parameter>soxr quick</parameter>"
</entry> </entry>
<entry> <entry>
Use libsoxr with "Quick" setting. Use <application>libsoxr</application> with "Quick"
setting.
</entry> </entry>
</row> </row>
...@@ -777,8 +799,9 @@ systemctl start mpd.socket</programlisting> ...@@ -777,8 +799,9 @@ systemctl start mpd.socket</programlisting>
"<parameter>0</parameter>" "<parameter>0</parameter>"
</entry> </entry>
<entry> <entry>
libsamplerate: Band limited sinc interpolation, best <application>libsamplerate</application>: Band
quality, 97dB SNR, 96% BW. limited sinc interpolation, best quality, 97dB SNR,
96% BW.
</entry> </entry>
</row> </row>
...@@ -788,8 +811,9 @@ systemctl start mpd.socket</programlisting> ...@@ -788,8 +811,9 @@ systemctl start mpd.socket</programlisting>
"<parameter>1</parameter>" "<parameter>1</parameter>"
</entry> </entry>
<entry> <entry>
libsamplerate: Band limited sinc interpolation, <application>libsamplerate</application>: Band
medium quality, 97dB SNR, 90% BW. limited sinc interpolation, medium quality, 97dB
SNR, 90% BW.
</entry> </entry>
</row> </row>
...@@ -799,8 +823,9 @@ systemctl start mpd.socket</programlisting> ...@@ -799,8 +823,9 @@ systemctl start mpd.socket</programlisting>
"<parameter>2</parameter>" "<parameter>2</parameter>"
</entry> </entry>
<entry> <entry>
libsamplerate: Band limited sinc interpolation, <application>libsamplerate</application>: Band
fastest, 97dB SNR, 80% BW. limited sinc interpolation, fastest, 97dB SNR, 80%
BW.
</entry> </entry>
</row> </row>
...@@ -810,8 +835,9 @@ systemctl start mpd.socket</programlisting> ...@@ -810,8 +835,9 @@ systemctl start mpd.socket</programlisting>
"<parameter>3</parameter>" "<parameter>3</parameter>"
</entry> </entry>
<entry> <entry>
libsamplerate: Zero order hold interpolator, very <application>libsamplerate</application>: Zero order
fast, very poor quality with audible distortions. hold interpolator, very fast, very poor quality with
audible distortions.
</entry> </entry>
</row> </row>
...@@ -821,8 +847,8 @@ systemctl start mpd.socket</programlisting> ...@@ -821,8 +847,8 @@ systemctl start mpd.socket</programlisting>
"<parameter>4</parameter>" "<parameter>4</parameter>"
</entry> </entry>
<entry> <entry>
libsamplerate: Linear interpolator, very fast, poor <application>libsamplerate</application>: Linear
quality. interpolator, very fast, poor quality.
</entry> </entry>
</row> </row>
</tbody> </tbody>
...@@ -833,14 +859,15 @@ systemctl start mpd.socket</programlisting> ...@@ -833,14 +859,15 @@ systemctl start mpd.socket</programlisting>
</chapter> </chapter>
<chapter> <chapter>
<title>Using MPD</title> <title>Using <application>MPD</application></title>
<section> <section>
<title>The client</title> <title>The client</title>
<para> <para>
After you have installed, configured and started MPD, you After you have installed, configured and started
choose a client to control the playback. <application>MPD</application>, you choose a client to control
the playback.
</para> </para>
<para> <para>
...@@ -851,7 +878,8 @@ systemctl start mpd.socket</programlisting> ...@@ -851,7 +878,8 @@ systemctl start mpd.socket</programlisting>
</para> </para>
<para> <para>
The <ulink url="http://www.musicpd.org/clients/">MPD The <ulink
url="http://www.musicpd.org/clients/"><application>MPD</application>
Wiki</ulink> contains an extensive list of clients to choose Wiki</ulink> contains an extensive list of clients to choose
from. from.
</para> </para>
...@@ -862,10 +890,11 @@ systemctl start mpd.socket</programlisting> ...@@ -862,10 +890,11 @@ systemctl start mpd.socket</programlisting>
<para> <para>
The "music directory" is where you store your music files. The "music directory" is where you store your music files.
MPD stores all relevant meta information about all songs in <application>MPD</application> stores all relevant meta
its "database". Whenever you add, modify or remove songs in information about all songs in its "database". Whenever you
the music directory, you have to update the database, for add, modify or remove songs in the music directory, you have
example with <filename>mpc</filename>: to update the database, for example with
<filename>mpc</filename>:
</para> </para>
<programlisting>mpc update</programlisting> <programlisting>mpc update</programlisting>
...@@ -887,9 +916,9 @@ systemctl start mpd.socket</programlisting> ...@@ -887,9 +916,9 @@ systemctl start mpd.socket</programlisting>
<para> <para>
The queue (sometimes called "current playlist") is a list of The queue (sometimes called "current playlist") is a list of
songs to be played by MPD. To play a song, add it to the songs to be played by <application>MPD</application>. To play
queue and start playback. Most clients offer an interface to a song, add it to the queue and start playback. Most clients
edit the queue. offer an interface to edit the queue.
</para> </para>
</section> </section>
</chapter> </chapter>
...@@ -946,11 +975,13 @@ systemctl start mpd.socket</programlisting> ...@@ -946,11 +975,13 @@ systemctl start mpd.socket</programlisting>
<title><varname>proxy</varname></title> <title><varname>proxy</varname></title>
<para> <para>
Provides access to the database of another MPD instance Provides access to the database of another
using <filename>libmpdclient</filename>. This is useful <application>MPD</application> instance using
when you run mount the music directory via NFS/SMB, and the <filename>libmpdclient</filename>. This is useful when you
file server already runs a MPD instance. Only the file run mount the music directory via NFS/SMB, and the file
server needs to update the database. server already runs a <application>MPD</application>
instance. Only the file server needs to update the
database.
</para> </para>
<informaltable> <informaltable>
...@@ -967,7 +998,8 @@ systemctl start mpd.socket</programlisting> ...@@ -967,7 +998,8 @@ systemctl start mpd.socket</programlisting>
<varname>host</varname> <varname>host</varname>
</entry> </entry>
<entry> <entry>
The host name of the "master" MPD instance. The host name of the "master"
<application>MPD</application> instance.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -975,7 +1007,8 @@ systemctl start mpd.socket</programlisting> ...@@ -975,7 +1007,8 @@ systemctl start mpd.socket</programlisting>
<varname>port</varname> <varname>port</varname>
</entry> </entry>
<entry> <entry>
The port number of the "master" MPD instance. The port number of the "master"
<application>MPD</application> instance.
</entry> </entry>
</row> </row>
</tbody> </tbody>
...@@ -999,9 +1032,10 @@ systemctl start mpd.socket</programlisting> ...@@ -999,9 +1032,10 @@ systemctl start mpd.socket</programlisting>
<title><varname>local</varname></title> <title><varname>local</varname></title>
<para> <para>
The default plugin which gives MPD access to local files. The default plugin which gives
It is used when <varname>music_directory</varname> refers to <application>MPD</application> access to local files. It is
a local directory. used when <varname>music_directory</varname> refers to a
local directory.
</para> </para>
</section> </section>
...@@ -1036,9 +1070,10 @@ systemctl start mpd.socket</programlisting> ...@@ -1036,9 +1070,10 @@ systemctl start mpd.socket</programlisting>
<title><varname>alsa</varname></title> <title><varname>alsa</varname></title>
<para> <para>
Allows MPD on Linux to play audio directly from a soundcard using Allows <application>MPD</application> on Linux to play audio
the scheme <filename>alsa://</filename>. Audio is formatted as directly from a soundcard using the scheme
44.1 kHz 16-bit stereo (CD format). Examples: <filename>alsa://</filename>. Audio is formatted as 44.1 kHz
16-bit stereo (CD format). Examples:
</para> </para>
<para> <para>
...@@ -1075,9 +1110,10 @@ systemctl start mpd.socket</programlisting> ...@@ -1075,9 +1110,10 @@ systemctl start mpd.socket</programlisting>
<parameter>little_endian|big_endian</parameter> <parameter>little_endian|big_endian</parameter>
</entry> </entry>
<entry> <entry>
If the CD drive does not specify a byte order, MPD If the CD drive does not specify a byte order,
assumes it is the CPU's native byte order. This <application>MPD</application> assumes it is the
setting allows overriding this. CPU's native byte order. This setting allows
overriding this.
</entry> </entry>
</row> </row>
</tbody> </tbody>
...@@ -1227,11 +1263,11 @@ systemctl start mpd.socket</programlisting> ...@@ -1227,11 +1263,11 @@ systemctl start mpd.socket</programlisting>
<title><varname>nfs</varname></title> <title><varname>nfs</varname></title>
<para> <para>
Allows MPD to access files on NFSv3 servers without actually Allows <application>MPD</application> to access files on
mounting them (i.e. in userspace, without help from the NFSv3 servers without actually mounting them (i.e. in
kernel's VFS layer). All URIs with the userspace, without help from the kernel's VFS layer). All
<filename>nfs://</filename> scheme are used according to URIs with the <filename>nfs://</filename> scheme are used
<ulink according to <ulink
url="http://tools.ietf.org/html/rfc2224">RFC2224</ulink>. url="http://tools.ietf.org/html/rfc2224">RFC2224</ulink>.
Example: Example:
</para> </para>
...@@ -1243,12 +1279,12 @@ systemctl start mpd.socket</programlisting> ...@@ -1243,12 +1279,12 @@ systemctl start mpd.socket</programlisting>
<para> <para>
Note that this usually requires enabling the "insecure" flag Note that this usually requires enabling the "insecure" flag
in the server's <filename>/etc/exports</filename> file, in the server's <filename>/etc/exports</filename> file,
because MPD cannot bind to so-called "privileged" ports. because <application>MPD</application> cannot bind to
Don't fear: this will not make your file server insecure; so-called "privileged" ports. Don't fear: this will not
the flag was named in a time long ago when privileged ports make your file server insecure; the flag was named in a time
were thought to be meaningful for security. By today's long ago when privileged ports were thought to be meaningful
standards, NFSv3 is not secure at all, and if you believe it for security. By today's standards, NFSv3 is not secure at
is, you're already doomed. all, and if you believe it is, you're already doomed.
</para> </para>
</section> </section>
...@@ -1256,9 +1292,10 @@ systemctl start mpd.socket</programlisting> ...@@ -1256,9 +1292,10 @@ systemctl start mpd.socket</programlisting>
<title><varname>smbclient</varname></title> <title><varname>smbclient</varname></title>
<para> <para>
Allows MPD to access files on SMB/CIFS servers (e.g. Samba Allows <application>MPD</application> to access files on
or Microsoft Windows). All URIs with the SMB/CIFS servers (e.g. Samba or Microsoft Windows). All
<filename>smb://</filename> scheme are used. Example: URIs with the <filename>smb://</filename> scheme are used.
Example:
</para> </para>
<para> <para>
...@@ -1293,7 +1330,7 @@ systemctl start mpd.socket</programlisting> ...@@ -1293,7 +1330,7 @@ systemctl start mpd.socket</programlisting>
</entry> </entry>
<entry> <entry>
Decode the least significant bit first. Default is Decode the least significant bit first. Default is
"no". <parameter>no</parameter>.
</entry> </entry>
</row> </row>
</tbody> </tbody>
...@@ -1732,10 +1769,11 @@ systemctl start mpd.socket</programlisting> ...@@ -1732,10 +1769,11 @@ systemctl start mpd.socket</programlisting>
<entry> <entry>
If set to <parameter>no</parameter>, then If set to <parameter>no</parameter>, then
<filename>libasound</filename> will not attempt to <filename>libasound</filename> will not attempt to
resample, handing the responsibility over to MPD. resample, handing the responsibility over to
It is recommended to let MPD resample (with <application>MPD</application>. It is recommended
libsamplerate), because ALSA is quite poor at doing to let <application>MPD</application> resample (with
so. <application>libsamplerate</application>), because
ALSA is quite poor at doing so.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -1928,15 +1966,19 @@ systemctl start mpd.socket</programlisting> ...@@ -1928,15 +1966,19 @@ systemctl start mpd.socket</programlisting>
<entry> <entry>
This specifies the path of the FIFO to write to. This specifies the path of the FIFO to write to.
Must be an absolute path. If the path does not Must be an absolute path. If the path does not
exist, it will be created when MPD is started, and exist, it will be created when
removed when MPD is stopped. The FIFO will be <application>MPD</application> is started, and
created with the same user and group as MPD is removed when <application>MPD</application> is
stopped. The FIFO will be created with the same
user and group as <application>MPD</application> is
running as. Default permissions can be modified by running as. Default permissions can be modified by
using the builtin shell command "umask". If a FIFO using the builtin shell command
already exists at the specified path it will be <filename>umask</filename>. If a FIFO already
reused, and will not be removed when MPD is stopped. exists at the specified path it will be reused, and
You can use the "mkfifo" command to create this, and will not be removed when
then you may modify the permissions to your liking. <application>MPD</application> is stopped. You can
use the "mkfifo" command to create this, and then
you may modify the permissions to your liking.
</entry> </entry>
</row> </row>
</tbody> </tbody>
...@@ -1948,8 +1990,8 @@ systemctl start mpd.socket</programlisting> ...@@ -1948,8 +1990,8 @@ 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 JACK The <varname>jack</varname> plugin connects to a
server. <application>JACK</application> server.
</para> </para>
<informaltable> <informaltable>
...@@ -1967,8 +2009,8 @@ systemctl start mpd.socket</programlisting> ...@@ -1967,8 +2009,8 @@ systemctl start mpd.socket</programlisting>
<parameter>NAME</parameter> <parameter>NAME</parameter>
</entry> </entry>
<entry> <entry>
The name of the JACK client. Defaults to "Music The name of the <application>JACK</application>
Player Daemon". client. Defaults to "Music Player Daemon".
</entry> </entry>
</row> </row>
<row> <row>
...@@ -1977,7 +2019,8 @@ systemctl start mpd.socket</programlisting> ...@@ -1977,7 +2019,8 @@ systemctl start mpd.socket</programlisting>
<parameter>NAME</parameter> <parameter>NAME</parameter>
</entry> </entry>
<entry> <entry>
Optional name of the JACK server. Optional name of the <application>JACK</application>
server.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -1988,7 +2031,8 @@ systemctl start mpd.socket</programlisting> ...@@ -1988,7 +2031,8 @@ systemctl start mpd.socket</programlisting>
<entry> <entry>
If set to <parameter>yes</parameter>, then If set to <parameter>yes</parameter>, then
<filename>libjack</filename> will automatically <filename>libjack</filename> will automatically
launch the JACK daemon. Disabled by default. launch the <application>JACK</application> daemon.
Disabled by default.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -1997,10 +2041,10 @@ systemctl start mpd.socket</programlisting> ...@@ -1997,10 +2041,10 @@ systemctl start mpd.socket</programlisting>
<parameter>A,B</parameter> <parameter>A,B</parameter>
</entry> </entry>
<entry> <entry>
The names of the JACK source ports to be created. The names of the <application>JACK</application>
By default, the ports "left" and "right" are source ports to be created. By default, the ports
created. To use more ports, you have to tweak this "left" and "right" are created. To use more ports,
option. you have to tweak this option.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -2009,7 +2053,8 @@ systemctl start mpd.socket</programlisting> ...@@ -2009,7 +2053,8 @@ systemctl start mpd.socket</programlisting>
<parameter>A,B</parameter> <parameter>A,B</parameter>
</entry> </entry>
<entry> <entry>
The names of the JACK destination ports to connect to. The names of the <application>JACK</application>
destination ports to connect to.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -2033,8 +2078,9 @@ systemctl start mpd.socket</programlisting> ...@@ -2033,8 +2078,9 @@ systemctl start mpd.socket</programlisting>
<para> <para>
The <varname>httpd</varname> plugin creates a HTTP server, The <varname>httpd</varname> plugin creates a HTTP server,
similar to ShoutCast / IceCast. HTTP streaming clients like similar to <application>ShoutCast</application> /
<filename>mplayer</filename> can connect to it. <application>IceCast</application>. HTTP streaming clients
like <application>mplayer</application> can connect to it.
</para> </para>
<para> <para>
...@@ -2176,8 +2222,8 @@ systemctl start mpd.socket</programlisting> ...@@ -2176,8 +2222,8 @@ systemctl start mpd.socket</programlisting>
</entry> </entry>
<entry> <entry>
Sets the path of the PCM device. If not specified, Sets the path of the PCM device. If not specified,
then MPD will attempt to open then <application>MPD</application> will attempt to
<filename>/dev/sound/dsp</filename> and open <filename>/dev/sound/dsp</filename> and
<filename>/dev/dsp</filename>. <filename>/dev/dsp</filename>.
</entry> </entry>
</row> </row>
...@@ -2324,8 +2370,8 @@ systemctl start mpd.socket</programlisting> ...@@ -2324,8 +2370,8 @@ systemctl start mpd.socket</programlisting>
</entry> </entry>
<entry> <entry>
Sets the host name of the PulseAudio server. By Sets the host name of the PulseAudio server. By
default, MPD connects to the local PulseAudio default, <application>MPD</application> connects to
server. the local PulseAudio server.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -2334,8 +2380,8 @@ systemctl start mpd.socket</programlisting> ...@@ -2334,8 +2380,8 @@ systemctl start mpd.socket</programlisting>
<parameter>NAME</parameter> <parameter>NAME</parameter>
</entry> </entry>
<entry> <entry>
Specifies the name of the PulseAudio sink MPD should Specifies the name of the PulseAudio sink
play on. <application>MPD</application> should play on.
</entry> </entry>
</row> </row>
</tbody> </tbody>
...@@ -2368,8 +2414,8 @@ systemctl start mpd.socket</programlisting> ...@@ -2368,8 +2414,8 @@ systemctl start mpd.socket</programlisting>
</entry> </entry>
<entry> <entry>
The host name of the RoarAudio server. If not The host name of the RoarAudio server. If not
specified, then MPD will connect to the default specified, then <application>MPD</application> will
locations. connect to the default locations.
</entry> </entry>
</row> </row>
...@@ -2379,8 +2425,9 @@ systemctl start mpd.socket</programlisting> ...@@ -2379,8 +2425,9 @@ systemctl start mpd.socket</programlisting>
<parameter>ROLE</parameter> <parameter>ROLE</parameter>
</entry> </entry>
<entry> <entry>
The "role" that MPD registers itself as in the The "role" that <application>MPD</application>
RoarAudio server. The default is "music". registers itself as in the RoarAudio server. The
default is "music".
</entry> </entry>
</row> </row>
</tbody> </tbody>
...@@ -2393,8 +2440,8 @@ systemctl start mpd.socket</programlisting> ...@@ -2393,8 +2440,8 @@ systemctl start mpd.socket</programlisting>
<para> <para>
The <varname>recorder</varname> plugin writes the audio The <varname>recorder</varname> plugin writes the audio
played by MPD to a file. This may be useful for recording played by <application>MPD</application> to a file. This
radio streams. may be useful for recording radio streams.
</para> </para>
<para> <para>
...@@ -2522,7 +2569,8 @@ systemctl start mpd.socket</programlisting> ...@@ -2522,7 +2569,8 @@ systemctl start mpd.socket</programlisting>
<parameter>URI</parameter> <parameter>URI</parameter>
</entry> </entry>
<entry> <entry>
Mounts the MPD stream in the specified URI. Mounts the <application>MPD</application> stream in
the specified URI.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -2588,7 +2636,7 @@ systemctl start mpd.socket</programlisting> ...@@ -2588,7 +2636,7 @@ systemctl start mpd.socket</programlisting>
</entry> </entry>
<entry> <entry>
Specifies whether the stream should be "public". Specifies whether the stream should be "public".
Default is "no". Default is <parameter>no</parameter>.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -2737,7 +2785,9 @@ mpc load soundcloud://url/https://soundcloud.com/ARTIST/TRACK-NAME ...@@ -2737,7 +2785,9 @@ mpc load soundcloud://url/https://soundcloud.com/ARTIST/TRACK-NAME
<parameter>client_id</parameter> <parameter>client_id</parameter>
</entry> </entry>
<entry> <entry>
User apikey/client_id can override the MPD token provided by SoundCloud. User apikey/client_id can override the
<application>MPD</application> token provided by
SoundCloud.
</entry> </entry>
</row> </row>
</tbody> </tbody>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment