Blame INSTALL

Packit 1422b7
Installation Instructions
Packit 1422b7
*************************
Packit 1422b7
Packit 1422b7
Copyright (C) 1994-1996, 1999-2002, 2004-2013 Free Software Foundation,
Packit 1422b7
Inc.
Packit 1422b7
Packit 1422b7
   Copying and distribution of this file, with or without modification,
Packit 1422b7
are permitted in any medium without royalty provided the copyright
Packit 1422b7
notice and this notice are preserved.  This file is offered as-is,
Packit 1422b7
without warranty of any kind.
Packit 1422b7
Packit 1422b7
Basic Installation
Packit 1422b7
==================
Packit 1422b7
Packit 1422b7
   Briefly, the shell command `./configure && make && make install'
Packit 1422b7
should configure, build, and install this package.  The following
Packit 1422b7
more-detailed instructions are generic; see the `README' file for
Packit 1422b7
instructions specific to this package.  Some packages provide this
Packit 1422b7
`INSTALL' file but do not implement all of the features documented
Packit 1422b7
below.  The lack of an optional feature in a given package is not
Packit 1422b7
necessarily a bug.  More recommendations for GNU packages can be found
Packit 1422b7
in *note Makefile Conventions: (standards)Makefile Conventions.
Packit 1422b7
Packit 1422b7
   The `configure' shell script attempts to guess correct values for
Packit 1422b7
various system-dependent variables used during compilation.  It uses
Packit 1422b7
those values to create a `Makefile' in each directory of the package.
Packit 1422b7
It may also create one or more `.h' files containing system-dependent
Packit 1422b7
definitions.  Finally, it creates a shell script `config.status' that
Packit 1422b7
you can run in the future to recreate the current configuration, and a
Packit 1422b7
file `config.log' containing compiler output (useful mainly for
Packit 1422b7
debugging `configure').
Packit 1422b7
Packit 1422b7
   It can also use an optional file (typically called `config.cache'
Packit 1422b7
and enabled with `--cache-file=config.cache' or simply `-C') that saves
Packit 1422b7
the results of its tests to speed up reconfiguring.  Caching is
Packit 1422b7
disabled by default to prevent problems with accidental use of stale
Packit 1422b7
cache files.
Packit 1422b7
Packit 1422b7
   If you need to do unusual things to compile the package, please try
Packit 1422b7
to figure out how `configure' could check whether to do them, and mail
Packit 1422b7
diffs or instructions to the address given in the `README' so they can
Packit 1422b7
be considered for the next release.  If you are using the cache, and at
Packit 1422b7
some point `config.cache' contains results you don't want to keep, you
Packit 1422b7
may remove or edit it.
Packit 1422b7
Packit 1422b7
   The file `configure.ac' (or `configure.in') is used to create
Packit 1422b7
`configure' by a program called `autoconf'.  You need `configure.ac' if
Packit 1422b7
you want to change it or regenerate `configure' using a newer version
Packit 1422b7
of `autoconf'.
Packit 1422b7
Packit 1422b7
   The simplest way to compile this package is:
Packit 1422b7
Packit 1422b7
  1. `cd' to the directory containing the package's source code and type
Packit 1422b7
     `./configure' to configure the package for your system.
Packit 1422b7
Packit 1422b7
     Running `configure' might take a while.  While running, it prints
Packit 1422b7
     some messages telling which features it is checking for.
Packit 1422b7
Packit 1422b7
  2. Type `make' to compile the package.
Packit 1422b7
Packit 1422b7
  3. Optionally, type `make check' to run any self-tests that come with
Packit 1422b7
     the package, generally using the just-built uninstalled binaries.
Packit 1422b7
Packit 1422b7
  4. Type `make install' to install the programs and any data files and
Packit 1422b7
     documentation.  When installing into a prefix owned by root, it is
Packit 1422b7
     recommended that the package be configured and built as a regular
Packit 1422b7
     user, and only the `make install' phase executed with root
Packit 1422b7
     privileges.
Packit 1422b7
Packit 1422b7
  5. Optionally, type `make installcheck' to repeat any self-tests, but
Packit 1422b7
     this time using the binaries in their final installed location.
