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.ac' is used to create `configure' by a program 23called `autoconf'. You only need `configure.ac' 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 code directory by typing `make clean'. To also remove the 47 files that `configure' created (so you can compile the package for 48 a different kind of computer), type `make distclean'. There is 49 also a `make maintainer-clean' target, but that is intended mainly 50 for the package's developers. If you use it, you may have to get 51 all sorts of other programs in order to regenerate files that came 52 with the distribution. 53 54Compilers and Options 55===================== 56 57 Some systems require unusual options for compilation or linking that 58the `configure' script does not know about. You can give `configure' 59initial values for variables as arguments. You can do it like this: 60 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix 61 62Compiling For Multiple Architectures 63==================================== 64 65 You can compile the package for more than one kind of computer at the 66same time, by placing the object files for each architecture in their 67own directory. To do this, you must use a version of `make' that 68supports the `VPATH' variable, such as GNU `make'. `cd' to the 69directory where you want the object files and executables to go and run 70the `configure' script. `configure' automatically checks for the 71source code in the directory that `configure' is in and in `..'. 72 73 If you have to use a `make' that does not supports the `VPATH' 74variable, you have to compile the package for one architecture at a time 75in the source code directory. After you have installed the package for 76one architecture, use `make distclean' before reconfiguring for another 77architecture. 78 79Installation Names 80================== 81 82 By default, `make install' will install the package's files in 83`/usr/local/bin', `/usr/local/man', etc. You can specify an 84installation prefix other than `/usr/local' by giving `configure' the 85option `--prefix=PATH'. 86 87 You can specify separate installation prefixes for 88architecture-specific files and architecture-independent files. If you 89give `configure' the option `--exec-prefix=PATH', the package will use 90PATH as the prefix for installing programs and libraries. 91Documentation and other data files will still use the regular prefix. 92 93 In addition, if you use an unusual directory layout you can give 94options like `--bindir=PATH' to specify different values for particular 95kinds of files. Run `configure --help' for a list of the directories 96you can set and what kinds of files go in them. 97 98 If the package supports it, you can cause programs to be installed 99with an extra prefix or suffix on their names by giving `configure' the 100option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 101 102Relocatable Installation 103======================== 104 105 By default, `make install' will install a package with hardwired 106file names, and the package will not work correctly when copied or 107moved to a different location in the filesystem. 108 109 Some packages pay attention to the `--enable-relocatable' option to 110`configure'. This option makes the entire installed package 111relocatable. This means, it can be moved or copied to a different 112location on the filesystem. It is possible to make symlinks to the 113installed and moved programs, and invoke them through the symlink. It 114is possible to do the same thing with a hard link _only_ if the hard 115linked file is in the same directory as the real program. 116 117 For reliability it is best to give together with --enable-relocatable 118a `--prefix' option pointing to an otherwise unused (and never used 119again) directory, for example, `--prefix=/tmp/inst$$'. This is 120recommended because on some OSes the executables remember the location 121of shared libraries (and prefer them over LD_LIBRARY_PATH !), therefore 122such an executable will look for its shared libraries first in the 123original installation directory and only then in the current 124installation directory. 125 126 Installation with `--enable-relocatable' will not work for setuid / 127setgid executables. (This is because such an executable kills its 128LD_LIBRARY_PATH variable when it is launched.) 129 130 The runtime penalty and size penalty are nearly zero on Linux 2.2 or 131newer (just one system call more when an executable is launched), and 132small on other systems (the wrapper program just sets an environment 133variable and execs the real program). 134 135Optional Features 136================= 137 138 Some packages pay attention to `--enable-FEATURE' options to 139`configure', where FEATURE indicates an optional part of the package. 140They may also pay attention to `--with-PACKAGE' options, where PACKAGE 141is something like `gnu-as' or `x' (for the X Window System). The 142`README' should mention any `--enable-' and `--with-' options that the 143package recognizes. 144 145 For packages that use the X Window System, `configure' can usually 146find the X include and library files automatically, but if it doesn't, 147you can use the `configure' options `--x-includes=DIR' and 148`--x-libraries=DIR' to specify their locations. 149 150 For packages that use the GNU libiconv library, you can use the 151`configure' option `--with-libiconv-prefix' to specify the prefix you 152used while installing GNU libiconv. This option is not necessary if 153that other prefix is the same as the one now specified through --prefix. 154 155 For packages that use the GNU libintl library, you can use the 156`configure' option `--with-libintl-prefix' to specify the prefix you 157used while installing GNU gettext-runtime. This option is not necessary if 158that other prefix is the same as the one now specified through --prefix. 159 160Particular Systems 161================== 162 163 On HP-UX, the default C compiler is not ANSI C compatible. If GNU CC 164is not installed, it is recommended to use the following options in order 165to use an ANSI C compiler: 166 167 ./configure CC="cc -Ae" 168 169 On OSF/1 a.k.a. Tru64, some versions of the default C compiler don't grok 170its <wchar.h> header file. The option -nodtk can be used as a workaround. 171If GNU CC is not installed, it is therefore recommended to try 172 173 ./configure CC="cc" 174 175and if that doesn't work, try 176 177 ./configure CC="cc -nodtk" 178 179 On AIX 3, the C include files by default don't define some necessary 180prototype declarations. If GNU CC is not installed, it is recommended to 181use the following options: 182 183 ./configure CC="xlc -D_ALL_SOURCE" 184 185 On BeOS, user installed software goes in /boot/home/config, not 186/usr/local. It is recommended to use the following options: 187 188 ./configure --prefix=/boot/home/config 189 190Specifying the System Type 191========================== 192 193 There may be some features `configure' can not figure out 194automatically, but needs to determine by the type of host the package 195will run on. Usually `configure' can figure that out, but if it prints 196a message saying it can not guess the host type, give it the 197`--host=TYPE' option. TYPE can either be a short name for the system 198type, such as `sun4', or a canonical name with three fields: 199 CPU-COMPANY-SYSTEM 200 201See the file `config.sub' for the possible values of each field. If 202`config.sub' isn't included in this package, then this package doesn't 203need to know the host type. 204 205 If you are building compiler tools for cross-compiling, you can also 206use the `--target=TYPE' option to select the type of system they will 207produce code for and the `--build=TYPE' option to select the type of 208system on which you are compiling the package. 209 210Sharing Defaults 211================ 212 213 If you want to set default values for `configure' scripts to share, 214you can create a site shell script called `config.site' that gives 215default values for variables like `CC', `cache_file', and `prefix'. 216`configure' looks for `PREFIX/share/config.site' if it exists, then 217`PREFIX/etc/config.site' if it exists. Or, you can set the 218`CONFIG_SITE' environment variable to the location of the site script. 219A warning: not all `configure' scripts look for a site script. 220 221Operation Controls 222================== 223 224 `configure' recognizes the following options to control how it 225operates. 226 227`--cache-file=FILE' 228 Use and save the results of the tests in FILE instead of 229 `./config.cache'. Set FILE to `/dev/null' to disable caching, for 230 debugging `configure'. 231 232`--help' 233 Print a summary of the options to `configure', and exit. 234 235`--quiet' 236`--silent' 237`-q' 238 Do not print messages saying which checks are being made. To 239 suppress all normal output, redirect it to `/dev/null' (any error 240 messages will still be shown). 241 242`--srcdir=DIR' 243 Look for the package's source code in directory DIR. Usually 244 `configure' can determine that directory automatically. 245 246`--version' 247 Print the version of Autoconf used to generate the `configure' 248 script, and exit. 249 250`configure' also accepts some other, not widely useful, options. 251 252