Blame INSTALL

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