Blame INSTALL

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