Packit 1422b7
     This target does not install anything.  Running this target as a
Packit 1422b7
     regular user, particularly if the prior `make install' required
Packit 1422b7
     root privileges, verifies that the installation completed
Packit 1422b7
     correctly.
Packit 1422b7
Packit 1422b7
  6. You can remove the program binaries and object files from the
Packit 1422b7
     source code directory by typing `make clean'.  To also remove the
Packit 1422b7
     files that `configure' created (so you can compile the package for
Packit 1422b7
     a different kind of computer), type `make distclean'.  There is
Packit 1422b7
     also a `make maintainer-clean' target, but that is intended mainly
Packit 1422b7
     for the package's developers.  If you use it, you may have to get
Packit 1422b7
     all sorts of other programs in order to regenerate files that came
Packit 1422b7
     with the distribution.
Packit 1422b7
Packit 1422b7
  7. Often, you can also type `make uninstall' to remove the installed
Packit 1422b7
     files again.  In practice, not all packages have tested that
Packit 1422b7
     uninstallation works correctly, even though it is required by the
Packit 1422b7
     GNU Coding Standards.
Packit 1422b7
Packit 1422b7
  8. Some packages, particularly those that use Automake, provide `make
Packit 1422b7
     distcheck', which can by used by developers to test that all other
Packit 1422b7
     targets like `make install' and `make uninstall' work correctly.
Packit 1422b7
     This target is generally not run by end users.
Packit 1422b7
Packit 1422b7
Compilers and Options
Packit 1422b7
=====================
Packit 1422b7
Packit 1422b7
   Some systems require unusual options for compilation or linking that
Packit 1422b7
the `configure' script does not know about.  Run `./configure --help'
Packit 1422b7
for details on some of the pertinent environment variables.
Packit 1422b7
Packit 1422b7
   You can give `configure' initial values for configuration parameters
Packit 1422b7
by setting variables in the command line or in the environment.  Here
Packit 1422b7
is an example:
Packit 1422b7
Packit 1422b7
     ./configure CC=c99 CFLAGS=-g LIBS=-lposix
Packit 1422b7
Packit 1422b7
   *Note Defining Variables::, for more details.
Packit 1422b7
Packit 1422b7
Compiling For Multiple Architectures
Packit 1422b7
====================================
Packit 1422b7
Packit 1422b7
   You can compile the package for more than one kind of computer at the
Packit 1422b7
same time, by placing the object files for each architecture in their
Packit 1422b7
own directory.  To do this, you can use GNU `make'.  `cd' to the
Packit 1422b7
directory where you want the object files and executables to go and run
Packit 1422b7
the `configure' script.  `configure' automatically checks for the
Packit 1422b7
source code in the directory that `configure' is in and in `..'.  This
Packit 1422b7
is known as a "VPATH" build.
Packit 1422b7
Packit 1422b7
   With a non-GNU `make', it is safer to compile the package for one
Packit 1422b7
architecture at a time in the source code directory.  After you have
Packit 1422b7
installed the package for one architecture, use `make distclean' before
Packit 1422b7
reconfiguring for another architecture.
Packit 1422b7
Packit 1422b7
   On MacOS X 10.5 and later systems, you can create libraries and
Packit 1422b7
executables that work on multiple system types--known as "fat" or
Packit 1422b7
"universal" binaries--by specifying multiple `-arch' options to the
Packit 1422b7
compiler but only a single `-arch' option to the preprocessor.  Like
Packit 1422b7
this:
Packit 1422b7
Packit 1422b7
     ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
Packit 1422b7
                 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
Packit 1422b7
                 CPP="gcc -E" CXXCPP="g++ -E"
Packit 1422b7
Packit 1422b7
   This is not guaranteed to produce working output in all cases, you
Packit 1422b7
may have to build one architecture at a time and combine the results
Packit 1422b7
using the `lipo' tool if you have problems.
Packit 1422b7
Packit 1422b7
Installation Names
Packit 1422b7
==================
Packit 1422b7
Packit 1422b7
   By default, `make install' installs the package's commands under
