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