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