INSTALL

   1 terminatorX INSTALL:
   2 Copyright (C) 1999, 2000, 2001 by Alexander König <alex@lisas.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="-O3 -mathlon" btw. You'll need to have a
  28         "athlon-aware" compiler to use that though (gcc > 2.95.?).
  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                 File support options:
  60                 ---------------------
  61
  62                 All of these are enabled by default. Nevertheless the configure
  63                 script checks for the availability of the helper application
  64                 and if it's not found disables support for it. Check the
  65                 terminatorX homepage for links to those apps if you don't have
  66                 them - or check your distribution first, AFAIK all bring these
  67                 tools nowaday.
  68
  69                 --enable-wav
  70
  71                 This enables the builtin wav routines. They load 16Bit/44Khz
  72                 MONO RIFF/WAV files only but they do that significantly faster
  73                 than using sox. If these routines fail and sox support is
  74                 enabled, terminatorX will try to load the file with sox as
  75                 a fallback. Disable them only if they don't load your files
  76                 correctly.
  77
  78                 --enable-sox
  79
  80                 This enables sox support. As sox can load nearly any audio file
  81                 it makes sense to use it. You have to have sox installed of
  82                 course.
  83
  84                 --enable-mpg123
  85
  86                 This enables mpg123 support. If you want to be able to load mp3
  87                 files keep this option enabled. You have to have mpg123
  88                 installed of course.
  89
  90                 --enable-ogg123
  91
  92                 With this option you can turn on/off support for Ogg Vorbis
  93                 soundfiles. This requires ogg123 (Version >= 1.0RC2) and
  94                 sox to be installed.
  95
  96                 Misc options:
  97                 -------------
  98
  99                 --enable-3dnow
 100
 101                 This will cause the binary to include 3DNow! accelerated
 102                 mixing routines. The rule's simple: if your CPU does support
 103                 3DNow! then turn it on (it enhances performance quite a bit)
 104                 - if your machine doesn't, well then keep it disabled. A binary
 105                 created with 3DNow! acceleration will *not* run on machines
 106                 without 3DNow!.
 107
 108                 --enable-debug
 109
 110                 This will cause terminatorX to display some debug messages on
 111                 your console.
 112
 113                 Just as an example my configure line is (works with bash only):
 114                 > CFLAGS="-O3 -mathlon" ./configure
 115
 116 Step 2: Build the binary.
 117 -------------------------
 118
 119         This one's easy:
 120         > make
 121
 122 Step 3: Install the binary:
 123 ---------------------------
 124
 125         Just as easy:
 126         > make install
 127
 128         You need root privileges though. If you don't have them simply copy
 129         the terminatorX-binary (in src/terminatorX) to a directory of your
 130         choice and run terminatorX form there.