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