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