Blame INSTALL

Packit Service 5195f2
Introduction
Packit Service 5195f2
============
Packit Service 5195f2
Packit Service 5195f2
  This installation guide is for POSIX (Autoconf) systems.
Packit Service 5195f2
  For Win32, Win64, DOS and OS/2 please read the file B/00README.TXT.
Packit Service 5195f2
Packit Service 5195f2
  Quick start
Packit Service 5195f2
  -----------
Packit Service 5195f2
    ./configure
Packit Service 5195f2
    make
Packit Service 5195f2
    make check
Packit Service 5195f2
    make test     (run a full test)
Packit Service 5195f2
    make install  (when logged in as root)
Packit Service 5195f2
Packit Service 5195f2
  Exotic machines
Packit Service 5195f2
  ---------------
Packit Service 5195f2
  Instead of using Autoconf you may want to adapt the simple build
Packit Service 5195f2
  script in B/generic/build.sh.
Packit Service 5195f2
Packit Service 5195f2
  Shared libraries
Packit Service 5195f2
  ----------------
Packit Service 5195f2
  LZO uses Libtool so that shared libraries are supported on many
Packit Service 5195f2
  systems. If want to build shared libraries type you have to type
Packit Service 5195f2
  `./configure --enable-shared' - building shared libraries is not
Packit Service 5195f2
  enabled by default.
Packit Service 5195f2
Packit Service 5195f2
  Assembler versions
Packit Service 5195f2
  ------------------
Packit Service 5195f2
  On Intel i386 systems, the assembler versions of the decompressors are
Packit Service 5195f2
  built and used by default. You can use `./configure --disable-asm' if
Packit Service 5195f2
  for some reason they cause compilation problems on your system.
Packit Service 5195f2
Packit Service 5195f2
Packit Service 5195f2
Packit Service 5195f2
[ The standard Autoconf installation instructions follow below. ]
Packit Service 5195f2
Packit Service 5195f2
Packit Service 5195f2
Packit Service 5195f2
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
Packit Service 5195f2
Foundation, Inc.
Packit Service 5195f2
Packit Service 5195f2
   This file is free documentation; the Free Software Foundation gives
Packit Service 5195f2
unlimited permission to copy, distribute and modify it.
Packit Service 5195f2
Packit Service 5195f2
Basic Installation
Packit Service 5195f2
==================
Packit Service 5195f2
Packit Service 5195f2
   These are generic installation instructions.
Packit Service 5195f2
Packit Service 5195f2
   The `configure' shell script attempts to guess correct values for
Packit Service 5195f2
various system-dependent variables used during compilation.  It uses
Packit Service 5195f2
those values to create a `Makefile' in each directory of the package.
Packit Service 5195f2
It may also create one or more `.h' files containing system-dependent
Packit Service 5195f2
definitions.  Finally, it creates a shell script `config.status' that
Packit Service 5195f2
you can run in the future to recreate the current configuration, and a
Packit Service 5195f2
file `config.log' containing compiler output (useful mainly for
Packit Service 5195f2
debugging `configure').
Packit Service 5195f2
Packit Service 5195f2
   It can also use an optional file (typically called `config.cache'
Packit Service 5195f2
and enabled with `--cache-file=config.cache' or simply `-C') that saves
Packit Service 5195f2
the results of its tests to speed up reconfiguring.  (Caching is
Packit Service 5195f2
disabled by default to prevent problems with accidental use of stale
Packit Service 5195f2
cache files.)
Packit Service 5195f2
Packit Service 5195f2
   If you need to do unusual things to compile the package, please try
Packit Service 5195f2
to figure out how `configure' could check whether to do them, and mail
Packit Service 5195f2
diffs or instructions to the address given in the `README' so they can
Packit Service 5195f2
be considered for the next release.  If you are using the cache, and at
Packit Service 5195f2
some point `config.cache' contains results you don't want to keep, you
Packit Service 5195f2
may remove or edit it.
Packit Service 5195f2
Packit Service 5195f2
   The file `configure.ac' (or `configure.in') is used to create
Packit Service 5195f2
`configure' by a program called `autoconf'.  You only need
Packit Service 5195f2
`configure.ac' if you want to change it or regenerate `configure' using
Packit Service 5195f2
a newer version of `autoconf'.
Packit Service 5195f2
Packit Service 5195f2
The simplest way to compile this package is:
Packit Service 5195f2
Packit Service 5195f2
  1. `cd' to the directory containing the package's source code and type
Packit Service 5195f2
     `./configure' to configure the package for your system.  If you're
Packit Service 5195f2
     using `csh' on an old version of System V, you might need to type
Packit Service 5195f2
     `sh ./configure' instead to prevent `csh' from trying to execute
Packit Service 5195f2
     `configure' itself.
Packit Service 5195f2
Packit Service 5195f2
     Running `configure' takes awhile.  While running, it prints some
Packit Service 5195f2
     messages telling which features it is checking for.
Packit Service 5195f2
Packit Service 5195f2
  2. Type `make' to compile the package.
Packit Service 5195f2
Packit Service 5195f2
  3. Optionally, type `make check' to run any self-tests that come with
