Improve help/man page of para_recv.
[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
23           use the libmad package provided by your distributor, make
24           sure to install the corresponding development package as
25           well. It is called libmad0-dev on debian-based systems.
26           Note that libmad is not necessary for the server side,
27           i.e. for sending mp3 files.
28
29         - *id3 tags*:
30           For version-2 id3 tag support, you'll need libid3tag which
31           is also available through the above link (alternatively:
32           install package libid3tag0-dev). Without libid3tag, only
33           version one tags are recognized.
34
35         - *ogg vorbis*: For ogg vorbis streams you'll need libogg,
36           libvorbis, libvorbisfile: http://www.xiph.org/downloads/.
37           The corresponding Debian packages are called libogg-dev
38           libvorbis-dev, other distributors chose similar names.
39
40         - *aac*:
41           For aac files (m4a) you'll need libfaad. Get it at
42           http://www.audiocoding.com/.
43           Debian package: libfaad-dev.
44
45         - *ortp*:
46           If you intend to use the optional ortp streamer, you'll
47           need libortp which is contained in the linphone source code:
48           http://www.linphone.org/index.php/eng
49
50         - On Linux, you'll need to have ALSA's development package
51           installed. The Debian package is called libasound2-dev.
52
53 Hacking the source:
54
55         - gengetopt: ftp://ftp.gnu.org/pub/gnu/gengetopt/
56         - autoconf: ftp://ftp.gnu.org/pub/gnu/autoconf/
57         - git http://git.or.cz/
58         - grutatxt http://www.triptico.com/software/grutatxt.html
59         - doxygen http://www.stack.nl/~dimitri/doxygen/
60         - global ftp://ftp.gnu.org/pub/gnu/global