Blame INSTALL

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