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