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