INSTALL revision 251883
1258945SrobertoInstallation Instructions 2258945Sroberto************************* 3258945Sroberto 4258945SrobertoCopyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free 5258945SrobertoSoftware Foundation, Inc. 6258945Sroberto 7258945SrobertoThis file is free documentation; the Free Software Foundation gives 8258945Srobertounlimited permission to copy, distribute and modify it. 9258945Sroberto 10258945SrobertoBasic Installation 11258945Sroberto================== 12258945Sroberto 13258945SrobertoThese are generic installation instructions. 14258945Sroberto 15275970Scy The `configure' shell script attempts to guess correct values for 16275970Scyvarious system-dependent variables used during compilation. It uses 17275970Scythose values to create a `Makefile' in each directory of the package. 18258945SrobertoIt may also create one or more `.h' files containing system-dependent 19258945Srobertodefinitions. Finally, it creates a shell script `config.status' that 20258945Srobertoyou can run in the future to recreate the current configuration, and a 21258945Srobertofile `config.log' containing compiler output (useful mainly for 22258945Srobertodebugging `configure'). 23258945Sroberto 24258945Sroberto It can also use an optional file (typically called `config.cache' 25258945Srobertoand enabled with `--cache-file=config.cache' or simply `-C') that saves 26258945Srobertothe results of its tests to speed up reconfiguring. (Caching is 27258945Srobertodisabled by default to prevent problems with accidental use of stale 28258945Srobertocache files.) 29258945Sroberto 30258945Sroberto If you need to do unusual things to compile the package, please try 31258945Srobertoto figure out how `configure' could check whether to do them, and mail 32258945Srobertodiffs or instructions to the address given in the `README' so they can 33258945Srobertobe considered for the next release. If you are using the cache, and at 34258945Srobertosome point `config.cache' contains results you don't want to keep, you 35258945Srobertomay remove or edit it. 36258945Sroberto 37258945Sroberto The file `configure.ac' (or `configure.in') is used to create 38258945Sroberto`configure' by a program called `autoconf'. You only need 39258945Sroberto`configure.ac' if you want to change it or regenerate `configure' using 40258945Srobertoa newer version of `autoconf'. 41258945Sroberto 42258945SrobertoThe simplest way to compile this package is: 43258945Sroberto 44258945Sroberto 1. `cd' to the directory containing the package's source code and type 45258945Sroberto `./configure' to configure the package for your system. If you're 46258945Sroberto using `csh' on an old version of System V, you might need to type 47258945Sroberto `sh ./configure' instead to prevent `csh' from trying to execute 48258945Sroberto `configure' itself. 49258945Sroberto 50258945Sroberto Running `configure' takes awhile. While running, it prints some 51258945Sroberto messages telling which features it is checking for. 52258945Sroberto 53258945Sroberto 2. Type `make' to compile the package. 54258945Sroberto 55258945Sroberto 3. Optionally, type `make check' to run any self-tests that come with 56258945Sroberto the package. 57258945Sroberto 58258945Sroberto 4. Type `make install' to install the programs and any data files and 59258945Sroberto documentation. 60258945Sroberto 61258945Sroberto 5. You can remove the program binaries and object files from the 62258945Sroberto source code directory by typing `make clean'. To also remove the 63258945Sroberto files that `configure' created (so you can compile the package for 64258945Sroberto a different kind of computer), type `make distclean'. There is 65258945Sroberto also a `make maintainer-clean' target, but that is intended mainly 66258945Sroberto for the package's developers. If you use it, you may have to get 67258945Sroberto all sorts of other programs in order to regenerate files that came 68258945Sroberto with the distribution. 69258945Sroberto 70258945SrobertoCompilers and Options 71258945Sroberto===================== 72258945Sroberto 73258945SrobertoSome systems require unusual options for compilation or linking that the 74258945Sroberto`configure' script does not know about. Run `./configure --help' for 75258945Srobertodetails on some of the pertinent environment variables. 76258945Sroberto 77258945Sroberto You can give `configure' initial values for configuration parameters 78258945Srobertoby setting variables in the command line or in the environment. Here 79258945Srobertois an example: 80258945Sroberto 81258945Sroberto ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix 82258945Sroberto 83258945Sroberto *Note Defining Variables::, for more details. 84258945Sroberto 85258945SrobertoCompiling For Multiple Architectures 86258945Sroberto==================================== 87258945Sroberto 88275970ScyYou can compile the package for more than one kind of computer at the 89same time, by placing the object files for each architecture in their 90own directory. To do this, you must use a version of `make' that 91supports the `VPATH' variable, such as GNU `make'. `cd' to the 92directory where you want the object files and executables to go and run 93the `configure' script. `configure' automatically checks for the 94source code in the directory that `configure' is in and in `..'. 95 96 If you have to use a `make' that does not support the `VPATH' 97variable, you have to compile the package for one architecture at a 98time in the source code directory. After you have installed the 99package for one architecture, use `make distclean' before reconfiguring 100for another architecture. 101 102Installation Names 103================== 104 105By default, `make install' installs the package's commands under 106`/usr/local/bin', include files under `/usr/local/include', etc. You 107can specify an installation prefix other than `/usr/local' by giving 108`configure' the option `--prefix=PREFIX'. 109 110 You can specify separate installation prefixes for 111architecture-specific files and architecture-independent files. If you 112pass the option `--exec-prefix=PREFIX' to `configure', the package uses 113PREFIX as the prefix for installing programs and libraries. 114Documentation and other data files still use the regular prefix. 115 116 In addition, if you use an unusual directory layout you can give 117options like `--bindir=DIR' to specify different values for particular 118kinds of files. Run `configure --help' for a list of the directories 119you can set and what kinds of files go in them. 120 121 If the package supports it, you can cause programs to be installed 122with an extra prefix or suffix on their names by giving `configure' the 123option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 124 125Optional Features 126================= 127 128Some packages pay attention to `--enable-FEATURE' options to 129`configure', where FEATURE indicates an optional part of the package. 130They may also pay attention to `--with-PACKAGE' options, where PACKAGE 131is something like `gnu-as' or `x' (for the X Window System). The 132`README' should mention any `--enable-' and `--with-' options that the 133package recognizes. 134 135 For packages that use the X Window System, `configure' can usually 136find the X include and library files automatically, but if it doesn't, 137you can use the `configure' options `--x-includes=DIR' and 138`--x-libraries=DIR' to specify their locations. 139 140Specifying the System Type 141========================== 142 143There may be some features `configure' cannot figure out automatically, 144but needs to determine by the type of machine the package will run on. 145Usually, assuming the package is built to be run on the _same_ 146architectures, `configure' can figure that out, but if it prints a 147message saying it cannot guess the machine type, give it the 148`--build=TYPE' option. TYPE can either be a short name for the system 149type, such as `sun4', or a canonical name which has the form: 150 151 CPU-COMPANY-SYSTEM 152 153where SYSTEM can have one of these forms: 154 155 OS KERNEL-OS 156 157 See the file `config.sub' for the possible values of each field. If 158`config.sub' isn't included in this package, then this package doesn't 159need to know the machine type. 160 161 If you are _building_ compiler tools for cross-compiling, you should 162use the option `--target=TYPE' to select the type of system they will 163produce code for. 164 165 If you want to _use_ a cross compiler, that generates code for a 166platform different from the build platform, you should specify the 167"host" platform (i.e., that on which the generated programs will 168eventually be run) with `--host=TYPE'. 169 170Sharing Defaults 171================ 172 173If you want to set default values for `configure' scripts to share, you 174can create a site shell script called `config.site' that gives default 175values for variables like `CC', `cache_file', and `prefix'. 176`configure' looks for `PREFIX/share/config.site' if it exists, then 177`PREFIX/etc/config.site' if it exists. Or, you can set the 178`CONFIG_SITE' environment variable to the location of the site script. 179A warning: not all `configure' scripts look for a site script. 180 181Defining Variables 182================== 183 184Variables not defined in a site shell script can be set in the 185environment passed to `configure'. However, some packages may run 186configure again during the build, and the customized values of these 187variables may be lost. In order to avoid this problem, you should set 188them in the `configure' command line, using `VAR=value'. For example: 189 190 ./configure CC=/usr/local2/bin/gcc 191 192causes the specified `gcc' to be used as the C compiler (unless it is 193overridden in the site shell script). Here is a another example: 194 195 /bin/bash ./configure CONFIG_SHELL=/bin/bash 196 197Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent 198configuration-related scripts to be executed by `/bin/bash'. 199 200`configure' Invocation 201====================== 202 203`configure' recognizes the following options to control how it operates. 204 205`--help' 206`-h' 207 Print a summary of the options to `configure', and exit. 208 209`--version' 210`-V' 211 Print the version of Autoconf used to generate the `configure' 212 script, and exit. 213 214`--cache-file=FILE' 215 Enable the cache: use and save the results of the tests in FILE, 216 traditionally `config.cache'. FILE defaults to `/dev/null' to 217 disable caching. 218 219`--config-cache' 220`-C' 221 Alias for `--cache-file=config.cache'. 222 223`--quiet' 224`--silent' 225`-q' 226 Do not print messages saying which checks are being made. To 227 suppress all normal output, redirect it to `/dev/null' (any error 228 messages will still be shown). 229 230`--srcdir=DIR' 231 Look for the package's source code in directory DIR. Usually 232 `configure' can determine that directory automatically. 233 234`configure' also accepts some other, not widely useful, options. Run 235`configure --help' for more details. 236 237