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