Packit Service 5195f2
     the package.
Packit Service 5195f2
Packit Service 5195f2
  4. Type `make install' to install the programs and any data files and
Packit Service 5195f2
     documentation.
Packit Service 5195f2
Packit Service 5195f2
  5. You can remove the program binaries and object files from the
Packit Service 5195f2
     source code directory by typing `make clean'.  To also remove the
Packit Service 5195f2
     files that `configure' created (so you can compile the package for
Packit Service 5195f2
     a different kind of computer), type `make distclean'.  There is
Packit Service 5195f2
     also a `make maintainer-clean' target, but that is intended mainly
Packit Service 5195f2
     for the package's developers.  If you use it, you may have to get
Packit Service 5195f2
     all sorts of other programs in order to regenerate files that came
Packit Service 5195f2
     with the distribution.
Packit Service 5195f2
Packit Service 5195f2
Compilers and Options
Packit Service 5195f2
=====================
Packit Service 5195f2
Packit Service 5195f2
   Some systems require unusual options for compilation or linking that
Packit Service 5195f2
the `configure' script does not know about.  Run `./configure --help'
Packit Service 5195f2
for details on some of the pertinent environment variables.
Packit Service 5195f2
Packit Service 5195f2
   You can give `configure' initial values for configuration parameters
Packit Service 5195f2
by setting variables in the command line or in the environment.  Here
Packit Service 5195f2
is an example:
Packit Service 5195f2
Packit Service 5195f2
     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
Packit Service 5195f2
Packit Service 5195f2
Compiling For Multiple Architectures
Packit Service 5195f2
====================================
Packit Service 5195f2
Packit Service 5195f2
   You can compile the package for more than one kind of computer at the
Packit Service 5195f2
same time, by placing the object files for each architecture in their
Packit Service 5195f2
own directory.  To do this, you must use a version of `make' that
Packit Service 5195f2
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
Packit Service 5195f2
directory where you want the object files and executables to go and run
Packit Service 5195f2
the `configure' script.  `configure' automatically checks for the
Packit Service 5195f2
source code in the directory that `configure' is in and in `..'.
Packit Service 5195f2
Packit Service 5195f2
   If you have to use a `make' that does not support the `VPATH'
Packit Service 5195f2
variable, you have to compile the package for one architecture at a
Packit Service 5195f2
time in the source code directory.  After you have installed the
Packit Service 5195f2
package for one architecture, use `make distclean' before reconfiguring
Packit Service 5195f2
for another architecture.
Packit Service 5195f2
Packit Service 5195f2
Installation Names
Packit Service 5195f2
==================
Packit Service 5195f2
Packit Service 5195f2
   By default, `make install' will install the package's files in
Packit Service 5195f2
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
Packit Service 5195f2
installation prefix other than `/usr/local' by giving `configure' the
Packit Service 5195f2
option `--prefix=PATH'.
Packit Service 5195f2
Packit Service 5195f2
   You can specify separate installation prefixes for
Packit Service 5195f2
architecture-specific files and architecture-independent files.  If you
Packit Service 5195f2
give `configure' the option `--exec-prefix=PATH', the package will use
Packit Service 5195f2
PATH as the prefix for installing programs and libraries.
Packit Service 5195f2
Documentation and other data files will still use the regular prefix.
Packit Service 5195f2
Packit Service 5195f2
   In addition, if you use an unusual directory layout you can give
Packit Service 5195f2
options like `--bindir=PATH' to specify different values for particular
Packit Service 5195f2
kinds of files.  Run `configure --help' for a list of the directories
Packit Service 5195f2
you can set and what kinds of files go in them.
Packit Service 5195f2
Packit Service 5195f2
   If the package supports it, you can cause programs to be installed
Packit Service 5195f2
with an extra prefix or suffix on their names by giving `configure' the
Packit Service 5195f2
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Packit Service 5195f2
Packit Service 5195f2
Optional Features
Packit Service 5195f2
=================
Packit Service 5195f2
Packit Service 5195f2
   Some packages pay attention to `--enable-FEATURE' options to
Packit Service 5195f2
`configure', where FEATURE indicates an optional part of the package.
Packit Service 5195f2
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
Packit Service 5195f2
is something like `gnu-as' or `x' (for the X Window System).  The
Packit Service 5195f2
`README' should mention any `--enable-' and `--with-' options that the
Packit Service 5195f2
package recognizes.
Packit Service 5195f2
Packit Service 5195f2
   For packages that use the X Window System, `configure' can usually
Packit Service 5195f2
find the X include and library files automatically, but if it doesn't,
Packit Service 5195f2
you can use the `configure' options `--x-includes=DIR' and
Packit Service 5195f2
`--x-libraries=DIR' to specify their locations.
Packit Service 5195f2
Packit Service 5195f2
Specifying the System Type
Packit Service 5195f2
==========================
Packit Service 5195f2
Packit Service 5195f2
   There may be some features `configure' cannot figure out
