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