Blame INSTALL

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