Blame INSTALL

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