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, and a
12file `config.log' containing compiler output (useful mainly for
13debugging `configure').
14
15   It can also use an optional file (typically called `config.cache'
16and enabled with `--cache-file=config.cache' or simply `-C') that saves
17the results of its tests to speed up reconfiguring.  (Caching is
18disabled by default to prevent problems with accidental use of stale
19cache files.)
20
21   If you need to do unusual things to compile the package, please try
22to figure out how `configure' could check whether to do them, and mail
23diffs or instructions to the address given in the `README' so they can
24be considered for the next release.  If you are using the cache, and at
25some point `config.cache' contains results you don't want to keep, you
26may remove or edit it.
27
28   The file `configure.in' is used to create `configure' by a program
29called `autoconf'.  You only need `configure.in' if you want to change
30it or regenerate `configure' using a newer version of `autoconf'.
31
32The simplest way to compile this package is:
33
34  1. `cd' to the directory containing the package's source code and type
35     `./configure' to configure the package for your system.  If you're
36     using `csh' on an old version of System V, you might need to type
37     `sh ./configure' instead to prevent `csh' from trying to execute
38     `configure' itself.
39
40     Running `configure' takes awhile.  While running, it prints some
41     messages telling which features it is checking for.
42
43  2. Type `make' to compile the package.
44
45  3. Optionally, type `make check' to run any self-tests that come with
46     the package.
47
48  4. Type `make install' to install the programs and any data files and
49     documentation.
50
51  5. You can remove the program binaries and object files from the
52     source code directory by typing `make clean'.  To also remove the
53     files that `configure' created (so you can compile the package for
54     a different kind of computer), type `make distclean'.  There is
55     also a `make maintainer-clean' target, but that is intended mainly
56     for the package's developers.  If you use it, you may have to get
57     all sorts of other programs in order to regenerate files that came
58     with the distribution.
59
60Compilers and Options
61=====================
62
63   Some systems require unusual options for compilation or linking that
64the `configure' script does not know about.  Run `./configure --help'
65for details on some of the pertinent environment variables.
66
67   You can give `configure' initial values for variables by setting
68them in the environment.  You can do that on the command line like this:
69
70     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
71
72   *Note Environment Variables::, for more details.
73
74Compiling For Multiple Architectures
75====================================
76
77   You can compile the package for more than one kind of computer at the
78same time, by placing the object files for each architecture in their
79own directory.  To do this, you must use a version of `make' that
80supports the `VPATH' variable, such as GNU `make'.  `cd' to the
81directory where you want the object files and executables to go and run
82the `configure' script.  `configure' automatically checks for the
83source code in the directory that `configure' is in and in `..'.
84
85   If you have to use a `make' that does not support the `VPATH'
86variable, you have to compile the package for one architecture at a time
87in the source code directory.  After you have installed the package for
88one architecture, use `make distclean' before reconfiguring for another
89architecture.
90
91Installation Names
92==================
93
94   By default, `make install' will install the package's files in
95`/usr/local/bin', `/usr/local/man', etc.  You can specify an
96installation prefix other than `/usr/local' by giving `configure' the
97option `--prefix=PATH'.
98
99   You can specify separate installation prefixes for
100architecture-specific files and architecture-independent files.  If you
101give `configure' the option `--exec-prefix=PATH', the package will use
102PATH as the prefix for installing programs and libraries.
103Documentation and other data files will still use the regular prefix.
104
105   In addition, if you use an unusual directory layout you can give
106options like `--bindir=PATH' to specify different values for particular
107kinds of files.  Run `configure --help' for a list of the directories
108you can set and what kinds of files go in them.
109
110   If the package supports it, you can cause programs to be installed
111with an extra prefix or suffix on their names by giving `configure' the
112option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
113
114Optional Features
115=================
116
117   Some packages pay attention to `--enable-FEATURE' options to
118`configure', where FEATURE indicates an optional part of the package.
119They may also pay attention to `--with-PACKAGE' options, where PACKAGE
120is something like `gnu-as' or `x' (for the X Window System).  The
121`README' should mention any `--enable-' and `--with-' options that the
122package recognizes.
123
124   For packages that use the X Window System, `configure' can usually
125find the X include and library files automatically, but if it doesn't,
126you can use the `configure' options `--x-includes=DIR' and
127`--x-libraries=DIR' to specify their locations.
128
129Specifying the System Type
130==========================
131
132   There may be some features `configure' cannot figure out
133automatically, but needs to determine by the type of host the package
134will run on.  Usually `configure' can figure that out, but if it prints
135a message saying it cannot guess the host type, give it the
136`--build=TYPE' option.  TYPE can either be a short name for the system
137type, such as `sun4', or a canonical name which has the form:
138
139     CPU-COMPANY-SYSTEM
140
141where SYSTEM can have one of these forms:
142
143     OS
144     KERNEL-OS
145
146   See the file `config.sub' for the possible values of each field.  If
147`config.sub' isn't included in this package, then this package doesn't
148need to know the host type.
149
150   If you are _building_ compiler tools for cross-compiling, you can
151also use the `--target=TYPE' option to select the type of system they
152will produce code for.
153
154   If you want to _use_ a cross compiler, that generates code for a
155platform different from the build platform, you should specify the host
156platform (i.e., that on which the generated programs will eventually be
157run) with `--host=TYPE'.  In this case, you should also specify the
158build platform with `--build=TYPE', because, in this case, it may not
159be possible to guess the build platform (it sometimes involves
160compiling and running simple test programs, and this can't be done if
161the compiler is a cross compiler).
162
163Sharing Defaults
164================
165
166   If you want to set default values for `configure' scripts to share,
167you can create a site shell script called `config.site' that gives
168default values for variables like `CC', `cache_file', and `prefix'.
169`configure' looks for `PREFIX/share/config.site' if it exists, then
170`PREFIX/etc/config.site' if it exists.  Or, you can set the
171`CONFIG_SITE' environment variable to the location of the site script.
172A warning: not all `configure' scripts look for a site script.
173
174Environment Variables
175=====================
176
177   Variables not defined in a site shell script can be set in the
178environment passed to configure.  However, some packages may run
179configure again during the build, and the customized values of these
180variables may be lost.  In order to avoid this problem, you should set
181them in the `configure' command line, using `VAR=value'.  For example:
182
183     ./configure CC=/usr/local2/bin/gcc
184
185will cause the specified gcc to be used as the C compiler (unless it is
186overridden in the site shell script).
187
188`configure' Invocation
189======================
190
191   `configure' recognizes the following options to control how it
192operates.
193
194`--help'
195`-h'
196     Print a summary of the options to `configure', and exit.
197
198`--version'
199`-V'
200     Print the version of Autoconf used to generate the `configure'
201     script, and exit.
202
203`--cache-file=FILE'
204     Enable the cache: use and save the results of the tests in FILE,
205     traditionally `config.cache'.  FILE defaults to `/dev/null' to
206     disable caching.
207
208`--config-cache'
209`-C'
210     Alias for `--cache-file=config.cache'.
211
212`--quiet'
213`--silent'
214`-q'
215     Do not print messages saying which checks are being made.  To
216     suppress all normal output, redirect it to `/dev/null' (any error
217     messages will still be shown).
218
219`--srcdir=DIR'
220     Look for the package's source code in directory DIR.  Usually
221     `configure' can determine that directory automatically.
222
223`configure' also accepts some other, not widely useful, options.  Run
224`configure --help' for more details.
225
226