1Basic Installation 2================== 3 4 These are generic installation instructions. 5 6 The `configure' shell script attempts to guess correct values for 7various system-dependent variables used during compilation. It uses 8those values to create a `Makefile' in each directory of the package. 9It may also create one or more `.h' files containing system-dependent 10definitions. Finally, it creates a shell script `config.status' that 11you can run in the future to recreate the current configuration, a file 12`config.cache' that saves the results of its tests to speed up 13reconfiguring, and a file `config.log' containing compiler output 14(useful mainly for debugging `configure'). 15 16 If you need to do unusual things to compile the package, please try 17to figure out how `configure' could check whether to do them, and mail 18diffs or instructions to the address given in the `README' so they can 19be considered for the next release. If at some point `config.cache' 20contains results you don't want to keep, you may remove or edit it. 21 22 The file `configure.in' is used to create `configure' by a program 23called `autoconf'. You only need `configure.in' if you want to change 24it or regenerate `configure' using a newer version of `autoconf'. 25 26The simplest way to compile this package is: 27 28 1. `cd' to the directory containing the package's source code and type 29 `./configure' to configure the package for your system. If you're 30 using `csh' on an old version of System V, you might need to type 31 `sh ./configure' instead to prevent `csh' from trying to execute 32 `configure' itself. 33 34 Running `configure' takes awhile. While running, it prints some 35 messages telling which features it is checking for. 36 37 2. Type `make' to compile the package. 38 39 3. Optionally, type `make check' to run any self-tests that come with 40 the package. 41 42 4. Type `make install' to install the programs and any data files and 43 documentation. 44 45 5. You can remove the program binaries and object files from the 46 source directory by typing `make clean'. To also remove the files 47 that `configure' created (so you can compile the package for a 48 different kind of computer), type `make distclean'. 49 50Compilers and Options 51===================== 52 53 Some systems require unusual options for compilation or linking that 54the `configure' script does not know about. You can give `configure' 55initial values for variables by setting them in the environment. Using 56a Bourne-compatible shell, you can do that on the command line like 57this: 58 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure 59 60Or on systems that have the `env' program, you can do it like this: 61 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure 62 63Using a Different Build Directory 64================================= 65 66 You can compile the package in a different directory from the one 67containing the source code. Doing so allows you to compile it on more 68than one kind of computer at the same time. To do this, you must use a 69version of `make' that supports the `VPATH' variable, such as GNU 70`make'. `cd' to the directory where you want the object files and 71executables to go and run the `configure' script. `configure' 72automatically checks for the source code in the directory that 73`configure' is in and in `..'. 74 75Installation Names 76================== 77 78 By default, `make install' will install the package's files in 79`/usr/local/bin', `/usr/local/man', etc. You can specify an 80installation prefix other than `/usr/local' by giving `configure' the 81option `--prefix=PATH'. 82 83 You can specify separate installation prefixes for 84architecture-specific files and architecture-independent files. If you 85give `configure' the option `--exec-prefix=PATH', the package will use 86PATH as the prefix for installing programs and libraries. 87Documentation and other data files will still use the regular prefix. 88 89 If the package supports it, you can cause programs to be installed 90with an extra prefix or suffix on their names by giving `configure' the 91option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 92 93Optional Features 94================= 95 96 Some packages pay attention to `--enable-FEATURE' options to 97`configure', where FEATURE indicates an optional part of the package. 98They may also pay attention to `--with-PACKAGE' options, where PACKAGE 99is something like `gnu-as' or `x' (for the X Window System). The 100`README' should mention any `--enable-' and `--with-' options that the 101package recognizes. 102 103 For packages that use the X Window System, `configure' can usually 104find the X include and library files automatically, but if it doesn't, 105you can use the `configure' options `--x-includes=DIR' and 106`--x-libraries=DIR' to specify their locations. 107 108Specifying the System Type 109========================== 110 111 There may be some features `configure' can not figure out 112automatically, but needs to determine by the type of host the package 113will run on. Usually `configure' can figure that out, but if it prints 114a message saying it can not guess the host type, give it the 115`--host=TYPE' option. TYPE can either be a short name for the system 116type, such as `sun4', or a canonical name with three fields: 117 CPU-COMPANY-SYSTEM 118 119See the file `config.sub' for the possible values of each field. If 120`config.sub' isn't included in this package, then this package doesn't 121need to know the host type. 122 123 If you are building compiler tools for cross-compiling, you can also 124use the `--target=TYPE' option to select the type of system they will 125produce code for and the `--build=TYPE' option to select the type of 126system on which you are compiling the package. 127 128Sharing Defaults 129================ 130 131 If you want to set default values for `configure' scripts to share, 132you can create a site shell script called `config.site' that gives 133default values for variables like `CC', `cache_file', and `prefix'. 134`configure' looks for `PREFIX/share/config.site' if it exists, then 135`PREFIX/etc/config.site' if it exists. Or, you can set the 136`CONFIG_SITE' environment variable to the location of the site script. 137A warning: not all `configure' scripts look for a site script. 138 139Operation Controls 140================== 141 142 `configure' recognizes the following options to control how it 143operates. 144 145`--cache-file=FILE' 146 Save the results of the tests in FILE instead of `config.cache'. 147 Set FILE to `/dev/null' to disable caching, for debugging 148 `configure'. 149 150`--help' 151 Print a summary of the options to `configure', and exit. 152 153`--quiet' 154`--silent' 155`-q' 156 Do not print messages saying which checks are being made. 157 158`--srcdir=DIR' 159 Look for the package's source code in directory DIR. Usually 160 `configure' can determine that directory automatically. 161 162`--version' 163 Print the version of Autoconf used to generate the `configure' 164 script, and exit. 165 166`configure' also accepts some other, not widely useful, options. 167 168