Blame INSTALL

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