Documentation update and re-ordering.
[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
10 - openssl (needed by server, client): usually shipped with
11 distro, but you might have to install the "development package"
12 (called libssl-dev on debian systems) as well:
13 http://www.openssl.org/
14 - software mixing, e.g. ALSA and the direct mixing plugin (dmix)
15
16 Optional features:
17
18 - *mp3*:
19 The mp3 decoder of para_filter is based on libmad:
20 If you prefer to use the libmad package provided by your
21 distributor, make sure to install the corresponding development
22 package as well. Otherwise, just download libmad from
23 http://www.underbit.com/products/mad/
24
25 - *ogg vorbis*:
26 For ogg vorbis streams you'll need libogg, libvorbis,
27 libvorbisfile, The corresponding Debian packages are
28 called libogg-dev libvorbis-dev, other distributors chose
29 similar names. The source of these is also available at
30 http://www.xiph.org/downloads/
31
32 - *aac*:
33 For aac files (m4a) you'll need libfaad. Get it at
34 http://www.audiocoding.com/modules/wiki/?page=AAC
35
36 - *ortp*:
37 If you intend to use the optional ortp streamer, you'll need libortp:
38 http://www.linphone.org/ortp/
39
40 Hacking the source:
41
42 - gengetopt: ftp://ftp.gnu.org/pub/gnu/gengetopt/
43 - autoconf: ftp://ftp.gnu.org/pub/gnu/autoconf/
44 - grutatxt