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