Packit 1422b7
`/usr/local/bin', include files under `/usr/local/include', etc.  You
Packit 1422b7
can specify an installation prefix other than `/usr/local' by giving
Packit 1422b7
`configure' the option `--prefix=PREFIX', where PREFIX must be an
Packit 1422b7
absolute file name.
Packit 1422b7
Packit 1422b7
   You can specify separate installation prefixes for
Packit 1422b7
architecture-specific files and architecture-independent files.  If you
Packit 1422b7
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
Packit 1422b7
PREFIX as the prefix for installing programs and libraries.
Packit 1422b7
Documentation and other data files still use the regular prefix.
Packit 1422b7
Packit 1422b7
   In addition, if you use an unusual directory layout you can give
Packit 1422b7
options like `--bindir=DIR' to specify different values for particular
Packit 1422b7
kinds of files.  Run `configure --help' for a list of the directories
Packit 1422b7
you can set and what kinds of files go in them.  In general, the
Packit 1422b7
default for these options is expressed in terms of `${prefix}', so that
Packit 1422b7
specifying just `--prefix' will affect all of the other directory
Packit 1422b7
specifications that were not explicitly provided.
Packit 1422b7
Packit 1422b7
   The most portable way to affect installation locations is to pass the
Packit 1422b7
correct locations to `configure'; however, many packages provide one or
Packit 1422b7
both of the following shortcuts of passing variable assignments to the
Packit 1422b7
`make install' command line to change installation locations without
Packit 1422b7
having to reconfigure or recompile.
Packit 1422b7
Packit 1422b7
   The first method involves providing an override variable for each
Packit 1422b7
affected directory.  For example, `make install
Packit 1422b7
prefix=/alternate/directory' will choose an alternate location for all
Packit 1422b7
directory configuration variables that were expressed in terms of
Packit 1422b7
`${prefix}'.  Any directories that were specified during `configure',
Packit 1422b7
but not in terms of `${prefix}', must each be overridden at install
Packit 1422b7
time for the entire installation to be relocated.  The approach of
Packit 1422b7
makefile variable overrides for each directory variable is required by
Packit 1422b7
the GNU Coding Standards, and ideally causes no recompilation.
Packit 1422b7
However, some platforms have known limitations with the semantics of
Packit 1422b7
shared libraries that end up requiring recompilation when using this
Packit 1422b7
method, particularly noticeable in packages that use GNU Libtool.
Packit 1422b7
Packit 1422b7
   The second method involves providing the `DESTDIR' variable.  For
Packit 1422b7
example, `make install DESTDIR=/alternate/directory' will prepend
Packit 1422b7
`/alternate/directory' before all installation names.  The approach of
Packit 1422b7
`DESTDIR' overrides is not required by the GNU Coding Standards, and
Packit 1422b7
does not work on platforms that have drive letters.  On the other hand,
Packit 1422b7
it does better at avoiding recompilation issues, and works well even
Packit 1422b7
when some directory options were not specified in terms of `${prefix}'
Packit 1422b7
at `configure' time.
Packit 1422b7
Packit 1422b7
Optional Features
Packit 1422b7
=================
Packit 1422b7
Packit 1422b7
   If the package supports it, you can cause programs to be installed
Packit 1422b7
with an extra prefix or suffix on their names by giving `configure' the
Packit 1422b7
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Packit 1422b7
Packit 1422b7
   Some packages pay attention to `--enable-FEATURE' options to
Packit 1422b7
`configure', where FEATURE indicates an optional part of the package.
Packit 1422b7
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
Packit 1422b7
is something like `gnu-as' or `x' (for the X Window System).  The
Packit 1422b7
`README' should mention any `--enable-' and `--with-' options that the
Packit 1422b7
package recognizes.
Packit 1422b7
Packit 1422b7
   For packages that use the X Window System, `configure' can usually
Packit 1422b7
find the X include and library files automatically, but if it doesn't,
Packit 1422b7
you can use the `configure' options `--x-includes=DIR' and
Packit 1422b7
`--x-libraries=DIR' to specify their locations.
Packit 1422b7
Packit 1422b7
   Some packages offer the ability to configure how verbose the
Packit 1422b7
execution of `make' will be.  For these packages, running `./configure
Packit 1422b7
--enable-silent-rules' sets the default to minimal output, which can be
Packit 1422b7
overridden with `make V=1'; while running `./configure
Packit 1422b7
--disable-silent-rules' sets the default to verbose, which can be
Packit 1422b7
overridden with `make V=0'.
Packit 1422b7
Packit 1422b7
Particular systems
Packit 1422b7
==================
Packit 1422b7
Packit 1422b7
   On HP-UX, the default C compiler is not ANSI C compatible.  If GNU
Packit 1422b7
CC is not installed, it is recommended to use the following options in
Packit 1422b7
order to use an ANSI C compiler:
Packit 1422b7
Packit 1422b7
     ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
Packit 1422b7
Packit 1422b7
and if that doesn't work, install pre-built binaries of GCC for HP-UX.
Packit 1422b7
Packit 1422b7
   HP-UX `make' updates targets which have the same time stamps as
