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