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