Blame INSTALL.configure

Packit b099d7
Basic Installation
Packit b099d7
==================
Packit b099d7
Packit b099d7
   These are generic installation instructions.
Packit b099d7
Packit b099d7
   The `configure' shell script attempts to guess correct values for
Packit b099d7
various system-dependent variables used during compilation.  It uses
Packit b099d7
those values to create a `Makefile' in each directory of the package.
Packit b099d7
It may also create one or more `.h' files containing system-dependent
Packit b099d7
definitions.  Finally, it creates a shell script `config.status' that
Packit b099d7
you can run in the future to recreate the current configuration, a file
Packit b099d7
`config.cache' that saves the results of its tests to speed up
Packit b099d7
reconfiguring, and a file `config.log' containing compiler output
Packit b099d7
(useful mainly for debugging `configure').
Packit b099d7
Packit b099d7
   If you don't see `configure' shell script in the package directory
Packit b099d7
run `autogen.sh'. It will run in turn libtoolize, aclocal, autoconf,
Packit b099d7
autoheader and automake commands that will produce `configure' shell
Packit b099d7
script. If you don't see `configure' shell script that means one of the 
Packit b099d7
listed above commands failed and you need to update/install autotools 
Packit b099d7
package on your system.
Packit b099d7
Packit b099d7
   If you need to do unusual things to compile the package, please try
Packit b099d7
to figure out how `configure' could check whether to do them, and mail
Packit b099d7
diffs or instructions to the address given in the `README' so they can
Packit b099d7
be considered for the next release.  If at some point `config.cache'
Packit b099d7
contains results you don't want to keep, you may remove or edit it.
Packit b099d7
Packit b099d7
   The file `configure.in' is used to create `configure' by a program
Packit b099d7
called `autoconf'.  You only need `configure.in' if you want to change
Packit b099d7
it or regenerate `configure' using a newer version of `autoconf'.
Packit b099d7
Packit b099d7
The simplest way to compile this package is:
Packit b099d7
Packit b099d7
  1. `cd' to the directory containing the package's source code and type
Packit b099d7
     `./autogen.sh' to create configure shell script according to your
Packit b099d7
     environment and to run automatically 'configure' of the package
Packit b099d7
     for your system. If you're using `csh' on an old version of System
Packit b099d7
     V, you might need to type `sh ./autogen.sh' instead to prevent `csh' 
Packit b099d7
     from trying to execute `autogen.sh' itself.
Packit b099d7
Packit b099d7
     Running `configure' takes awhile.  While running, it prints some
Packit b099d7
     messages telling which features it is checking for.
Packit b099d7
Packit b099d7
  2. Type `make' to compile the package.
Packit b099d7
Packit b099d7
  3. Optionally, type `make check' to run any self-tests that come with
Packit b099d7
     the package.
Packit b099d7
Packit b099d7
  4. Type `make install' to install the programs and any data files and
Packit b099d7
     documentation.
Packit b099d7
Packit b099d7
  5. You can remove the program binaries and object files from the
Packit b099d7
     source code directory by typing `make clean'.  To also remove the
Packit b099d7
     files that `configure' created (so you can compile the package for
Packit b099d7
     a different kind of computer), type `make distclean'.  There is
Packit b099d7
     also a `make maintainer-clean' target, but that is intended mainly
Packit b099d7
     for the package's developers.  If you use it, you may have to get
Packit b099d7
     all sorts of other programs in order to regenerate files that came
Packit b099d7
     with the distribution.
Packit b099d7
Packit b099d7
Compilers and Options
Packit b099d7
=====================
Packit b099d7
Packit b099d7
   Some systems require unusual options for compilation or linking that
Packit b099d7
the `configure' script does not know about.  You can give `configure'
Packit b099d7
initial values for variables by setting them in the environment.  Using
Packit b099d7
a Bourne-compatible shell, you can do that on the command line like
Packit b099d7
this:
Packit b099d7
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
Packit b099d7
Packit b099d7
Or on systems that have the `env' program, you can do it like this:
Packit b099d7
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
Packit b099d7
Packit b099d7
Compiling For Multiple Architectures
Packit b099d7
====================================
Packit b099d7
Packit b099d7
   You can compile the package for more than one kind of computer at the
Packit b099d7
same time, by placing the object files for each architecture in their
Packit b099d7
own directory.  To do this, you must use a version of `make' that
Packit b099d7
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
Packit b099d7
directory where you want the object files and executables to go and run
Packit b099d7
the `configure' script.  `configure' automatically checks for the
Packit b099d7
source code in the directory that `configure' is in and in `..'.
Packit b099d7
Packit b099d7
   If you have to use a `make' that does not supports the `VPATH'
Packit b099d7
variable, you have to compile the package for one architecture at a time
Packit b099d7
in the source code directory.  After you have installed the package for
Packit b099d7
one architecture, use `make distclean' before reconfiguring for another
Packit b099d7
architecture.
Packit b099d7
Packit b099d7
Installation Names
Packit b099d7
==================
Packit b099d7
Packit b099d7
   By default, `make install' will install the package's files in
Packit b099d7
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
Packit b099d7
installation prefix other than `/usr/local' by giving `configure' the
Packit b099d7
option `--prefix=PATH'.
Packit b099d7
Packit b099d7
   You can specify separate installation prefixes for
Packit b099d7
architecture-specific files and architecture-independent files.  If you
Packit b099d7
give `configure' the option `--exec-prefix=PATH', the package will use
Packit b099d7
PATH as the prefix for installing programs and libraries.
Packit b099d7
Documentation and other data files will still use the regular prefix.
Packit b099d7
Packit b099d7
   In addition, if you use an unusual directory layout you can give
Packit b099d7
options like `--bindir=PATH' to specify different values for particular
Packit b099d7
kinds of files.  Run `configure --help' for a list of the directories
Packit b099d7
you can set and what kinds of files go in them.
Packit b099d7
Packit b099d7
   If the package supports it, you can cause programs to be installed
Packit b099d7
with an extra prefix or suffix on their names by giving `configure' the
Packit b099d7
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Packit b099d7
Packit b099d7
Optional Features
Packit b099d7
=================
Packit b099d7
Packit b099d7
   Some packages pay attention to `--enable-FEATURE' options to
Packit b099d7
`configure', where FEATURE indicates an optional part of the package.
Packit b099d7
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
Packit b099d7
is something like `gnu-as' or `x' (for the X Window System).  The
Packit b099d7
`README' should mention any `--enable-' and `--with-' options that the
Packit b099d7
package recognizes.
Packit b099d7
Packit b099d7
   For packages that use the X Window System, `configure' can usually
Packit b099d7
find the X include and library files automatically, but if it doesn't,
Packit b099d7
you can use the `configure' options `--x-includes=DIR' and
Packit b099d7
`--x-libraries=DIR' to specify their locations.
Packit b099d7
Packit b099d7
Specifying the System Type
Packit b099d7
==========================
Packit b099d7
Packit b099d7
   There may be some features `configure' can not figure out
Packit b099d7
automatically, but needs to determine by the type of host the package
Packit b099d7
will run on.  Usually `configure' can figure that out, but if it prints
Packit b099d7
a message saying it can not guess the host type, give it the
Packit b099d7
`--host=TYPE' option.  TYPE can either be a short name for the system
Packit b099d7
type, such as `sun4', or a canonical name with three fields:
Packit b099d7
     CPU-COMPANY-SYSTEM
Packit b099d7
Packit b099d7
See the file `config.sub' for the possible values of each field.  If
Packit b099d7
`config.sub' isn't included in this package, then this package doesn't
Packit b099d7
need to know the host type.
Packit b099d7
Packit b099d7
   If you are building compiler tools for cross-compiling, you can also
Packit b099d7
use the `--target=TYPE' option to select the type of system they will
Packit b099d7
produce code for and the `--build=TYPE' option to select the type of
Packit b099d7
system on which you are compiling the package.
Packit b099d7
Packit b099d7
Sharing Defaults
Packit b099d7
================
Packit b099d7
Packit b099d7
   If you want to set default values for `configure' scripts to share,
Packit b099d7
you can create a site shell script called `config.site' that gives
Packit b099d7
default values for variables like `CC', `cache_file', and `prefix'.
Packit b099d7
`configure' looks for `PREFIX/share/config.site' if it exists, then
Packit b099d7
`PREFIX/etc/config.site' if it exists.  Or, you can set the
Packit b099d7
`CONFIG_SITE' environment variable to the location of the site script.
Packit b099d7
A warning: not all `configure' scripts look for a site script.
Packit b099d7
Packit b099d7
Operation Controls
Packit b099d7
==================
Packit b099d7
Packit b099d7
   `configure' recognizes the following options to control how it
Packit b099d7
operates.
Packit b099d7
Packit b099d7
`--cache-file=FILE'
Packit b099d7
     Use and save the results of the tests in FILE instead of
Packit b099d7
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
Packit b099d7
     debugging `configure'.
Packit b099d7
Packit b099d7
`--help'
Packit b099d7
     Print a summary of the options to `configure', and exit.
Packit b099d7
Packit b099d7
`--quiet'
Packit b099d7
`--silent'
Packit b099d7
`-q'
Packit b099d7
     Do not print messages saying which checks are being made.  To
Packit b099d7
     suppress all normal output, redirect it to `/dev/null' (any error
Packit b099d7
     messages will still be shown).
Packit b099d7
Packit b099d7
`--srcdir=DIR'
Packit b099d7
     Look for the package's source code in directory DIR.  Usually
Packit b099d7
     `configure' can determine that directory automatically.
Packit b099d7
Packit b099d7
`--version'
Packit b099d7
     Print the version of Autoconf used to generate the `configure'
Packit b099d7
     script, and exit.
Packit b099d7
Packit b099d7
`configure' also accepts some other, not widely useful, options.