Blame INSTALL

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