1
$Id: INSTALL,v 1.3 2000/07/30 19:01:37 thomas Exp $
3
The installation instructions are in doc/html/doc.html and doc/txt/manual.txt.
4
The system requirements are listed in doc/html/index.html and doc/txt/intro.txt.
5
I recommend using the html version.
6
Following are generic installation instructions for autoconf programs.
7
I strongly recommend to read the Installation section in the docs!
13
These are generic installation instructions.
15
The `configure' shell script attempts to guess correct values for
16
various system-dependent variables used during compilation. It uses
17
those values to create a `Makefile' in each directory of the package.
18
It may also create one or more `.h' files containing system-dependent
19
definitions. Finally, it creates a shell script `config.status' that
20
you can run in the future to recreate the current configuration, a file
21
`config.cache' that saves the results of its tests to speed up
22
reconfiguring, and a file `config.log' containing compiler output
23
(useful mainly for debugging `configure').
25
If you need to do unusual things to compile the package, please try
26
to figure out how `configure' could check whether to do them, and mail
27
diffs or instructions to the address given in the `README' so they can
28
be considered for the next release. If at some point `config.cache'
29
contains results you don't want to keep, you may remove or edit it.
31
The file `configure.in' is used to create `configure' by a program
32
called `autoconf'. You only need `configure.in' if you want to change
33
it or regenerate `configure' using a newer version of `autoconf'.
35
The simplest way to compile this package is:
37
1. `cd' to the directory containing the package's source code and type
38
`./configure' to configure the package for your system. If you're
39
using `csh' on an old version of System V, you might need to type
40
`sh ./configure' instead to prevent `csh' from trying to execute
43
Running `configure' takes awhile. While running, it prints some
44
messages telling which features it is checking for.
46
2. Type `make' to compile the package.
48
3. Optionally, type `make check' to run any self-tests that come with
51
4. Type `make install' to install the programs and any data files and
54
5. You can remove the program binaries and object files from the
55
source code directory by typing `make clean'. To also remove the
56
files that `configure' created (so you can compile the package for
57
a different kind of computer), type `make distclean'. There is
58
also a `make maintainer-clean' target, but that is intended mainly
59
for the package's developers. If you use it, you may have to get
60
all sorts of other programs in order to regenerate files that came
61
with the distribution.
66
Some systems require unusual options for compilation or linking that
67
the `configure' script does not know about. You can give `configure'
68
initial values for variables by setting them in the environment. Using
69
a Bourne-compatible shell, you can do that on the command line like
71
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
73
Or on systems that have the `env' program, you can do it like this:
74
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
76
Compiling For Multiple Architectures
77
====================================
79
You can compile the package for more than one kind of computer at the
80
same time, by placing the object files for each architecture in their
81
own directory. To do this, you must use a version of `make' that
82
supports the `VPATH' variable, such as GNU `make'. `cd' to the
83
directory where you want the object files and executables to go and run
84
the `configure' script. `configure' automatically checks for the
85
source code in the directory that `configure' is in and in `..'.
87
If you have to use a `make' that does not supports the `VPATH'
88
variable, you have to compile the package for one architecture at a time
89
in the source code directory. After you have installed the package for
90
one architecture, use `make distclean' before reconfiguring for another
96
By default, `make install' will install the package's files in
97
`/usr/local/bin', `/usr/local/man', etc. You can specify an
98
installation prefix other than `/usr/local' by giving `configure' the
99
option `--prefix=PATH'.
101
You can specify separate installation prefixes for
102
architecture-specific files and architecture-independent files. If you
103
give `configure' the option `--exec-prefix=PATH', the package will use
104
PATH as the prefix for installing programs and libraries.
105
Documentation and other data files will still use the regular prefix.
107
In addition, if you use an unusual directory layout you can give
108
options like `--bindir=PATH' to specify different values for particular
109
kinds of files. Run `configure --help' for a list of the directories
110
you can set and what kinds of files go in them.
112
If the package supports it, you can cause programs to be installed
113
with an extra prefix or suffix on their names by giving `configure' the
114
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
119
Some packages pay attention to `--enable-FEATURE' options to
120
`configure', where FEATURE indicates an optional part of the package.
121
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
122
is something like `gnu-as' or `x' (for the X Window System). The
123
`README' should mention any `--enable-' and `--with-' options that the
126
For packages that use the X Window System, `configure' can usually
127
find the X include and library files automatically, but if it doesn't,
128
you can use the `configure' options `--x-includes=DIR' and
129
`--x-libraries=DIR' to specify their locations.
131
Specifying the System Type
132
==========================
134
There may be some features `configure' can not figure out
135
automatically, but needs to determine by the type of host the package
136
will run on. Usually `configure' can figure that out, but if it prints
137
a message saying it can not guess the host type, give it the
138
`--host=TYPE' option. TYPE can either be a short name for the system
139
type, such as `sun4', or a canonical name with three fields:
142
See the file `config.sub' for the possible values of each field. If
143
`config.sub' isn't included in this package, then this package doesn't
144
need to know the host type.
146
If you are building compiler tools for cross-compiling, you can also
147
use the `--target=TYPE' option to select the type of system they will
148
produce code for and the `--build=TYPE' option to select the type of
149
system on which you are compiling the package.
154
If you want to set default values for `configure' scripts to share,
155
you can create a site shell script called `config.site' that gives
156
default values for variables like `CC', `cache_file', and `prefix'.
157
`configure' looks for `PREFIX/share/config.site' if it exists, then
158
`PREFIX/etc/config.site' if it exists. Or, you can set the
159
`CONFIG_SITE' environment variable to the location of the site script.
160
A warning: not all `configure' scripts look for a site script.
165
`configure' recognizes the following options to control how it
169
Use and save the results of the tests in FILE instead of
170
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
171
debugging `configure'.
174
Print a summary of the options to `configure', and exit.
179
Do not print messages saying which checks are being made. To
180
suppress all normal output, redirect it to `/dev/null' (any error
181
messages will still be shown).
184
Look for the package's source code in directory DIR. Usually
185
`configure' can determine that directory automatically.
188
Print the version of Autoconf used to generate the `configure'
191
`configure' also accepts some other, not widely useful, options.
added
removed
INSTALL
