Blame INSTALL

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