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