Blame INSTALL

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