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