Packit Service 5195f2
automatically, but needs to determine by the type of machine the package
Packit Service 5195f2
will run on.  Usually, assuming the package is built to be run on the
Packit Service 5195f2
_same_ architectures, `configure' can figure that out, but if it prints
Packit Service 5195f2
a message saying it cannot guess the machine type, give it the
Packit Service 5195f2
`--build=TYPE' option.  TYPE can either be a short name for the system
Packit Service 5195f2
type, such as `sun4', or a canonical name which has the form:
Packit Service 5195f2
Packit Service 5195f2
     CPU-COMPANY-SYSTEM
Packit Service 5195f2
Packit Service 5195f2
where SYSTEM can have one of these forms:
Packit Service 5195f2
Packit Service 5195f2
     OS KERNEL-OS
Packit Service 5195f2
Packit Service 5195f2
   See the file `config.sub' for the possible values of each field.  If
Packit Service 5195f2
`config.sub' isn't included in this package, then this package doesn't
Packit Service 5195f2
need to know the machine type.
Packit Service 5195f2
Packit Service 5195f2
   If you are _building_ compiler tools for cross-compiling, you should
Packit Service 5195f2
use the `--target=TYPE' option to select the type of system they will
Packit Service 5195f2
produce code for.
Packit Service 5195f2
Packit Service 5195f2
   If you want to _use_ a cross compiler, that generates code for a
Packit Service 5195f2
platform different from the build platform, you should specify the
Packit Service 5195f2
"host" platform (i.e., that on which the generated programs will
Packit Service 5195f2
eventually be run) with `--host=TYPE'.
Packit Service 5195f2
Packit Service 5195f2
Sharing Defaults
Packit Service 5195f2
================
Packit Service 5195f2
Packit Service 5195f2
   If you want to set default values for `configure' scripts to share,
Packit Service 5195f2
you can create a site shell script called `config.site' that gives
Packit Service 5195f2
default values for variables like `CC', `cache_file', and `prefix'.
Packit Service 5195f2
`configure' looks for `PREFIX/share/config.site' if it exists, then
Packit Service 5195f2
`PREFIX/etc/config.site' if it exists.  Or, you can set the
Packit Service 5195f2
`CONFIG_SITE' environment variable to the location of the site script.
Packit Service 5195f2
A warning: not all `configure' scripts look for a site script.
Packit Service 5195f2
Packit Service 5195f2
Defining Variables
Packit Service 5195f2
==================
Packit Service 5195f2
Packit Service 5195f2
   Variables not defined in a site shell script can be set in the
Packit Service 5195f2
environment passed to `configure'.  However, some packages may run
Packit Service 5195f2
configure again during the build, and the customized values of these
Packit Service 5195f2
variables may be lost.  In order to avoid this problem, you should set
Packit Service 5195f2
them in the `configure' command line, using `VAR=value'.  For example:
Packit Service 5195f2
Packit Service 5195f2
     ./configure CC=/usr/local2/bin/gcc
Packit Service 5195f2
Packit Service 5195f2
will cause the specified gcc to be used as the C compiler (unless it is
Packit Service 5195f2
overridden in the site shell script).
Packit Service 5195f2
Packit Service 5195f2
`configure' Invocation
Packit Service 5195f2
======================
Packit Service 5195f2
Packit Service 5195f2
   `configure' recognizes the following options to control how it
Packit Service 5195f2
operates.
Packit Service 5195f2
Packit Service 5195f2
`--help'
Packit Service 5195f2
`-h'
Packit Service 5195f2
     Print a summary of the options to `configure', and exit.
Packit Service 5195f2
Packit Service 5195f2
`--version'
Packit Service 5195f2
`-V'
Packit Service 5195f2
     Print the version of Autoconf used to generate the `configure'
Packit Service 5195f2
     script, and exit.
Packit Service 5195f2
Packit Service 5195f2
`--cache-file=FILE'
Packit Service 5195f2
     Enable the cache: use and save the results of the tests in FILE,
Packit Service 5195f2
     traditionally `config.cache'.  FILE defaults to `/dev/null' to
Packit Service 5195f2
     disable caching.
Packit Service 5195f2
Packit Service 5195f2
`--config-cache'
Packit Service 5195f2
`-C'
Packit Service 5195f2
     Alias for `--cache-file=config.cache'.
Packit Service 5195f2
Packit Service 5195f2
`--quiet'
Packit Service 5195f2
`--silent'
Packit Service 5195f2
`-q'
Packit Service 5195f2
     Do not print messages saying which checks are being made.  To
Packit Service 5195f2
     suppress all normal output, redirect it to `/dev/null' (any error
Packit Service 5195f2
     messages will still be shown).
Packit Service 5195f2
Packit Service 5195f2
`--srcdir=DIR'
Packit Service 5195f2
     Look for the package's source code in directory DIR.  Usually
Packit Service 5195f2
     `configure' can determine that directory automatically.
Packit Service 5195f2
Packit Service 5195f2
`configure' also accepts some other, not widely useful, options.  Run
Packit Service 5195f2
`configure --help' for more details.
Packit Service 5195f2