renatofilho@608: Basic Installation
renatofilho@608: ==================
renatofilho@608: 
renatofilho@608:    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@608: you can run in the future to recreate the current configuration, a file
renatofilho@608: `config.cache' that saves the results of its tests to speed up
renatofilho@608: reconfiguring, and a file `config.log' containing compiler output
renatofilho@608: (useful mainly for debugging `configure').
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@608: be considered for the next release.  If at some point `config.cache'
renatofilho@608: contains results you don't want to keep, you may remove or edit it.
renatofilho@608: 
renatofilho@608:    The file `configure.in' is used to create `configure' by a program
renatofilho@608: called `autoconf'.  You only need `configure.in' if you want to change
renatofilho@608: it or regenerate `configure' using 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@608:    Some systems require unusual options for compilation or linking that
renatofilho@608: the `configure' script does not know about.  You can give `configure'
renatofilho@608: initial values for variables by setting them in the environment.  Using
renatofilho@608: a Bourne-compatible shell, you can do that on the command line like
renatofilho@608: this:
renatofilho@608:      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
renatofilho@608: 
renatofilho@608: Or on systems that have the `env' program, you can do it like this:
renatofilho@608:      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
renatofilho@608: 
renatofilho@608: Compiling For Multiple Architectures
renatofilho@608: ====================================
renatofilho@608: 
renatofilho@608:    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@608:    If you have to use a `make' that does not supports the `VPATH'
renatofilho@608: variable, you have to compile the package for one architecture at a time
renatofilho@608: in the source code directory.  After you have installed the package for
renatofilho@608: one architecture, use `make distclean' before reconfiguring for another
renatofilho@608: architecture.
renatofilho@608: 
renatofilho@608: Installation Names
renatofilho@608: ==================
renatofilho@608: 
renatofilho@608:    By default, `make install' will install the package's files in
renatofilho@608: `/usr/local/bin', `/usr/local/man', etc.  You can specify an
renatofilho@608: installation prefix other than `/usr/local' by giving `configure' the
renatofilho@608: option `--prefix=PATH'.
renatofilho@608: 
renatofilho@608:    You can specify separate installation prefixes for
renatofilho@608: architecture-specific files and architecture-independent files.  If you
renatofilho@608: give `configure' the option `--exec-prefix=PATH', the package will use
renatofilho@608: PATH as the prefix for installing programs and libraries.
renatofilho@608: 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@608: options like `--bindir=PATH' 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@608:    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@608:    There may be some features `configure' can not figure out
renatofilho@608: automatically, but needs to determine by the type of host the package
renatofilho@608: will run on.  Usually `configure' can figure that out, but if it prints
renatofilho@608: a message saying it can not guess the host type, give it the
renatofilho@608: `--host=TYPE' option.  TYPE can either be a short name for the system
renatofilho@608: type, such as `sun4', or a canonical name with three fields:
renatofilho@608:      CPU-COMPANY-SYSTEM
renatofilho@608: 
renatofilho@608: 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@608: need to know the host type.
renatofilho@608: 
renatofilho@608:    If you are building compiler tools for cross-compiling, you can also
renatofilho@608: use the `--target=TYPE' option to select the type of system they will
renatofilho@608: produce code for and the `--build=TYPE' option to select the type of
renatofilho@608: system on which you are compiling the package.
renatofilho@608: 
renatofilho@608: Sharing Defaults
renatofilho@608: ================
renatofilho@608: 
renatofilho@608:    If you want to set default values for `configure' scripts to share,
renatofilho@608: you can create a site shell script called `config.site' that gives
renatofilho@608: default 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@608: Operation Controls
renatofilho@608: ==================
renatofilho@608: 
renatofilho@608:    `configure' recognizes the following options to control how it
renatofilho@608: operates.
renatofilho@608: 
renatofilho@608: `--cache-file=FILE'
renatofilho@608:      Use and save the results of the tests in FILE instead of
renatofilho@608:      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
renatofilho@608:      debugging `configure'.
renatofilho@608: 
renatofilho@608: `--help'
renatofilho@608:      Print a summary of the options to `configure', and exit.
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@608: `--version'
renatofilho@608:      Print the version of Autoconf used to generate the `configure'
renatofilho@608:      script, and exit.
renatofilho@608: 
renatofilho@608: `configure' also accepts some other, not widely useful, options.