Blame INSTALL

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