Blame INSTALL

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