Blame CONFIGURE

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