update: added update_global_init() and update_global_finish()
[mpd-mk/metyl.git] / INSTALL
blob63f879cef21a0ac48de0a1f4680affe198e006b5
1                        Music Player Daemon (MPD) - INSTALL
4 Dependencies
5 ------------
7 gcc - http://gcc.gnu.org/
8 Any other C99 compliant compiler should also work.
10 glib - http://www.gtk.org/
11 General-purpose utility library.
14 Optional Output Dependencies
15 ----------------------------
17 You will need at least one of these to compile MPD.
19 Most of these are available as packages on major distributions.  Be sure to
20 install both the library package as well as the development package.
22 AO - http://www.xiph.org/ao/
23 A portable library that abstracts many audio output types as one API.  Should
24 be used only if there is no native plugin available or if the native plugin
25 doesn't work.  You will need libao.
27 ALSA - http://www.alsa-project.org/
28 The Advanced Linux Sound Architecture.  Recommended audio output if you use
29 Linux.  You will need libasound.
31 PulseAudio - http://www.pulseaudio.org/
32 An advanced sound daemon.  You will need libpulse.
34 JACK - http://www.jackaudio.org/
35 A low-latency sound daemon.
37 libshout - http://www.icecast.org/
38 For streaming to an Icecast or Shoutcast server.
39 You also need an encoder: either libvorbisenc (ogg), or liblame (mp3).
42 Optional Input Dependencies
43 ---------------------------
45 You will need at least one of these to compile MPD.
47 Most of these are available as packages on major distributions.  Be sure to
48 install both the library package as well as the development package.
50 MAD - http://www.underbit.com/products/mad/
51 For MP3 support.  You will need libmad, and optionally libid3tag if you want
52 ID3 tag support.
54 Ogg Vorbis - http://www.xiph.org/ogg/vorbis/
55 For Ogg Vorbis support.  You will need libogg and libvorbis.
57 FLAC - http://flac.sourceforge.net/
58 For FLAC support.  You will need version 1.1.0 or higher of libflac.
60 OggFLAC - http://www.xiph.org/ogg/vorbis/ and http://flac.sourceforge.net/
61 For OggFLAC support.  You will need liboggflac, which can be built from the
62 FLAC sources if libogg is already installed.  Versions of flac 1.1.3 and
63 greater will automatically detect and use OggFLAC if it's available.
65 Audio File - http://www.68k.org/~michael/audiofile/
66 For WAVE, AIFF, and AU support.  You will need libaudiofile.
68 FAAD2 - http://www.audiocoding.com/
69 For MP4/AAC support.  You will need libmp4ff.
71 libmpcdec - http://www.musepack.net/
72 For Musepack support.
74 MikMod - http://mikmod.raphnet.net/
75 For MOD support.  You will need libmikmod.
77 libavcodec, libavformat (ffmpeg) - http://ffmpeg.mplayerhq.hu/
78 Multi-codec library.
81 Optional Miscellaneous Dependencies
82 -----------------------------------
84 Avahi - http://www.avahi.org/
85 For Zeroconf support.
87 libsamplerate - http://www.mega-nerd.com/SRC/
88 For advanced samplerate conversions.
90 libcurl - http://curl.haxx.se/
91 For playing HTTP streams.
94 Download
95 --------
97 Get the latest release from of MPD from <http://www.musicpd.org/>.
99 Compile
100 -------
102 1) unzip and untar the archive
104 $ tar zxvf mpd-x.x.x.tar.gz
108 $ tar jxvf mpd-x.x.x.tar.bz2
110 2) change to directory created
112 $ cd mpd-x.x.x
114 3) Run configure script (this will determine what dependencies you have)
116 $ ./configure
118 4) Compile
120 $ make
122 Install (Optional)
123 -------
125 (as root)
126 $ make install
131 1) run mpd:
133 $ mpd <config file>
135 (if no config file is specified, mpd's looks for ~/.mpdconf then /etc/mpd.conf)
137 an example would be:
139 $ mpd playlists/.mpdconf
141 A sample config file is included with the source of MPD, mpdconf.example .
143 Note: The first time you run mpd, it will "explore" your mp3 directory for
144 mp3's.
146 Using MPD
147 ---------
149 You can download many different interfaces for MPD at 
150         <http://mpd.wikia.com/wiki/Clients>
152 MPD can be interfaced directly using telnet (see COMMANDS, if you are brave).