Blame INSTALL

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