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