summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMax Kellermann <max@musicpd.org>2017-04-24 15:32:24 +0200
committerMax Kellermann <max@musicpd.org>2017-04-24 20:07:52 +0200
commit043cbec68ff57fb22ce4a10c4b58b7e84f47d736 (patch)
tree9151047643b1c925a455843410f86e615adee35b
parent7d7217ef892b96fa61c28a8568a41dfb2490c89c (diff)
INSTALL: merge into doc/user.xml
-rw-r--r--INSTALL200
-rw-r--r--README.md3
-rw-r--r--doc/user.xml99
3 files changed, 74 insertions, 228 deletions
diff --git a/INSTALL b/INSTALL
deleted file mode 100644
index 78b157ed1..000000000
--- a/INSTALL
+++ /dev/null
@@ -1,200 +0,0 @@
- Music Player Daemon (MPD) - INSTALL
-
-
-Introduction
-------------
-
-This document is a very small amount of documentation about what is needed to
-install MPD. If more information is desired, read the user manual:
-
- http://www.musicpd.org/doc/user/
-
-Dependencies
-------------
-
-gcc 4.7 or later - http://gcc.gnu.org/
-clang 3.2 or later - http://clang.llvm.org/
-Any other C++11 compliant compiler should also work.
-
-Boost 1.46 - http://www.boost.org/
-
-
-Optional Output Dependencies
-----------------------------
-
-You will need at least one of these to compile MPD.
-
-Most of these are available as packages on major distributions. Be sure to
-install both the library package as well as the development package.
-
-AO - http://www.xiph.org/ao/
-A portable library that abstracts many audio output types as one API. Should
-be used only if there is no native plugin available or if the native plugin
-doesn't work. You will need libao.
-
-ALSA - http://www.alsa-project.org/
-The Advanced Linux Sound Architecture. Recommended audio output if you use
-Linux. You will need libasound.
-
-FIFO
-This is a mostly undocumented, developer plugin to transmit raw data.
-
-OSS - http://www.opensound.com
-Open Sound System.
-
-PulseAudio - http://www.pulseaudio.org/
-An advanced sound daemon. You will need libpulse.
-
-JACK - http://www.jackaudio.org/
-A low-latency sound daemon.
-
-libshout - http://www.icecast.org/
-For streaming to an Icecast or Shoutcast server.
-You also need an encoder: either libvorbisenc (ogg), or liblame (mp3).
-
-OpenAL - http://kcat.strangesoft.net/openal.html
-Open Audio Library
-
-
-Optional Input Dependencies
----------------------------
-
-You will need at least one of these to compile MPD.
-
-Most of these are available as packages on major distributions. Be sure to
-install both the library package as well as the development package.
-
-MAD - http://www.underbit.com/products/mad/
-For MP3 support. You will need libmad, and optionally libid3tag if you want
-ID3 tag support.
-
-libmpg123 - http://www.mpg123.de/
-Alternative for MP3 support.
-
-Ogg Vorbis - http://www.xiph.org/ogg/vorbis/
-For Ogg Vorbis support. You will need libogg and libvorbis.
-
-libopus - http://www.opus-codec.org/
-Opus codec support
-
-FLAC - http://flac.sourceforge.net/
-For FLAC support. You will need version 1.2 or higher of libFLAC.
-
-Audio File - http://www.68k.org/~michael/audiofile/
-For WAVE, AIFF, and AU support. You will need libaudiofile.
-
-FAAD2 - http://www.audiocoding.com/
-For MP4/AAC support.
-
-libmpcdec - http://www.musepack.net/
-For Musepack support.
-
-MikMod - http://mikmod.raphnet.net/
-For MOD support. You will need libmikmod.
-
-libavcodec, libavformat (ffmpeg or libav) - http://ffmpeg.mplayerhq.hu/ http://libav.org/
-Multi-codec library.
-
-libsidplay2 - http://sidplay2.sourceforge.net/
-For C64 SID support.
-
-libfluidsynth - http://fluidsynth.resonance.org/
-For MIDI support.
-
-libwildmidi 0.2.3 - http://wildmidi.sourceforge.net/
-For MIDI support.
-
-libsndfile - http://www.mega-nerd.com/libsndfile/
-WAVE, AIFF, and many others.
-
-libwavpack - http://www.wavpack.com/
-For WavPack playback.
-
-libadplug - http://adplug.sourceforge.net/
-For AdLib playback.
-
-
-Optional Miscellaneous Dependencies
------------------------------------
-
-libsamplerate - http://www.mega-nerd.com/SRC/
-For advanced samplerate conversions.
-
-libcurl - http://curl.haxx.se/
-For playing HTTP streams.
-
-libmms - https://launchpad.net/libmms
-For playing MMS streams.
-
-libcdio - http://www.gnu.org/software/libcdio/
-For playing audio CDs.
-
-libsystemd-daemon - http://freedesktop.org/wiki/Software/systemd/
-For systemd activation.
-
-
-pkg-config
-----------
-
-MPD uses pkg-config to locate most external libraries. If you do not
-have pkg-config, or if your version of the library does not ship the
-".pc" file, you have to provide the library's build options in
-environment variables. These variables are documented in "./configure
---help". Example:
-
- FLAC_CFLAGS=-I/usr/include/FLAC FLAC_LIBS=-lFLAC ./configure
-
-
-Download
---------
-
-Get the latest release from of MPD from <http://www.musicpd.org/>.
-
-Compile
--------
-
-1) unpack the archive
-
-$ tar xf mpd-x.x.x.tar.xz
-
-2) change to directory created
-
-$ cd mpd-x.x.x
-
-3) Run configure script (this will determine what dependencies you have)
-
-$ ./configure
-
-4) Compile
-
-$ make
-
-Install (Optional)
--------
-
-(as root)
-$ make install
-
-Run
----
-
-1) run mpd:
-
-$ mpd <config file>
-
-First default is $XDG_CONFIG_HOME/mpd/mpd.conf then ~/.mpdconf then
-~/.mpd/mpd.conf then /etc/mpd.conf. If neither of these exist a mpd
-configuration file must be specified at runtime.
-
-A sample config file is included with the source of MPD, mpdconf.example.
-
-The first time MPD is run it will attempt to discover all music in your
-music root, recursively. This can be affected by the symbolic link
-options specified in the example mpd.conf.
-
-Using MPD
----------
-
-You can download many different interfaces for MPD at
-
- http://www.musicpd.org/clients/
diff --git a/README.md b/README.md
index cc706f553..c80ccbf2f 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,8 @@ server's audio device. The daemon 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.
-For basic installation information see the INSTALL file.
+For basic installation instructions
+[read the manual](https://www.musicpd.org/doc/user/install.html).
# Users
diff --git a/doc/user.xml b/doc/user.xml
index 1ff58c8ca..97152394d 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -80,8 +80,35 @@
cd mpd-version</programlisting>
<para>
- Make sure that all the required libraries and build tools are
- installed. The <filename>INSTALL</filename> file has a list.
+ In any case, you need:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ a C++14 compiler (e.g. <ulink
+ url="http://gcc.gnu.org/">gcc 4.9</ulink> or <ulink
+ url="http://clang.llvm.org/">clang 3.9</ulink>)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://www.boost.org/">Boost 1.46</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="https://www.freedesktop.org/wiki/Software/pkg-config/">pkg-config</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Each plugin usually needs a codec library, which you also need
+ to install. Check the plugin reference for details about
+ required libraries.
</para>
<para>
@@ -2161,7 +2188,9 @@ run</programlisting>
<title><varname>cdio_paranoia</varname></title>
<para>
- Plays audio CDs. The URI has the form:
+ Plays audio CDs using <ulink
+ url="http://www.gnu.org/software/libcdio/"><filename>libcdio</filename></ulink>.
+ The URI has the form:
"<filename>cdda://[DEVICE][/TRACK]</filename>". The
simplest form <filename>cdda://</filename> plays the whole
disc in the default drive.
@@ -2197,7 +2226,8 @@ run</programlisting>
<title><varname>curl</varname></title>
<para>
- Opens remote files or streams over HTTP.
+ Opens remote files or streams over HTTP using <ulink
+ url="http://curl.haxx.se/"><filename>libcurl</filename></ulink>.
</para>
<para>
@@ -2290,7 +2320,8 @@ run</programlisting>
<title><varname>mms</varname></title>
<para>
- Plays streams with the MMS protocol.
+ Plays streams with the MMS protocol using <ulink
+ url="https://launchpad.net/libmms"><filename>libmms</filename></ulink>.
</para>
</section>
@@ -2346,7 +2377,8 @@ run</programlisting>
<title><varname>adplug</varname></title>
<para>
- Decodes AdLib files.
+ Decodes AdLib files using <ulink
+ url="http://adplug.sourceforge.net/">libadplug</ulink>.
</para>
<informaltable>
@@ -2377,8 +2409,8 @@ run</programlisting>
<title><varname>audiofile</varname></title>
<para>
- Decodes WAV and AIFF files using
- <filename>libaudiofile</filename>.
+ Decodes WAV and AIFF files using <ulink
+ url="http://audiofile.68k.org/"><filename>libaudiofile</filename></ulink>.
</para>
</section>
@@ -2386,7 +2418,8 @@ run</programlisting>
<title><varname>faad</varname></title>
<para>
- Decodes AAC files using <filename>libfaad</filename>.
+ Decodes AAC files using <ulink
+ url="http://www.audiocoding.com/"><filename>libfaad</filename></ulink>.
</para>
</section>
@@ -2394,8 +2427,8 @@ run</programlisting>
<title><varname>ffmpeg</varname></title>
<para>
- Decodes various codecs using
- <application>FFmpeg</application>.
+ Decodes various codecs using <ulink
+ url="https://ffmpeg.org/"><application>FFmpeg</application></ulink>.
</para>
<informaltable>
@@ -2446,7 +2479,7 @@ run</programlisting>
<para>
Decodes FLAC files using
- <application>libFLAC</application>.
+ <ulink url="https://xiph.org/flac/"><application>libFLAC</application></ulink>.
</para>
</section>
@@ -2566,7 +2599,8 @@ run</programlisting>
<title><varname>mad</varname></title>
<para>
- Decodes MP3 files using <application>libmad</application>.
+ Decodes MP3 files using <ulink
+ url="http://www.underbit.com/products/mad/"><application>libmad</application></ulink>.
</para>
</section>
@@ -2646,8 +2680,8 @@ run</programlisting>
<title><varname>mpcdec</varname></title>
<para>
- Decodes Musepack files using
- <application>libmpcdec</application>.
+ Decodes Musepack files using <ulink
+ url="http://www.musepack.net/"><application>libmpcdec</application></ulink>.
</para>
</section>
@@ -2655,7 +2689,17 @@ run</programlisting>
<title><varname>mpg123</varname></title>
<para>
- Decodes MP3 files using <application>libmpg123</application>.
+ Decodes MP3 files using <ulink
+ url="http://www.mpg123.de/"><application>libmpg123</application></ulink>.
+ </para>
+ </section>
+
+ <section id="opus_decoder">
+ <title><varname>opus</varname></title>
+
+ <para>
+ Decodes Opus files using <ulink
+ url="http://www.opus-codec.org/"><application>libopus</application></ulink>.
</para>
</section>
@@ -2675,8 +2719,8 @@ run</programlisting>
<title><varname>sidplay</varname></title>
<para>
- C64 SID decoder based on
- <application>libsidplay</application>.
+ C64 SID decoder based on <ulink
+ url="http://sidplay2.sourceforge.net/"><application>libsidplay</application></ulink>.
</para>
<informaltable>
@@ -2732,8 +2776,8 @@ run</programlisting>
<title><varname>sndfile</varname></title>
<para>
- Decodes WAV and AIFF files using
- <filename>libsndfile</filename>.
+ Decodes WAV and AIFF files using <ulink
+ url="http://www.mega-nerd.com/libsndfile/"><filename>libsndfile</filename></ulink>.
</para>
</section>
@@ -2741,8 +2785,8 @@ run</programlisting>
<title><varname>vorbis</varname></title>
<para>
- Decodes Ogg-Vorbis files using
- <application>libvorbis</application>.
+ Decodes Ogg-Vorbis files using <ulink
+ url="http://www.xiph.org/ogg/vorbis/"><application>libvorbis</application></ulink>.
</para>
</section>
@@ -2751,7 +2795,7 @@ run</programlisting>
<para>
Decodes WavPack files using
- <application>libwavpack</application>.
+ <ulink url="http://www.wavpack.com/"><application>libwavpack</application></ulink>.
</para>
</section>
@@ -3575,7 +3619,7 @@ run</programlisting>
</informaltable>
</section>
- <section>
+ <section id="jack_output">
<title><varname>jack</varname></title>
<para>
@@ -3855,7 +3899,7 @@ run</programlisting>
</informaltable>
</section>
- <section>
+ <section id="openal_output">
<title><varname>openal</varname></title>
<para>
@@ -4006,7 +4050,7 @@ run</programlisting>
<para>
The <varname>pulse</varname> plugin connects to a <ulink
url="http://www.freedesktop.org/wiki/Software/PulseAudio/"><application>PulseAudio</application></ulink>
- server.
+ server. Requires <filename>libpulse</filename>.
</para>
<informaltable>
@@ -4194,7 +4238,8 @@ run</programlisting>
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.
+ server using <filename>libshout</filename>. It forwards
+ tags to this server.
</para>
<para>