Blame INSTALL

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