Blame INSTALL

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