Change year in COPYRIGHT to 2010.
[paraslash.git] / REQUIREMENTS
1 Requirements
2 ============
3
4 In any case you'll need
5
6         - *libosl*, the object storage layer: Used by para_server. It is
7           available from http://git.tuebingen.mpg.de/osl. Alternatively,
8           execute "git clone git://git.tuebingen.mpg.de/osl".
9
10         - *gcc*, the gnu compiler collection (shipped with distro): gcc-3.3
11           or newer is required.
12
13         - *gnu make* (shipped with disto, might be called gmake on BSD systems)
14
15         - *bash* (most likely already installed)
16
17         - *openssl* (needed by server, client): usually shipped with
18           distro, but you might have to install the "development package"
19           (called libssl-dev on debian systems) as well:
20           http://www.openssl.org/
21
22         - *help2man* (for man page creation) ftp://ftp.gnu.org/pub/gnu/help2man
23
24 Optional features:
25
26         - *mp3*: The mp3 decoder of para_filter is based on libmad:
27           http://www.underbit.com/products/mad/. If you prefer to
28           use the libmad package provided by your distributor, make
29           sure to install the corresponding development package as
30           well. It is called libmad0-dev on debian-based systems.
31           Note that libmad is not necessary for the server side,
32           i.e. for sending mp3 files.
33
34         - *id3 tags*:
35           For version-2 id3 tag support, you'll need libid3tag which
36           is also available through the above link (alternatively:
37           install package libid3tag0-dev). Without libid3tag, only
38           version one tags are recognized.
39
40         - *ogg vorbis*: For ogg vorbis streams you'll need libogg,
41           libvorbis, libvorbisfile: http://www.xiph.org/downloads/.
42           The corresponding Debian packages are called libogg-dev
43           libvorbis-dev, other distributors chose similar names.
44
45         - *aac*:
46           For aac files (m4a) you'll need libfaad. Get it at
47           http://www.audiocoding.com/.
48           Debian package: libfaad-dev.
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
61         - m4: ftp://ftp.gnu.org/pub/gnu/m4/