Blame INSTALL

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