Alex: Added the new sources for terminatorX 3.5
[terminatorX.git] / INSTALL
1 terminatorX INSTALL:
2 Copyright (C) 1999 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="-O7 -mpentium" btw. You'll need to have a "pentium-aware"
25         compiler to use that though (egcs-pgcc).
26
27         The configure Options:
28
29                 --enable-wavonly
30
31                 Since Version 3.2 the terminatorX configure script automatically
32                 enables sox and mpg123 support, if these programs are found on
33                 the target system. So to be able to load close to any audiofile
34                 simply ensure you have sox and mpg123 installed an run the
35                 configure script - if you want to use the builtin wav-loading
36                 routines specify --enable-wavonly. These will be enabled if
37                 sox is not found of course.
38                 
39                 WARNING: Loading mp3's usually takes quite some time and 
40                 requires a whole lot of memory! tX does not support on-the-fly
41                 mp3 decoding, and therefor the whole mp3 will be decoded (by
42                 mpg123) before tX can handle the data.
43                 
44                 --enable-scheduler
45                 
46                 This option is only intended for people who have audiobuffer
47                 underruns (clicks) with their desired latency settings.
48                 If you run terminatorX compiled with this option as root, the
49                 engine thread will be run with FIFO-scheduling policy at the 
50                 highest priority. This is somewhat dangerous I guess, as is
51                 running programs as root anyway ;) If you want everybody to
52                 run terminatorX as root (THIS IS DANGEROUS AND YOU SHOULD NOT
53                 DO IT) cd (as root) into the directory where you installed
54                 terminatorX (usually /usr/local/bin) and execute:
55                 
56                 > chown root terminatorX
57                 > chmod u+s terminatorX
58                 
59                 I WARNED YOU! Anybody who can run this binary can completely
60                 erase your hardisk. BE CAREFUL.
61                 
62                 --enable-closedev=no
63                 
64                 The old "KEEP_DEV_OPEN" flag. Still does the same thing: Once
65                 the audiodevice is opened it won't be closed until you exit
66                 terminatorX. Good for devices that click when opened.
67
68                 Just as an example my configure line is (works with bash only):
69                 > CFLAGS="-O7 -mpentium" ./configure 
70
71 Step 2: Build the binary.
72 -------------------------
73
74         This one's easy:
75         > make
76         
77 Step 3: Install the binary:
78 ---------------------------
79
80         Just as easy:
81         > make install
82         
83         You need root privileges though. If you don't have them simply copy
84         the terminatorX-binary (in src/terminatorX) to a directory of your
85         choice and run terminatorX form there.