INSTALL

   1 Tairent installation instructions
   2 =================================
   3
   4 Requirements
   5 ------------
   6
   7 1. Jam build tool - unlike many other programs Tairent uses jam for building.
   8    Jam can be downloaded at http://www.perforce.com/jam/jam.html
   9 2. Installed Tairon library with all the header files. Homepage of Tairon is at
  10    http://trekie.sinister.cz/tairon.
  11 3. Sane build environment: C++ compiler (Tairent is tested with GCC 3.4)
  12
  13
  14 Configuration
  15 -------------
  16
  17 Because Tairent uses Jam, all configuration options are located in the Jamrules
  18 file in the package's root directory. Edit this file in your favourite text
  19 editor to adjust settings. There are some interesting variables:
  20
  21 CCFLAGS::
  22         Flags that are passed to the compiler during building object (*.o)
  23         files.
  24
  25 LDFLAGS::
  26         Flags that are passed to the linker.
  27
  28 LIBSDIR::
  29         Directory with Tairon libraries.
  30
  31 NODEBUG::
  32         If it is sue to 1 then the program will be built without debug
  33         information and it will use optimization (-O2 flag to the compiler).
  34
  35
  36 Building
  37 --------
  38
  39 To build the program run `jam` command in the package's root directory. If
  40 everything goes well then the binary will be located in the `bin/` directory
  41 and modules will be in `modules/` directory. It isn't possible to install
  42 Tairent system-wide at the moment.
  43
  44
  45 Running
  46 -------
  47
  48 First step is to place Tairent configuration file to some directory where it
  49 can be found. Tairent searches for `tairent.xml` fie at the following places:
  50 `./` (i.e. current directory), `/etc/`, `/usr/etc` and `/usr/local/etc` - in
  51 that order. Example configuration file is placed in the `etc/` directory of the
  52 package, so if you don't want to copy this file anywhere else you can run
  53 `tairent` from this directory or make a symlink from the `bin/` directory and
  54 run it from there.
  55
  56 Next comes configuration: open your favourite text editor and edit
  57 `tairent.xml` file to adjust paths to correct ones. If Tairent complains that
  58 it can't load some modules it is usually because it can't find them at the
  59 location from the configuration file.
  60
  61 So if you can get Tairent compiled and running you can ask how you can add
  62 torrents to download/serve. Just edit `torrents.xml` file in the
  63 `torrents-directory` (this option is stored in the configuration file). Example
  64 configuration file with name `torrents.xml.example` is provided in the
  65 `torrents/` directory. Note that this file is overwritten during running
  66 because Tairent saves here data needed for fast resuming.
  67
  68 And that's it. You can now run run the binary and watch how your network line
  69 is getting busy.