Blame INSTALL

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