cannam@125: Basic Installation cannam@125: ================== cannam@125: cannam@125: These are generic installation instructions. cannam@125: cannam@125: The `configure' shell script attempts to guess correct values for cannam@125: various system-dependent variables used during compilation. It uses cannam@125: those values to create a `Makefile' in each directory of the package. cannam@125: It may also create one or more `.h' files containing system-dependent cannam@125: definitions. Finally, it creates a shell script `config.status' that cannam@125: you can run in the future to recreate the current configuration, a file cannam@125: `config.cache' that saves the results of its tests to speed up cannam@125: reconfiguring, and a file `config.log' containing compiler output cannam@125: (useful mainly for debugging `configure'). cannam@125: cannam@125: If you need to do unusual things to compile the package, please try cannam@125: to figure out how `configure' could check whether to do them, and mail cannam@125: diffs or instructions to the address given in the `README' so they can cannam@125: be considered for the next release. If at some point `config.cache' cannam@125: contains results you don't want to keep, you may remove or edit it. cannam@125: cannam@125: The file `configure.in' is used to create `configure' by a program cannam@125: called `autoconf'. You only need `configure.in' if you want to change cannam@125: it or regenerate `configure' using a newer version of `autoconf'. cannam@125: cannam@125: The simplest way to compile this package is: cannam@125: cannam@125: 1. `cd' to the directory containing the package's source code and type cannam@125: `./configure' to configure the package for your system. If you're cannam@125: using `csh' on an old version of System V, you might need to type cannam@125: `sh ./configure' instead to prevent `csh' from trying to execute cannam@125: `configure' itself. cannam@125: cannam@125: Running `configure' takes awhile. While running, it prints some cannam@125: messages telling which features it is checking for. cannam@125: cannam@125: 2. Type `make' to compile the package. cannam@125: cannam@125: 3. Optionally, type `make check' to run any self-tests that come with cannam@125: the package. cannam@125: cannam@125: 4. Type `make install' to install the programs and any data files and cannam@125: documentation. cannam@125: cannam@125: 5. You can remove the program binaries and object files from the cannam@125: source code directory by typing `make clean'. To also remove the cannam@125: files that `configure' created (so you can compile the package for cannam@125: a different kind of computer), type `make distclean'. There is cannam@125: also a `make maintainer-clean' target, but that is intended mainly cannam@125: for the package's developers. If you use it, you may have to get cannam@125: all sorts of other programs in order to regenerate files that came cannam@125: with the distribution. cannam@125: cannam@125: Compilers and Options cannam@125: ===================== cannam@125: cannam@125: Some systems require unusual options for compilation or linking that cannam@125: the `configure' script does not know about. You can give `configure' cannam@125: initial values for variables by setting them in the environment. Using cannam@125: a Bourne-compatible shell, you can do that on the command line like cannam@125: this: cannam@125: CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure cannam@125: cannam@125: Or on systems that have the `env' program, you can do it like this: cannam@125: env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure cannam@125: cannam@125: Compiling For Multiple Architectures cannam@125: ==================================== cannam@125: cannam@125: You can compile the package for more than one kind of computer at the cannam@125: same time, by placing the object files for each architecture in their cannam@125: own directory. To do this, you must use a version of `make' that cannam@125: supports the `VPATH' variable, such as GNU `make'. `cd' to the cannam@125: directory where you want the object files and executables to go and run cannam@125: the `configure' script. `configure' automatically checks for the cannam@125: source code in the directory that `configure' is in and in `..'. cannam@125: cannam@125: If you have to use a `make' that does not supports the `VPATH' cannam@125: variable, you have to compile the package for one architecture at a time cannam@125: in the source code directory. After you have installed the package for cannam@125: one architecture, use `make distclean' before reconfiguring for another cannam@125: architecture. cannam@125: cannam@125: Installation Names cannam@125: ================== cannam@125: cannam@125: By default, `make install' will install the package's files in cannam@125: `/usr/local/bin', `/usr/local/man', etc. You can specify an cannam@125: installation prefix other than `/usr/local' by giving `configure' the cannam@125: option `--prefix=PATH'. cannam@125: cannam@125: You can specify separate installation prefixes for cannam@125: architecture-specific files and architecture-independent files. If you cannam@125: give `configure' the option `--exec-prefix=PATH', the package will use cannam@125: PATH as the prefix for installing programs and libraries. cannam@125: Documentation and other data files will still use the regular prefix. cannam@125: cannam@125: In addition, if you use an unusual directory layout you can give cannam@125: options like `--bindir=PATH' to specify different values for particular cannam@125: kinds of files. Run `configure --help' for a list of the directories cannam@125: you can set and what kinds of files go in them. cannam@125: cannam@125: If the package supports it, you can cause programs to be installed cannam@125: with an extra prefix or suffix on their names by giving `configure' the cannam@125: option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. cannam@125: cannam@125: Optional Features cannam@125: ================= cannam@125: cannam@125: Some packages pay attention to `--enable-FEATURE' options to cannam@125: `configure', where FEATURE indicates an optional part of the package. cannam@125: They may also pay attention to `--with-PACKAGE' options, where PACKAGE cannam@125: is something like `gnu-as' or `x' (for the X Window System). The cannam@125: `README' should mention any `--enable-' and `--with-' options that the cannam@125: package recognizes. cannam@125: cannam@125: For packages that use the X Window System, `configure' can usually cannam@125: find the X include and library files automatically, but if it doesn't, cannam@125: you can use the `configure' options `--x-includes=DIR' and cannam@125: `--x-libraries=DIR' to specify their locations. cannam@125: cannam@125: Specifying the System Type cannam@125: ========================== cannam@125: cannam@125: There may be some features `configure' can not figure out cannam@125: automatically, but needs to determine by the type of host the package cannam@125: will run on. Usually `configure' can figure that out, but if it prints cannam@125: a message saying it can not guess the host type, give it the cannam@125: `--host=TYPE' option. TYPE can either be a short name for the system cannam@125: type, such as `sun4', or a canonical name with three fields: cannam@125: CPU-COMPANY-SYSTEM cannam@125: cannam@125: See the file `config.sub' for the possible values of each field. If cannam@125: `config.sub' isn't included in this package, then this package doesn't cannam@125: need to know the host type. cannam@125: cannam@125: If you are building compiler tools for cross-compiling, you can also cannam@125: use the `--target=TYPE' option to select the type of system they will cannam@125: produce code for and the `--build=TYPE' option to select the type of cannam@125: system on which you are compiling the package. cannam@125: cannam@125: Sharing Defaults cannam@125: ================ cannam@125: cannam@125: If you want to set default values for `configure' scripts to share, cannam@125: you can create a site shell script called `config.site' that gives cannam@125: default values for variables like `CC', `cache_file', and `prefix'. cannam@125: `configure' looks for `PREFIX/share/config.site' if it exists, then cannam@125: `PREFIX/etc/config.site' if it exists. Or, you can set the cannam@125: `CONFIG_SITE' environment variable to the location of the site script. cannam@125: A warning: not all `configure' scripts look for a site script. cannam@125: cannam@125: Operation Controls cannam@125: ================== cannam@125: cannam@125: `configure' recognizes the following options to control how it cannam@125: operates. cannam@125: cannam@125: `--cache-file=FILE' cannam@125: Use and save the results of the tests in FILE instead of cannam@125: `./config.cache'. Set FILE to `/dev/null' to disable caching, for cannam@125: debugging `configure'. cannam@125: cannam@125: `--help' cannam@125: Print a summary of the options to `configure', and exit. cannam@125: cannam@125: `--quiet' cannam@125: `--silent' cannam@125: `-q' cannam@125: Do not print messages saying which checks are being made. To cannam@125: suppress all normal output, redirect it to `/dev/null' (any error cannam@125: messages will still be shown). cannam@125: cannam@125: `--srcdir=DIR' cannam@125: Look for the package's source code in directory DIR. Usually cannam@125: `configure' can determine that directory automatically. cannam@125: cannam@125: `--version' cannam@125: Print the version of Autoconf used to generate the `configure' cannam@125: script, and exit. cannam@125: cannam@125: `configure' also accepts some other, not widely useful, options.