Update to Release 3.70 - Alex
[terminatorX.git] / INSTALL
1 terminatorX INSTALL:
2 Copyright (C) 1999, 2000 by Alexander K├Ânig <alkoit00@fht-esslingen.de>
3
4 Note: As of Version 3.70 you need to have LADSPA installed to compile
5 terminatorX.
6
7 Quickstart:
8 -----------
9
10         If you want enhanced audio-file support or optimization don't
11         "quickstart" but read the rest of this file.
12
13         If you just cant wait any longer try:
14         > ./configure
15         > make install
16
17 Step 1: Configure terminatorX.
18 ------------------------------
19
20         If you want your compiler to optimize the binary, you need to set your
21         environment variable CFLAGS to your needs BEFORE you run ./configure.
22
23         for example:
24         if use bash: > export CFLAGS="-O2"
25         with tcsh:   > setenv CFLAGS "-O2"
26
27         I use CFLAGS="-O6 -mpentiumpro" btw. You'll need to have a
28         "pentium-aware" compiler to use that though (gcc/pgcc).
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                 Performance Options:
36                 --------------------
37                 
38                 --enable-scheduler
39                 
40                 NEW: since 3.5 this option is enabled by default, as you can
41                 now operate the GUI while sound is playing, which can cause 
42                 audio dropouts when the GUI and the sound thread run at the
43                 same priority. You still need root privileges though.
44                 
45                 If you run terminatorX compiled with this option as root, the
46                 engine thread will be run with FIFO-scheduling policy at the 
47                 highest priority. This is somewhat dangerous I guess, as is
48                 running programs as root anyway ;) If you want everybody to
49                 run terminatorX as root (THIS IS DANGEROUS AND YOU SHOULD NOT
50                 DO IT) cd (as root) into the directory where you installed
51                 terminatorX (usually /usr/local/bin) and execute:
52                 
53                 > chown root terminatorX
54                 > chmod u+s terminatorX
55                 
56                 I WARNED YOU! Anybody who can run this binary can completely
57                 erase your hardisk. BE CAREFUL.
58                 
59                 --enable-3dnow
60                 
61                 This enables EXPERIMENTAL 3DNow! support. It seems as if the
62                 current libmmx (which is included) doesn't work with the new
63                 gcc 2.95. So if you use that compiler do not enable this option.
64                 
65                 The built binary will run on CPUs with 3DNow! support only.
66                 AFAIK these are the K6II, K6III and the Athlon (K7). INTEL CPUs
67                 don't have 3DNow! support!
68                 
69                 For now this the only thing that might run a little faster is
70                 the echo effect. I planned to hack more 3DNow! code but at the
71                 moment I simply don't have the time.
72                                 
73                 File support options:
74                 ---------------------
75                 
76                 All of these are enabled by default. Nevertheless the configure
77                 script checks for the availability of the helper application
78                 and if it's not found disables support for it. Check the
79                 terminatorX homepage for links to those apps if you don't have
80                 them - or check your distribution first, AFAIK all bring these
81                 tools nowaday.
82                 
83                 --enable-wav
84                 
85                 This enables the builtin wav routines. They load 16Bit/44Khz
86                 MONO RIFF/WAV files only but they do that significantly faster
87                 than using sox. If these routines fail and sox support is
88                 enabled, terminatorX will try to load the file with sox as 
89                 a fallback. Disable them only if they don't load your files
90                 correctly.
91                 
92                 --enable-sox
93                 
94                 This enables sox support. As sox can load nearly any audio file
95                 it makes sense to use it. You have to have sox installed of 
96                 course.
97                 
98                 --enable-mpg123
99                 
100                 This enables mpg123 support. If you want to be able to load mp3
101                 files keep this option enabled. You have to have mpg123
102                 installed of course.
103                 
104                 Misc options:
105                 -------------
106
107                 --enable-closedev
108                 
109                 This has no effect at the moment. Sorry. Don't disable it.
110                 
111                 --enable-debug
112                 
113                 This will cause terminatorX to display some debug messages on
114                 your console. 
115                 
116                 Just as an example my configure line is (works with bash only):
117                 > CFLAGS="-O2 -mpentiumpro" ./configure 
118
119 Step 2: Build the binary.
120 -------------------------
121
122         This one's easy:
123         > make
124         
125 Step 3: Install the binary:
126 ---------------------------
127
128         Just as easy:
129         > make install
130         
131         You need root privileges though. If you don't have them simply copy
132         the terminatorX-binary (in src/terminatorX) to a directory of your
133         choice and run terminatorX form there.