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