Blame INSTALL

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