Blame INSTALL

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