Blame INSTALL

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