INSTALL

   1 Tairon installation instructions
   2 ================================
   3
   4 Requirements
   5 ------------
   6
   7 1. Linux kernel version 2.6 (Tairon uses epoll interface)
   8 2. Jam build tool - unlike many other programs Tairon uses jam for building.
   9    Jam can be downloaded at http://www.perforce.com/jam/jam.html
  10 3. Sane build environment: C++ compiler (Tairon is tested with GCC 4.1)
  11
  12
  13 Configuration
  14 -------------
  15
  16 Because Tairon uses Jam, all configuration options are located in the Jamrules
  17 file in the package's root directory. Edit this file in your favourite text
  18 editor to adjust settings. There are some interesting variables:
  19
  20 PREFIX::
  21         This points to the base directory for installation. It defaults to
  22         /usr/local.
  23
  24 INCDIR::
  25         Directory where header files will be installed. Its default is
  26         $(PREFIX)/include directory.
  27
  28 LIBDIR::
  29         Directory where libraries will be installed. It defaults to
  30         $(PREFIX)/lib/tairon.
  31
  32 C++FLAGS::
  33         Flags that are passed to the compiler during building object (*.o)
  34         files.
  35
  36 DEBUG::
  37         If it is set to 1 then the library will be build with debug
  38         information and it will not use optimization (-O2 flag to the
  39         compiler).
  40
  41
  42 Building and installing
  43 -----------------------
  44
  45 To build the libraries run `jam` command in the package's root directory. To
  46 install them run `jam install`. Note that this step may need root privileges if
  47 you want to install the libraries system-wide. The final step may be editing
  48 the /etc/ld.so.conf file and adding directory where the libraries are installed
  49 (otherwise programs that want to use this library may not be able to find the
  50 libraries at runtime) and running ldconfig program to update ls.so.cache file.