Blame INSTALL

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