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