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