Blame INSTALL

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