diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mpd.conf.5 | 4 | ||||
| -rw-r--r-- | doc/protocol.xml | 2 | ||||
| -rw-r--r-- | doc/user.xml | 215 |
3 files changed, 215 insertions, 6 deletions
diff --git a/doc/mpd.conf.5 b/doc/mpd.conf.5 index c8e632478..61ee87955 100644 --- a/doc/mpd.conf.5 +++ b/doc/mpd.conf.5 @@ -35,8 +35,8 @@ You must recreate the database after changing this option. The default is "yes". .TP .B follow_inside_symlinks <yes or no> -Control if MPD will follow symbolic links pointing outside the music dir, potentially -adding duplicates to the database. +Control if MPD will follow symbolic links pointing inside the music dir, +potentially adding duplicates to the database. You must recreate the database after changing this option. The default is "yes". .TP diff --git a/doc/protocol.xml b/doc/protocol.xml index 35ea39d8e..7c93df50f 100644 --- a/doc/protocol.xml +++ b/doc/protocol.xml @@ -134,7 +134,7 @@ <listitem> <para> <returnvalue>database</returnvalue>: the song database - has been modified + has been modified after <command>update</command>. </para> </listitem> <listitem> diff --git a/doc/user.xml b/doc/user.xml index 22da500b1..6e039ebde 100644 --- a/doc/user.xml +++ b/doc/user.xml @@ -11,6 +11,30 @@ This document is work in progress. Most of it may be incomplete yet. Please help! </para> + + <para> + MPD (Music Player Daemon) is, as the name suggests, a server + software allowing you to remotely play your music, handle + playlists, deliver music (HTTP STREAMS with various + sub-protocols) and organizze playlists. + </para> + + <para> + It has been written with minimal resource usage and stability in + mind! Infact, it runs fine on a Pentium 75, allowing you to use + your cheap old PC to create a stereo system! + </para> + + <para> + MPD supports also Gapless playback, buffered audio output, and + crossfading! + </para> + + <para> + The separate client and server design allows users to choose a + user interface that best suites their tastes independently of + the underlying daemon, which actually plays music! + </para> </chapter> <chapter> @@ -26,10 +50,16 @@ <title>Installing on Debian/Ubuntu</title> <para> - Install the package <filename>mpd</filename>: + Install the package <filename>mpd</filename> via APT: </para> <programlisting>apt-get install mpd</programlisting> + + <para> + When installed this way, MPD by default looks for music in + /var/lib/mpd/music/; this may not be correct. Look at your + /etc/mpd.conf file... + </para> </section> <section> @@ -41,8 +71,8 @@ page</ulink> and unpack it: </para> - <programlisting>tar xjf mpd-0.14.2.tar.bz -cd mpd-0.14.2</programlisting> + <programlisting>tar xjf mpd-version.tar.bz +cd mpd-version</programlisting> <para> Make sure that all the required libraries and build tools are @@ -737,6 +767,28 @@ cd mpd-0.14.2</programlisting> The <varname>pipe</varname> plugin starts a program and writes raw PCM data into its standard input. </para> + + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Setting</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <varname>command</varname> + <parameter>CMD</parameter> + </entry> + <entry> + This command is invoked with the shell. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </section> <section> @@ -746,6 +798,40 @@ cd mpd-0.14.2</programlisting> The <varname>pulse</varname> plugin connects to a PulseAudio server. </para> + + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Setting</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <varname>server</varname> + <parameter>HOSTNAME</parameter> + </entry> + <entry> + Sets the host name of the PulseAudio server. By + default, MPD connects to the local PulseAudio + server. + </entry> + </row> + <row> + <entry> + <varname>sink</varname> + <parameter>NAME</parameter> + </entry> + <entry> + Specifies the name of the PulseAudio sink MPD should + play on. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </section> <section> @@ -755,6 +841,129 @@ cd mpd-0.14.2</programlisting> The <varname>shout</varname> plugin connects to a ShoutCast or IceCast server. It forwards tags to this server. </para> + + <para> + You must set a <varname>format</varname>. + </para> + + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Setting</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <varname>host</varname> + <parameter>HOSTNAME</parameter> + </entry> + <entry> + Sets the host name of the Shoutcast/Icecast server. + </entry> + </row> + <row> + <entry> + <varname>port</varname> + <parameter>PORTNUMBER</parameter> + </entry> + <entry> + Connect to this port number on the specified host. + </entry> + </row> + <row> + <entry> + <varname>timeout</varname> + <parameter>SECONDS</parameter> + </entry> + <entry> + Set the timeout for the shout connection in seconds. + Defaults to 2 seconds. + </entry> + </row> + <row> + <entry> + <varname>mount</varname> + <parameter>URI</parameter> + </entry> + <entry> + Mounts the MPD stream in the specified URI. + </entry> + </row> + <row> + <entry> + <varname>user</varname> + <parameter>USERNAME</parameter> + </entry> + <entry> + Sets the user name for submitting the stream to the + server. Default is "source". + </entry> + </row> + <row> + <entry> + <varname>password</varname> + <parameter>PWD</parameter> + </entry> + <entry> + Sets the password for submitting the stream to the + server. + </entry> + </row> + <row> + <entry> + <varname>name</varname> + <parameter>NAME</parameter> + </entry> + <entry> + Sets the name of the stream. + </entry> + </row> + <row> + <entry> + <varname>genre</varname> + <parameter>GENRE</parameter> + </entry> + <entry> + Sets the genre of the stream (optional). + </entry> + </row> + <row> + <entry> + <varname>description</varname> + <parameter>DESCRIPTION</parameter> + </entry> + <entry> + Sets a short description of the stream (optional). + </entry> + </row> + <row> + <entry> + <varname>public</varname> + <parameter>yes|no</parameter> + </entry> + <entry> + Specifies whether the stream should be "public". + Default is "no". + </entry> + </row> + <row> + <entry> + <varname>encoder</varname> + <parameter>PLUGIN</parameter> + </entry> + <entry> + Sets the name of the encoder plugin. Default is + "vorbis". "vorbis" and "lame" are valid encoder + plugins (provided that you enabled them at compile + time). + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </section> <section> |