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