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