Blame INSTALL

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