Minor documentation improvements.
[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 - software mixing, e.g. ALSA and the direct mixing plugin (dmix)
17
18 Optional features:
19
20 - *mp3*: The mp3 decoder of para_filter is based on libmad:
21 http://www.underbit.com/products/mad/. If you prefer to use
22 the libmad package provided by your distributor, make sure
23 to install the corresponding development package as well.
24 Note that libmad is not necessary for sending mp3 files.
25
26 - *ogg vorbis*: For ogg vorbis streams you'll need libogg,
27 libvorbis, libvorbisfile: http://www.xiph.org/downloads/.
28 The corresponding Debian packages are called libogg-dev
29 libvorbis-dev, other distributors chose similar names.
30
31 - *aac*:
32 For aac files (m4a) you'll need libfaad. Get it at
33 http://www.audiocoding.com/modules/wiki/?page=AAC
34
35 - *ortp*:
36 If you intend to use the optional ortp streamer, you'll
37 need libortp: http://www.linphone.org/ortp/
38
39 - On Linux, you'll need to have ALSA's development package
40 installed. The Debian package is called libasound2-dev.
41
42 Hacking the source:
43
44 - gengetopt: ftp://ftp.gnu.org/pub/gnu/gengetopt/
45 - autoconf: ftp://ftp.gnu.org/pub/gnu/autoconf/
46 - git http://git.or.cz/
47 - grutatxt http://www.triptico.com/software/grutatxt.html
48 - help2man ftp://ftp.gnu.org/pub/gnu/help2man
49 - doxygen http://www.stack.nl/~dimitri/doxygen/
50 - global ftp://ftp.gnu.org/pub/gnu/global