Blame INSTALL

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