INSTALL

   1 CryWrap Installation notes
   2 ==========================
   3
   4 Build requirements
   5 ------------------
   6
   7 In order to compile CryWrap from sources certain additional software
   8 must be present on the build system, including a POSIX-compatible
   9 shell (usually /bin/sh), a POSIX compliant C library, a compiler that
  10 supports C99 (GCC is such a compiler), GNU make, GnuTLS (version 1.0.0
  11 or later), and Libidn.
  12
  13 How to compile CryWrap
  14 ----------------------
  15
  16 Its really quite simple - its about the same difficulty as compiling
  17 any GNU software.
  18
  19 Just `cd' to the directory containing the sources, and type
  20 `./configure'.  This will try to collect as much information about the
  21 build environment as is needed to successfully compile the package.
  22 This step usually takes a while, so feel free to sit back and drink a
  23 cup of tea.
  24
  25 When `configure' finished successfully, the package can be compiled by
  26 issuing the `make' (or `gmake' on certain non-GNU systems) command.
  27 This will build both the executable in `src/crywrap' and certain
  28 support files.
  29
  30 To install them all to their proper place, issue the `make install'
  31 command, as the final step of the installation stage.  For information
  32 about configuring and running CryWrap, please see the manual page.
  33
  34 To clean the source tree, run `make clean' - this is useful if one
  35 wants to force a rebuild or make a whole-tree diff between the
  36 original and a modified version of CryWrap.  To also clean the files
  37 `configure' created, use the `make distclean' command.  If one wants
  38 to build CryWrap for a different machine, or with different options,
  39 this is the command to issue.
  40
  41 Compilers and Options
  42 ---------------------
  43
  44 Some systems require unusual options for compilation or linking that
  45 the `configure' script does not know about.  Run `./configure --help'
  46 for details on some of the pertinent environment variables.
  47
  48 You can give `configure' initial values for configuration parameters
  49 by setting variables in the command line or in the environment.  Here
  50 is an example:
  51
  52       ./configure CC=gcc CFLAGS="-Wno-shadow -O2" LIBS=-lposix
  53
  54 Installation Names
  55 ------------------
  56
  57 By default, `make install' will install the package's files in
  58 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
  59 installation prefix other than `/usr/local' by giving `configure' the
  60 option `--prefix=PATH'.
  61
  62 You can specify separate installation prefixes for
  63 architecture-specific files and architecture-independent files.  If
  64 you give `configure' the option `--exec-prefix=PATH', the package will
  65 use PATH as the prefix for installing programs and libraries.
  66 Documentation and other data files will still use the regular prefix.
  67
  68 In addition, if you use an unusual directory layout you can give
  69 options like `--bindir=PATH' to specify different values for
  70 particular kinds of files.  Run `configure --help' for a list of the
  71 directories you can set and what kinds of files go in them.
  72
  73 Optional Features
  74 -----------------
  75
  76 CryWrap can be configured with or without certain features - such as
  77 extra debugging.  Some of these are enabled by default, some are not.
  78
  79 The list of options to control these features are listed below:
  80
  81 * `--enable-debug'
  82         Strictly for debugging purposes. This makes CryWrap log an
  83         awful lot of information and behave slightly differently (so
  84         it can be ran under a debugger painlessly), which is of no use
  85         to anyone but developers.