Packit 1422b7
their prerequisites, which makes it generally unusable when shipped
Packit 1422b7
generated files such as `configure' are involved.  Use GNU `make'
Packit 1422b7
instead.
Packit 1422b7
Packit 1422b7
   On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
Packit 1422b7
parse its `<wchar.h>' header file.  The option `-nodtk' can be used as
Packit 1422b7
a workaround.  If GNU CC is not installed, it is therefore recommended
Packit 1422b7
to try
Packit 1422b7
Packit 1422b7
     ./configure CC="cc"
Packit 1422b7
Packit 1422b7
and if that doesn't work, try
Packit 1422b7
Packit 1422b7
     ./configure CC="cc -nodtk"
Packit 1422b7
Packit 1422b7
   On Solaris, don't put `/usr/ucb' early in your `PATH'.  This
Packit 1422b7
directory contains several dysfunctional programs; working variants of
Packit 1422b7
these programs are available in `/usr/bin'.  So, if you need `/usr/ucb'
Packit 1422b7
in your `PATH', put it _after_ `/usr/bin'.
Packit 1422b7
Packit 1422b7
   On Haiku, software installed for all users goes in `/boot/common',
Packit 1422b7
not `/usr/local'.  It is recommended to use the following options:
Packit 1422b7
Packit 1422b7
     ./configure --prefix=/boot/common
Packit 1422b7
Packit 1422b7
Specifying the System Type
Packit 1422b7
==========================
Packit 1422b7
Packit 1422b7
   There may be some features `configure' cannot figure out
Packit 1422b7
automatically, but needs to determine by the type of machine the package
Packit 1422b7
will run on.  Usually, assuming the package is built to be run on the
Packit 1422b7
_same_ architectures, `configure' can figure that out, but if it prints
Packit 1422b7
a message saying it cannot guess the machine type, give it the
Packit 1422b7
`--build=TYPE' option.  TYPE can either be a short name for the system
Packit 1422b7
type, such as `sun4', or a canonical name which has the form:
Packit 1422b7
Packit 1422b7
     CPU-COMPANY-SYSTEM
Packit 1422b7
Packit 1422b7
where SYSTEM can have one of these forms:
Packit 1422b7
Packit 1422b7
     OS
Packit 1422b7
     KERNEL-OS
Packit 1422b7
Packit 1422b7
   See the file `config.sub' for the possible values of each field.  If
Packit 1422b7
`config.sub' isn't included in this package, then this package doesn't
Packit 1422b7
need to know the machine type.
Packit 1422b7
Packit 1422b7
   If you are _building_ compiler tools for cross-compiling, you should
