Blame INSTALL

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