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