INSTALL

   1 Introduction
   2 ============
   3
   4   This installation guide is for POSIX (Autoconf) systems.
   5   For Win32, Win64, DOS and OS/2 please read the file B/00README.TXT.
   6
   7
   8   Quick start
   9   -----------
  10   The LZO library must be available on your system.  If you haven't
  11   installed LZO yet, you can set the environment variables `CPPFLAGS'
  12   and `LDFLAGS' to point to your LZO directory, e.g.:
  13
  14       export CPPFLAGS=-I/home/user/src/lzo-2.01/include
  15       export LDFLAGS=-L/home/user/src/lzo-2.01/src/.libs
  16       [ Note that you must use _absolute_ paths in these environment vars. ]
  17
  18   Then run the usual commands:
  19       ./configure
  20       make
  21       make install (as root)
  22
  23   Exotic machines
  24   ---------------
  25   Instead of using Autoconf you may want to adapt the simple build
  26   script in B/generic/build.sh.
  27
  28
  29
  30 [ The standard Autoconf installation instructions follow below. ]
  31
  32
  33
  34 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
  35 Foundation, Inc.
  36
  37    This file is free documentation; the Free Software Foundation gives
  38 unlimited permission to copy, distribute and modify it.
  39
  40 Basic Installation
  41 ==================
  42
  43    These are generic installation instructions.
  44
  45    The `configure' shell script attempts to guess correct values for
  46 various system-dependent variables used during compilation.  It uses
  47 those values to create a `Makefile' in each directory of the package.
  48 It may also create one or more `.h' files containing system-dependent
  49 definitions.  Finally, it creates a shell script `config.status' that
  50 you can run in the future to recreate the current configuration, and a
  51 file `config.log' containing compiler output (useful mainly for
  52 debugging `configure').
  53
  54    It can also use an optional file (typically called `config.cache'
  55 and enabled with `--cache-file=config.cache' or simply `-C') that saves
  56 the results of its tests to speed up reconfiguring.  (Caching is
  57 disabled by default to prevent problems with accidental use of stale
  58 cache files.)
  59
  60    If you need to do unusual things to compile the package, please try
  61 to figure out how `configure' could check whether to do them, and mail
  62 diffs or instructions to the address given in the `README' so they can
  63 be considered for the next release.  If you are using the cache, and at
  64 some point `config.cache' contains results you don't want to keep, you
  65 may remove or edit it.
  66
  67    The file `configure.ac' (or `configure.in') is used to create
  68 `configure' by a program called `autoconf'.  You only need
  69 `configure.ac' if you want to change it or regenerate `configure' using
  70 a newer version of `autoconf'.
  71
  72 The simplest way to compile this package is:
  73
  74   1. `cd' to the directory containing the package's source code and type
  75      `./configure' to configure the package for your system.  If you're
  76      using `csh' on an old version of System V, you might need to type
  77      `sh ./configure' instead to prevent `csh' from trying to execute
  78      `configure' itself.
  79
  80      Running `configure' takes awhile.  While running, it prints some
  81      messages telling which features it is checking for.
  82
  83   2. Type `make' to compile the package.
  84
  85   3. Optionally, type `make check' to run any self-tests that come with
  86      the package.
  87
  88   4. Type `make install' to install the programs and any data files and
  89      documentation.
  90
  91   5. You can remove the program binaries and object files from the
  92      source code directory by typing `make clean'.  To also remove the
  93      files that `configure' created (so you can compile the package for
  94      a different kind of computer), type `make distclean'.  There is
  95      also a `make maintainer-clean' target, but that is intended mainly
  96      for the package's developers.  If you use it, you may have to get
  97      all sorts of other programs in order to regenerate files that came
  98      with the distribution.
  99
 100 Compilers and Options
 101 =====================
 102
 103    Some systems require unusual options for compilation or linking that
 104 the `configure' script does not know about.  Run `./configure --help'
 105 for details on some of the pertinent environment variables.
 106
 107    You can give `configure' initial values for configuration parameters
 108 by setting variables in the command line or in the environment.  Here
 109 is an example:
 110
 111      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
 112
 113 Compiling For Multiple Architectures
 114 ====================================
 115
 116    You can compile the package for more than one kind of computer at the
 117 same time, by placing the object files for each architecture in their
 118 own directory.  To do this, you must use a version of `make' that
 119 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 120 directory where you want the object files and executables to go and run
 121 the `configure' script.  `configure' automatically checks for the
 122 source code in the directory that `configure' is in and in `..'.
 123
 124    If you have to use a `make' that does not support the `VPATH'
 125 variable, you have to compile the package for one architecture at a
 126 time in the source code directory.  After you have installed the
 127 package for one architecture, use `make distclean' before reconfiguring
 128 for another architecture.
 129
 130 Installation Names
 131 ==================
 132
 133    By default, `make install' will install the package's files in
 134 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 135 installation prefix other than `/usr/local' by giving `configure' the
 136 option `--prefix=PATH'.
 137
 138    You can specify separate installation prefixes for
 139 architecture-specific files and architecture-independent files.  If you
 140 give `configure' the option `--exec-prefix=PATH', the package will use
 141 PATH as the prefix for installing programs and libraries.
 142 Documentation and other data files will still use the regular prefix.
 143
 144    In addition, if you use an unusual directory layout you can give
 145 options like `--bindir=PATH' to specify different values for particular
 146 kinds of files.  Run `configure --help' for a list of the directories
 147 you can set and what kinds of files go in them.
 148
 149    If the package supports it, you can cause programs to be installed
 150 with an extra prefix or suffix on their names by giving `configure' the
 151 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 152
 153 Optional Features
 154 =================
 155
 156    Some packages pay attention to `--enable-FEATURE' options to
 157 `configure', where FEATURE indicates an optional part of the package.
 158 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 159 is something like `gnu-as' or `x' (for the X Window System).  The
 160 `README' should mention any `--enable-' and `--with-' options that the
 161 package recognizes.
 162
 163    For packages that use the X Window System, `configure' can usually
 164 find the X include and library files automatically, but if it doesn't,
 165 you can use the `configure' options `--x-includes=DIR' and
 166 `--x-libraries=DIR' to specify their locations.
 167
 168 Specifying the System Type
 169 ==========================
 170
 171    There may be some features `configure' cannot figure out
 172 automatically, but needs to determine by the type of machine the package
 173 will run on.  Usually, assuming the package is built to be run on the
 174 _same_ architectures, `configure' can figure that out, but if it prints
 175 a message saying it cannot guess the machine type, give it the
 176 `--build=TYPE' option.  TYPE can either be a short name for the system
 177 type, such as `sun4', or a canonical name which has the form:
 178
 179      CPU-COMPANY-SYSTEM
 180
 181 where SYSTEM can have one of these forms:
 182
 183      OS KERNEL-OS
 184
 185    See the file `config.sub' for the possible values of each field.  If
 186 `config.sub' isn't included in this package, then this package doesn't
 187 need to know the machine type.
 188
 189    If you are _building_ compiler tools for cross-compiling, you should
 190 use the `--target=TYPE' option to select the type of system they will
 191 produce code for.
 192
 193    If you want to _use_ a cross compiler, that generates code for a
 194 platform different from the build platform, you should specify the
 195 "host" platform (i.e., that on which the generated programs will
 196 eventually be run) with `--host=TYPE'.
 197
 198 Sharing Defaults
 199 ================
 200
 201    If you want to set default values for `configure' scripts to share,
 202 you can create a site shell script called `config.site' that gives
 203 default values for variables like `CC', `cache_file', and `prefix'.
 204 `configure' looks for `PREFIX/share/config.site' if it exists, then
 205 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 206 `CONFIG_SITE' environment variable to the location of the site script.
 207 A warning: not all `configure' scripts look for a site script.
 208
 209 Defining Variables
 210 ==================
 211
 212    Variables not defined in a site shell script can be set in the
 213 environment passed to `configure'.  However, some packages may run
 214 configure again during the build, and the customized values of these
 215 variables may be lost.  In order to avoid this problem, you should set
 216 them in the `configure' command line, using `VAR=value'.  For example:
 217
 218      ./configure CC=/usr/local2/bin/gcc
 219
 220 will cause the specified gcc to be used as the C compiler (unless it is
 221 overridden in the site shell script).
 222
 223 `configure' Invocation
 224 ======================
 225
 226    `configure' recognizes the following options to control how it
 227 operates.
 228
 229 `--help'
 230 `-h'
 231      Print a summary of the options to `configure', and exit.
 232
 233 `--version'
 234 `-V'
 235      Print the version of Autoconf used to generate the `configure'
 236      script, and exit.
 237
 238 `--cache-file=FILE'
 239      Enable the cache: use and save the results of the tests in FILE,
 240      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 241      disable caching.
 242
 243 `--config-cache'
 244 `-C'
 245      Alias for `--cache-file=config.cache'.
 246
 247 `--quiet'
 248 `--silent'
 249 `-q'
 250      Do not print messages saying which checks are being made.  To
 251      suppress all normal output, redirect it to `/dev/null' (any error
 252      messages will still be shown).
 253
 254 `--srcdir=DIR'
 255      Look for the package's source code in directory DIR.  Usually
 256      `configure' can determine that directory automatically.
 257
 258 `configure' also accepts some other, not widely useful, options.  Run
 259 `configure --help' for more details.
 260