rlm@8: Installation Instructions rlm@8: ************************* rlm@8: rlm@8: Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, rlm@8: 2006, 2007, 2008, 2009 Free Software Foundation, Inc. rlm@8: rlm@8: Copying and distribution of this file, with or without modification, rlm@8: are permitted in any medium without royalty provided the copyright rlm@8: notice and this notice are preserved. This file is offered as-is, rlm@8: without warranty of any kind. rlm@8: rlm@8: Basic Installation rlm@8: ================== rlm@8: rlm@8: Briefly, the shell commands `./configure; make; make install' should rlm@8: configure, build, and install this package. The following rlm@8: more-detailed instructions are generic; see the `README' file for rlm@8: instructions specific to this package. Some packages provide this rlm@8: `INSTALL' file but do not implement all of the features documented rlm@8: below. The lack of an optional feature in a given package is not rlm@8: necessarily a bug. More recommendations for GNU packages can be found rlm@8: in *note Makefile Conventions: (standards)Makefile Conventions. rlm@8: rlm@8: The `configure' shell script attempts to guess correct values for rlm@8: various system-dependent variables used during compilation. It uses rlm@8: those values to create a `Makefile' in each directory of the package. rlm@8: It may also create one or more `.h' files containing system-dependent rlm@8: definitions. Finally, it creates a shell script `config.status' that rlm@8: you can run in the future to recreate the current configuration, and a rlm@8: file `config.log' containing compiler output (useful mainly for rlm@8: debugging `configure'). rlm@8: rlm@8: It can also use an optional file (typically called `config.cache' rlm@8: and enabled with `--cache-file=config.cache' or simply `-C') that saves rlm@8: the results of its tests to speed up reconfiguring. Caching is rlm@8: disabled by default to prevent problems with accidental use of stale rlm@8: cache files. rlm@8: rlm@8: If you need to do unusual things to compile the package, please try rlm@8: to figure out how `configure' could check whether to do them, and mail rlm@8: diffs or instructions to the address given in the `README' so they can rlm@8: be considered for the next release. If you are using the cache, and at rlm@8: some point `config.cache' contains results you don't want to keep, you rlm@8: may remove or edit it. rlm@8: rlm@8: The file `configure.ac' (or `configure.in') is used to create rlm@8: `configure' by a program called `autoconf'. You need `configure.ac' if rlm@8: you want to change it or regenerate `configure' using a newer version rlm@8: of `autoconf'. rlm@8: rlm@8: The simplest way to compile this package is: rlm@8: rlm@8: 1. `cd' to the directory containing the package's source code and type rlm@8: `./configure' to configure the package for your system. rlm@8: rlm@8: Running `configure' might take a while. While running, it prints rlm@8: some messages telling which features it is checking for. rlm@8: rlm@8: 2. Type `make' to compile the package. rlm@8: rlm@8: 3. Optionally, type `make check' to run any self-tests that come with rlm@8: the package, generally using the just-built uninstalled binaries. rlm@8: rlm@8: 4. Type `make install' to install the programs and any data files and rlm@8: documentation. When installing into a prefix owned by root, it is rlm@8: recommended that the package be configured and built as a regular rlm@8: user, and only the `make install' phase executed with root rlm@8: privileges. rlm@8: rlm@8: 5. Optionally, type `make installcheck' to repeat any self-tests, but rlm@8: this time using the binaries in their final installed location. rlm@8: This target does not install anything. Running this target as a rlm@8: regular user, particularly if the prior `make install' required rlm@8: root privileges, verifies that the installation completed rlm@8: correctly. rlm@8: rlm@8: 6. You can remove the program binaries and object files from the rlm@8: source code directory by typing `make clean'. To also remove the rlm@8: files that `configure' created (so you can compile the package for rlm@8: a different kind of computer), type `make distclean'. There is rlm@8: also a `make maintainer-clean' target, but that is intended mainly rlm@8: for the package's developers. If you use it, you may have to get rlm@8: all sorts of other programs in order to regenerate files that came rlm@8: with the distribution. rlm@8: rlm@8: 7. Often, you can also type `make uninstall' to remove the installed rlm@8: files again. In practice, not all packages have tested that rlm@8: uninstallation works correctly, even though it is required by the rlm@8: GNU Coding Standards. rlm@8: rlm@8: 8. Some packages, particularly those that use Automake, provide `make rlm@8: distcheck', which can by used by developers to test that all other rlm@8: targets like `make install' and `make uninstall' work correctly. rlm@8: This target is generally not run by end users. rlm@8: rlm@8: Compilers and Options rlm@8: ===================== rlm@8: rlm@8: Some systems require unusual options for compilation or linking that rlm@8: the `configure' script does not know about. Run `./configure --help' rlm@8: for details on some of the pertinent environment variables. rlm@8: rlm@8: You can give `configure' initial values for configuration parameters rlm@8: by setting variables in the command line or in the environment. Here rlm@8: is an example: rlm@8: rlm@8: ./configure CC=c99 CFLAGS=-g LIBS=-lposix rlm@8: rlm@8: *Note Defining Variables::, for more details. rlm@8: rlm@8: Compiling For Multiple Architectures rlm@8: ==================================== rlm@8: rlm@8: You can compile the package for more than one kind of computer at the rlm@8: same time, by placing the object files for each architecture in their rlm@8: own directory. To do this, you can use GNU `make'. `cd' to the rlm@8: directory where you want the object files and executables to go and run rlm@8: the `configure' script. `configure' automatically checks for the rlm@8: source code in the directory that `configure' is in and in `..'. This rlm@8: is known as a "VPATH" build. rlm@8: rlm@8: With a non-GNU `make', it is safer to compile the package for one rlm@8: architecture at a time in the source code directory. After you have rlm@8: installed the package for one architecture, use `make distclean' before rlm@8: reconfiguring for another architecture. rlm@8: rlm@8: On MacOS X 10.5 and later systems, you can create libraries and rlm@8: executables that work on multiple system types--known as "fat" or rlm@8: "universal" binaries--by specifying multiple `-arch' options to the rlm@8: compiler but only a single `-arch' option to the preprocessor. Like rlm@8: this: rlm@8: rlm@8: ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ rlm@8: CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ rlm@8: CPP="gcc -E" CXXCPP="g++ -E" rlm@8: rlm@8: This is not guaranteed to produce working output in all cases, you rlm@8: may have to build one architecture at a time and combine the results rlm@8: using the `lipo' tool if you have problems. rlm@8: rlm@8: Installation Names rlm@8: ================== rlm@8: rlm@8: By default, `make install' installs the package's commands under rlm@8: `/usr/local/bin', include files under `/usr/local/include', etc. You rlm@8: can specify an installation prefix other than `/usr/local' by giving rlm@8: `configure' the option `--prefix=PREFIX', where PREFIX must be an rlm@8: absolute file name. rlm@8: rlm@8: You can specify separate installation prefixes for rlm@8: architecture-specific files and architecture-independent files. If you rlm@8: pass the option `--exec-prefix=PREFIX' to `configure', the package uses rlm@8: PREFIX as the prefix for installing programs and libraries. rlm@8: Documentation and other data files still use the regular prefix. rlm@8: rlm@8: In addition, if you use an unusual directory layout you can give rlm@8: options like `--bindir=DIR' to specify different values for particular rlm@8: kinds of files. Run `configure --help' for a list of the directories rlm@8: you can set and what kinds of files go in them. In general, the rlm@8: default for these options is expressed in terms of `${prefix}', so that rlm@8: specifying just `--prefix' will affect all of the other directory rlm@8: specifications that were not explicitly provided. rlm@8: rlm@8: The most portable way to affect installation locations is to pass the rlm@8: correct locations to `configure'; however, many packages provide one or rlm@8: both of the following shortcuts of passing variable assignments to the rlm@8: `make install' command line to change installation locations without rlm@8: having to reconfigure or recompile. rlm@8: rlm@8: The first method involves providing an override variable for each rlm@8: affected directory. For example, `make install rlm@8: prefix=/alternate/directory' will choose an alternate location for all rlm@8: directory configuration variables that were expressed in terms of rlm@8: `${prefix}'. Any directories that were specified during `configure', rlm@8: but not in terms of `${prefix}', must each be overridden at install rlm@8: time for the entire installation to be relocated. The approach of rlm@8: makefile variable overrides for each directory variable is required by rlm@8: the GNU Coding Standards, and ideally causes no recompilation. rlm@8: However, some platforms have known limitations with the semantics of rlm@8: shared libraries that end up requiring recompilation when using this rlm@8: method, particularly noticeable in packages that use GNU Libtool. rlm@8: rlm@8: The second method involves providing the `DESTDIR' variable. For rlm@8: example, `make install DESTDIR=/alternate/directory' will prepend rlm@8: `/alternate/directory' before all installation names. The approach of rlm@8: `DESTDIR' overrides is not required by the GNU Coding Standards, and rlm@8: does not work on platforms that have drive letters. On the other hand, rlm@8: it does better at avoiding recompilation issues, and works well even rlm@8: when some directory options were not specified in terms of `${prefix}' rlm@8: at `configure' time. rlm@8: rlm@8: Optional Features rlm@8: ================= rlm@8: rlm@8: If the package supports it, you can cause programs to be installed rlm@8: with an extra prefix or suffix on their names by giving `configure' the rlm@8: option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. rlm@8: rlm@8: Some packages pay attention to `--enable-FEATURE' options to rlm@8: `configure', where FEATURE indicates an optional part of the package. rlm@8: They may also pay attention to `--with-PACKAGE' options, where PACKAGE rlm@8: is something like `gnu-as' or `x' (for the X Window System). The rlm@8: `README' should mention any `--enable-' and `--with-' options that the rlm@8: package recognizes. rlm@8: rlm@8: For packages that use the X Window System, `configure' can usually rlm@8: find the X include and library files automatically, but if it doesn't, rlm@8: you can use the `configure' options `--x-includes=DIR' and rlm@8: `--x-libraries=DIR' to specify their locations. rlm@8: rlm@8: Some packages offer the ability to configure how verbose the rlm@8: execution of `make' will be. For these packages, running `./configure rlm@8: --enable-silent-rules' sets the default to minimal output, which can be rlm@8: overridden with `make V=1'; while running `./configure rlm@8: --disable-silent-rules' sets the default to verbose, which can be rlm@8: overridden with `make V=0'. rlm@8: rlm@8: Particular systems rlm@8: ================== rlm@8: rlm@8: On HP-UX, the default C compiler is not ANSI C compatible. If GNU rlm@8: CC is not installed, it is recommended to use the following options in rlm@8: order to use an ANSI C compiler: rlm@8: rlm@8: ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" rlm@8: rlm@8: and if that doesn't work, install pre-built binaries of GCC for HP-UX. rlm@8: rlm@8: On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot rlm@8: parse its `' header file. The option `-nodtk' can be used as rlm@8: a workaround. If GNU CC is not installed, it is therefore recommended rlm@8: to try rlm@8: rlm@8: ./configure CC="cc" rlm@8: rlm@8: and if that doesn't work, try rlm@8: rlm@8: ./configure CC="cc -nodtk" rlm@8: rlm@8: On Solaris, don't put `/usr/ucb' early in your `PATH'. This rlm@8: directory contains several dysfunctional programs; working variants of rlm@8: these programs are available in `/usr/bin'. So, if you need `/usr/ucb' rlm@8: in your `PATH', put it _after_ `/usr/bin'. rlm@8: rlm@8: On Haiku, software installed for all users goes in `/boot/common', rlm@8: not `/usr/local'. It is recommended to use the following options: rlm@8: rlm@8: ./configure --prefix=/boot/common rlm@8: rlm@8: Specifying the System Type rlm@8: ========================== rlm@8: rlm@8: There may be some features `configure' cannot figure out rlm@8: automatically, but needs to determine by the type of machine the package rlm@8: will run on. Usually, assuming the package is built to be run on the rlm@8: _same_ architectures, `configure' can figure that out, but if it prints rlm@8: a message saying it cannot guess the machine type, give it the rlm@8: `--build=TYPE' option. TYPE can either be a short name for the system rlm@8: type, such as `sun4', or a canonical name which has the form: rlm@8: rlm@8: CPU-COMPANY-SYSTEM rlm@8: rlm@8: where SYSTEM can have one of these forms: rlm@8: rlm@8: OS rlm@8: KERNEL-OS rlm@8: rlm@8: See the file `config.sub' for the possible values of each field. If rlm@8: `config.sub' isn't included in this package, then this package doesn't rlm@8: need to know the machine type. rlm@8: rlm@8: If you are _building_ compiler tools for cross-compiling, you should rlm@8: use the option `--target=TYPE' to select the type of system they will rlm@8: produce code for. rlm@8: rlm@8: If you want to _use_ a cross compiler, that generates code for a rlm@8: platform different from the build platform, you should specify the rlm@8: "host" platform (i.e., that on which the generated programs will rlm@8: eventually be run) with `--host=TYPE'. rlm@8: rlm@8: Sharing Defaults rlm@8: ================ rlm@8: rlm@8: If you want to set default values for `configure' scripts to share, rlm@8: you can create a site shell script called `config.site' that gives rlm@8: default values for variables like `CC', `cache_file', and `prefix'. rlm@8: `configure' looks for `PREFIX/share/config.site' if it exists, then rlm@8: `PREFIX/etc/config.site' if it exists. Or, you can set the rlm@8: `CONFIG_SITE' environment variable to the location of the site script. rlm@8: A warning: not all `configure' scripts look for a site script. rlm@8: rlm@8: Defining Variables rlm@8: ================== rlm@8: rlm@8: Variables not defined in a site shell script can be set in the rlm@8: environment passed to `configure'. However, some packages may run rlm@8: configure again during the build, and the customized values of these rlm@8: variables may be lost. In order to avoid this problem, you should set rlm@8: them in the `configure' command line, using `VAR=value'. For example: rlm@8: rlm@8: ./configure CC=/usr/local2/bin/gcc rlm@8: rlm@8: causes the specified `gcc' to be used as the C compiler (unless it is rlm@8: overridden in the site shell script). rlm@8: rlm@8: Unfortunately, this technique does not work for `CONFIG_SHELL' due to rlm@8: an Autoconf bug. Until the bug is fixed you can use this workaround: rlm@8: rlm@8: CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash rlm@8: rlm@8: `configure' Invocation rlm@8: ====================== rlm@8: rlm@8: `configure' recognizes the following options to control how it rlm@8: operates. rlm@8: rlm@8: `--help' rlm@8: `-h' rlm@8: Print a summary of all of the options to `configure', and exit. rlm@8: rlm@8: `--help=short' rlm@8: `--help=recursive' rlm@8: Print a summary of the options unique to this package's rlm@8: `configure', and exit. The `short' variant lists options used rlm@8: only in the top level, while the `recursive' variant lists options rlm@8: also present in any nested packages. rlm@8: rlm@8: `--version' rlm@8: `-V' rlm@8: Print the version of Autoconf used to generate the `configure' rlm@8: script, and exit. rlm@8: rlm@8: `--cache-file=FILE' rlm@8: Enable the cache: use and save the results of the tests in FILE, rlm@8: traditionally `config.cache'. FILE defaults to `/dev/null' to rlm@8: disable caching. rlm@8: rlm@8: `--config-cache' rlm@8: `-C' rlm@8: Alias for `--cache-file=config.cache'. rlm@8: rlm@8: `--quiet' rlm@8: `--silent' rlm@8: `-q' rlm@8: Do not print messages saying which checks are being made. To rlm@8: suppress all normal output, redirect it to `/dev/null' (any error rlm@8: messages will still be shown). rlm@8: rlm@8: `--srcdir=DIR' rlm@8: Look for the package's source code in directory DIR. Usually rlm@8: `configure' can determine that directory automatically. rlm@8: rlm@8: `--prefix=DIR' rlm@8: Use DIR as the installation prefix. *note Installation Names:: rlm@8: for more details, including other options available for fine-tuning rlm@8: the installation locations. rlm@8: rlm@8: `--no-create' rlm@8: `-n' rlm@8: Run the configure checks, but stop before creating any output rlm@8: files. rlm@8: rlm@8: `configure' also accepts some other, not widely useful, options. Run rlm@8: `configure --help' for more details. rlm@8: