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