Blame INSTALL

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