Blame INSTALL

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