Blame INSTALL

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