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