ucw/doc/install.txt

   1 Installation of libucw
   2 ======================
   3
   4 Prerequisities
   5 --------------
   6 To build and run, you need:
   7
   8   -  The GNU toolchain (gcc 4.0 or newer is required)
   9   -  GNU bison and flex
  10   -  GNU bash 2.0 or newer
  11   -  Perl (any reasonably new version; 5.6.1 works for me)
  12   -  ZLib (newer than stone-age)
  13   -  pkg-config
  14   -  Linux (porting to other systems should be easy)
  15   -  GNUPlot 4.0 or newer (if you want to use Watson to draw nice graphs
  16      with various statistics)
  17   -  Libjpeg, libpng and libungif to support all image formats
  18      (jpeg, png and gif). These libraries can be replaced by libgif (gif)
  19      and GraphicsMagick >= 1.1 (jpeg, png, gif and possible more formats).
  20      See sherlock/default.cfg for related configuration switches.
  21   -  Mutt mail client for mail reports in some scripts
  22      (any reasonably new version; 1.5.9 works)
  23   -  GNU readline (optional, only non-free version of Sherlock)
  24
  25 Compiling
  26 ---------
  27 First of all, you need to run the `configure` script to set up compile-time
  28 options. If you want to compile the library with the default feature set,
  29 just use:
  30
  31         ./configure free
  32
  33 If you need to set anything unusual, please consult <<configure:>> for details.
  34
  35 The defaults determined by the configure script should be correct on Linux/i386,
  36 on other architectures you will probably need to tweak the CPU detection section
  37 in `ucw/autoconf.cfg` and possibly also the typedefs in `ucw/config.h`.
  38
  39 Then run
  40
  41         make
  42
  43 which builds the whole package in the `run` directory and you can play there.
  44 If you want to install it anywhere else, just use
  45
  46 //TODO Implement the installation
  47
  48         make install INSTALL_DIR=/where/to/install