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