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