Merge commit 'meins/master'
[paraslash.git] / REQUIREMENTS
1 Requirements
2 ============
3
4 In any case you need
5
6 - gcc, the gnu compiler collection (shipped with distro): gcc-3.3
7 or newer is required.
8 - gnu make (shipped with disto, might be called gmake)
9 - bash (most likely already installed)
10 - A decent version of grep. Solaris' /bin/grep is not good enough,
11 /usr/xpg4/bin/grep is fine though.
12 - openssl (needed by server, client): usually shipped with
13 distro, but you might have to install the "development package"
14 (called libssl-dev on debian systems) as well:
15 http://www.openssl.org/
16 - help2man (for man page creation) ftp://ftp.gnu.org/pub/gnu/help2man
17 - software mixing, e.g. ALSA and the direct mixing plugin (dmix)
18
19 Optional features:
20
21 - *mp3*: The mp3 decoder of para_filter is based on libmad:
22 http://www.underbit.com/products/mad/. If you prefer to use
23 the libmad package provided by your distributor, make sure
24 to install the corresponding development package as well.
25
26 For version 2 id3 tag support, you'll need libid3tag which
27 is also available through the above link. Without libid3tag,
28 only version 1 tags are recognized.
29
30 Note that libmad is not necessary for the server side,
31 i.e. for sending mp3 files.
32
33 - *ogg vorbis*: For ogg vorbis streams you'll need libogg,
34 libvorbis, libvorbisfile: http://www.xiph.org/downloads/.
35 The corresponding Debian packages are called libogg-dev
36 libvorbis-dev, other distributors chose similar names.
37
38 - *aac*:
39 For aac files (m4a) you'll need libfaad. Get it at
40 http://www.audiocoding.com/modules/wiki/?page=AAC
41
42 - *ortp*:
43 If you intend to use the optional ortp streamer, you'll
44 need libortp which is contained in the linphone source code:
45 http://www.linphone.org/index.php/eng
46
47 - On Linux, you'll need to have ALSA's development package
48 installed. The Debian package is called libasound2-dev.
49
50 Hacking the source:
51
52 - gengetopt: ftp://ftp.gnu.org/pub/gnu/gengetopt/
53 - autoconf: ftp://ftp.gnu.org/pub/gnu/autoconf/
54 - git http://git.or.cz/
55 - grutatxt http://www.triptico.com/software/grutatxt.html
56 - doxygen http://www.stack.nl/~dimitri/doxygen/
57 - global ftp://ftp.gnu.org/pub/gnu/global