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