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