Packit 1422b7
use the option `--target=TYPE' to select the type of system they will
Packit 1422b7
produce code for.
Packit 1422b7
Packit 1422b7
   If you want to _use_ a cross compiler, that generates code for a
Packit 1422b7
platform different from the build platform, you should specify the
Packit 1422b7
"host" platform (i.e., that on which the generated programs will
Packit 1422b7
eventually be run) with `--host=TYPE'.
Packit 1422b7
Packit 1422b7
Sharing Defaults
Packit 1422b7
================
Packit 1422b7
Packit 1422b7
   If you want to set default values for `configure' scripts to share,
Packit 1422b7
you can create a site shell script called `config.site' that gives
Packit 1422b7
default values for variables like `CC', `cache_file', and `prefix'.
Packit 1422b7
`configure' looks for `PREFIX/share/config.site' if it exists, then
Packit 1422b7
`PREFIX/etc/config.site' if it exists.  Or, you can set the
Packit 1422b7
`CONFIG_SITE' environment variable to the location of the site script.
Packit 1422b7
A warning: not all `configure' scripts look for a site script.
Packit 1422b7
Packit 1422b7
Defining Variables
Packit 1422b7
==================
Packit 1422b7
Packit 1422b7
   Variables not defined in a site shell script can be set in the
Packit 1422b7
environment passed to `configure'.  However, some packages may run
Packit 1422b7
configure again during the build, and the customized values of these
Packit 1422b7
variables may be lost.  In order to avoid this problem, you should set
Packit 1422b7
them in the `configure' command line, using `VAR=value'.  For example:
Packit 1422b7
Packit 1422b7
     ./configure CC=/usr/local2/bin/gcc
Packit 1422b7
Packit 1422b7
causes the specified `gcc' to be used as the C compiler (unless it is
Packit 1422b7
overridden in the site shell script).
Packit 1422b7
Packit 1422b7
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
Packit 1422b7
an Autoconf limitation.  Until the limitation is lifted, you can use
Packit 1422b7
this workaround:
Packit 1422b7
Packit 1422b7
     CONFIG_SHELL=/bin/bash ./configure CONFIG_SHELL=/bin/bash
Packit 1422b7
Packit 1422b7
`configure' Invocation
Packit 1422b7
======================
Packit 1422b7
Packit 1422b7
   `configure' recognizes the following options to control how it
Packit 1422b7
operates.
Packit 1422b7
Packit 1422b7
`--help'
Packit 1422b7
`-h'
Packit 1422b7
     Print a summary of all of the options to `configure', and exit.
Packit 1422b7
Packit 1422b7
`--help=short'
Packit 1422b7
`--help=recursive'
Packit 1422b7
     Print a summary of the options unique to this package's
Packit 1422b7
     `configure', and exit.  The `short' variant lists options used
Packit 1422b7
     only in the top level, while the `recursive' variant lists options
Packit 1422b7
     also present in any nested packages.
Packit 1422b7
Packit 1422b7
`--version'
Packit 1422b7
`-V'
Packit 1422b7
     Print the version of Autoconf used to generate the `configure'
Packit 1422b7
     script, and exit.
Packit 1422b7
Packit 1422b7
`--cache-file=FILE'
Packit 1422b7
     Enable the cache: use and save the results of the tests in FILE,
Packit 1422b7
     traditionally `config.cache'.  FILE defaults to `/dev/null' to
Packit 1422b7
     disable caching.
Packit 1422b7
Packit 1422b7
`--config-cache'
Packit 1422b7
`-C'
Packit 1422b7
     Alias for `--cache-file=config.cache'.
Packit 1422b7
Packit 1422b7
`--quiet'
Packit 1422b7
`--silent'
Packit 1422b7
`-q'
Packit 1422b7
     Do not print messages saying which checks are being made.  To
Packit 1422b7
     suppress all normal output, redirect it to `/dev/null' (any error
Packit 1422b7
     messages will still be shown).
Packit 1422b7
Packit 1422b7
`--srcdir=DIR'
Packit 1422b7
     Look for the package's source code in directory DIR.  Usually
Packit 1422b7
     `configure' can determine that directory automatically.
Packit 1422b7
Packit 1422b7
`--prefix=DIR'
Packit 1422b7
     Use DIR as the installation prefix.  *note Installation Names::
Packit 1422b7
     for more details, including other options available for fine-tuning
Packit 1422b7
     the installation locations.
Packit 1422b7
Packit 1422b7
`--no-create'
Packit 1422b7
`-n'
Packit 1422b7
     Run the configure checks, but stop before creating any output
Packit 1422b7
     files.
Packit 1422b7
Packit 1422b7
`configure' also accepts some other, not widely useful, options.  Run
Packit 1422b7
`configure --help' for more details.