Adding support for Linux' POSIX capabilities - Alex
[terminatorX.git] / INSTALL
1 terminatorX INSTALL:
2 Copyright (C) 1999 - 2003 by Alexander K├Ânig <alex@lisas.de>
3 http://terminatorX.cx
4
5 Note: As of Version 3.70 you need to have LADSPA installed to compile
6 terminatorX. To get LADSPA visit http: http://www.ladspa.org
7
8 Quickstart:
9 -----------
10
11         If you want enhanced audio-file support or optimization don't
12         "quickstart" but read the rest of this file.
13
14         If you just cant wait any longer try:
15         > ./configure
16         > make install
17
18 Step 1: Configure terminatorX.
19 ------------------------------
20
21         If you want your compiler to optimize the binary, you need to set your
22         environment variable CFLAGS to your needs BEFORE you run ./configure.
23
24         for example:
25         if use bash: > export CFLAGS="-O2"
26         with tcsh:   > setenv CFLAGS "-O2"
27
28         Optionally you might want to add your platform specific tunings (-m* stuff).
29
30         All of the following configure options can be either enabled with
31         --enable-option or disabled with --disable-option.
32
33         The configure Options:
34         
35                 File support options:
36                 ---------------------
37                 
38                 All of these are enabled by default. Nevertheless the configure
39                 script checks for the availability of the helper application
40                 and if it's not found disables support for it. Check the
41                 terminatorX homepage for links to those apps if you don't have
42                 them - or check your distribution first, AFAIK all bring these
43                 tools nowaday.
44                 
45                 --enable-mad
46                 
47                 This will make terminatorX use the MPEG Audio Decoder library if 
48                 it's detected. This allows terminatorX to load mp3 files
49                 significantly faster than with the mpg123 method. Additionally
50                 terminatorX will find out about the sampling rate of an mp3 file
51                 and adjust the playback speed accordingly.
52                 
53                 --enable-vorbis
54                 
55                 This will make terminatorX use the OGG Vobris libraries to load
56                 OGG files directly. This method has the same advantages over 
57                 loading through ogg123 as the "mad" method has over loading 
58                 through mpg123.
59                 
60                 --enable-audiofile
61                 
62                 This enables the use of libaudiofile on loading audio files.
63                 The library supports a wide range of common audio file formats
64                 (eg WAV/AIFF/AU etc) therefor its use highly recommended.
65                 
66                 --enable-wav
67                 
68                 This enables the builtin wav routines. They load 16Bit/44Khz
69                 MONO RIFF/WAV files only but they do that significantly faster
70                 than using sox. If these routines fail and sox support is
71                 enabled, terminatorX will try to load the file with sox as 
72                 a fallback. Disable them only if they don't load your files
73                 correctly.
74                 
75                 --enable-sox
76                 
77                 This enables sox support. As sox can load nearly any audio file
78                 it makes sense to use it. You have to have sox installed of 
79                 course.
80                 
81                 --enable-mpg123
82                 
83                 This enables mpg123 support. If you want to be able to load mp3
84                 files keep this option enabled. You have to have mpg123
85                 installed of course.
86                 
87                 --enable-ogg123
88                 
89                 With this option you can turn on/off support for Ogg Vorbis
90                 soundfiles. This requires ogg123 (Version >= 1.0RC2) and
91                 sox to be installed. 
92                 
93                 Other options:
94                 -------------
95                 
96                 --enable-capabilities
97                 
98                 Allows running terminatorX suid-root to gain realtime scheduling
99                 (see README.PERFORMANCE).
100                 
101                 --enable-suidroot
102                 
103                 Allows running terminatorX suid-root to gain realtime scheduling
104                 (see README.PERFORMANCE) - if your Linux system has capabilities
105                 you should prefer that method.
106                 
107                 --with-docdir
108                 
109                 If you intend to package terminatorX this flag will allow terminatorX
110                 to find the XML documentation in order to display it online.
111                 
112                 --disable-libxml2
113                 
114                 If you've got libxml V2 installed but you want terminatorX to 
115                 use V1 instead, use this to disable libxml V1.
116
117                 --enable-debug
118                 
119                 This will cause terminatorX to display some debug messages on
120                 your console. 
121                 
122                 Just as an example my configure line is (works with bash only):
123                 > CFLAGS="-O3 -mathlon" ./configure 
124
125 Step 2: Build the binary.
126 -------------------------
127
128         This one's easy:
129         > make
130         
131 Step 3: Install the binary:
132 ---------------------------
133
134         Just as easy:
135         > make install
136         
137         You need root privileges though. If you don't have them simply copy
138         the terminatorX-binary (in src/terminatorX) to a directory of your
139         choice and run terminatorX form there.