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