Blame INSTALL

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