Blame INSTALL

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