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