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