Update to 6762
[qball-mpd.git] / INSTALL
blobe0bc9e5518ae8ba43fadaa68c1470c3e037794df
1                        Music Player Daemon (MPD) - INSTALL
3 Optional Output Dependencies
4 ----------------------------
6 You will need at least one of these to compile MPD.
8 Most of these are available as packages on major distributions.  Be sure to
9 install both the library package as well as the development package.
11 AO - http://www.xiph.org/ao/
12 A portable library that abstracts many audio output types as one API.  Should
13 be used only if there is no native plugin available or if the native plugin
14 doesn't work.  You will need libao.
16 ALSA - http://www.alsa-project.org/
17 The Advanced Linux Sound Architecture.  Recommended audio output if you use
18 Linux.  You will need libasound.
20 PulseAudio - http://www.pulseaudio.org/
21 An advanced sound daemon.  You will need libpulse.
23 JACK - http://www.jackaudio.org/
24 A low-latency sound daemon.
26 libshout - http://www.icecast.org/
27 For streaming to an Icecast or Shoutcast server.
29 Optional Input Dependencies
30 ---------------------------
32 You will need at least one of these to compile MPD.
34 Most of these are available as packages on major distributions.  Be sure to
35 install both the library package as well as the development package.
37 MAD - http://www.underbit.com/products/mad/
38 For MP3 support.  You will need libmad, and optionally libid3tag if you want
39 ID3 tag support.
41 Ogg Vorbis - http://www.xiph.org/ogg/vorbis/
42 For Ogg Vorbis support.  You will need libogg and libvorbis.
44 FLAC - http://flac.sourceforge.net/
45 For FLAC support.  You will need version 1.1.0 or higher of libflac.
47 OggFLAC - http://www.xiph.org/ogg/vorbis/ and http://flac.sourceforge.net/
48 For OggFLAC support.  You will need liboggflac, which can be built from the
49 FLAC sources if libogg is already installed.  Versions of flac 1.1.3 and
50 greater will automatically detect and use OggFLAC if it's available.
52 Audio File - http://www.68k.org/~michael/audiofile/
53 For WAVE, AIFF, and AU support.  You will need libaudiofile.
55 FAAD2 - http://www.audiocoding.com/
56 For MP4/AAC support.  You will need libmp4ff.
58 libmpcdec - http://www.musepack.net/
59 For Musepack support.
61 MikMod - http://mikmod.raphnet.net/
62 For MOD support.  You will need libmikmod.
64 Optional Miscellaneous Dependencies
65 -----------------------------------
67 Avahi - http://www.avahi.org/
68 For Zeroconf support.
70 libsamplerate - http://www.mega-nerd.com/SRC/
71 For advanced samplerate conversions.
73 Download
74 --------
76 Get the latest release from of MPD from <http://www.musicpd.org/>.
78 Compile
79 -------
81 1) unzip and untar the archive
83 $ tar zxvf mpd-x.x.x.tar.gz
87 $ tar jxvf mpd-x.x.x.tar.bz2
89 2) change to directory created
91 $ cd mpd-x.x.x
93 3) Run configure script (this will determine what dependencies you have)
95 $ ./configure
97 4) Compile
99 $ make
101 Install (Optional)
102 -------
104 (as root)
105 $ make install
110 1) run mpd:
112 $ mpd <config file>
114 (if no config file is specified, mpd's looks for ~/.mpdconf then /etc/mpd.conf)
116 an example would be:
118 $ mpd playlists/.mpdconf
120 A sample config file is included with the source of MPD, mpdconf.example .
122 Note: The first time you run mpd, it will "explore" your mp3 directory for
123 mp3's.
125 Using MPD
126 ---------
128 You can download many different interfaces for MPD at 
129         <http://mpd.wikia.com/wiki/Clients>
131 MPD can be interfaced directly using telnet (see COMMANDS, if you are brave).