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 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 by setting them in the environment.  Using
60a Bourne-compatible shell, you can do that on the command line like
61this:
62     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
63
64Or on systems that have the `env' program, you can do it like this:
65     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
66
67Compiling For Multiple Architectures
68====================================
69
70   You can compile the package for more than one kind of computer at the
71same time, by placing the object files for each architecture in their
72own directory.  To do this, you must use a version of `make' that
73supports the `VPATH' variable, such as GNU `make'.  `cd' to the
74directory where you want the object files and executables to go and run
75the `configure' script.  `configure' automatically checks for the
76source code in the directory that `configure' is in and in `..'.
77
78   If you have to use a `make' that does not supports the `VPATH'
79variable, you have to compile the package for one architecture at a time
80in the source code directory.  After you have installed the package for
81one architecture, use `make distclean' before reconfiguring for another
82architecture.
83
84   On MacOS X 10.5 and later systems, you can create libraries and
85executables that work on multiple system types--known as "fat" or
86"universal" binaries--by specifying multiple '-arch' options to the
87compiler but only a single '-arch' option to the preprocessor.  Like
88this:
89
90     ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
91                 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
92                 CPP="gcc -E" CXXCPP="g++ -E"
93
94   This is not guaranteed to produce working output in all cases.  You
95may have to build one architecture at a time and combine the results
96using the 'lipo' tool if you have problems.
97
98Installation Names
99==================
100
101   By default, `make install' will install the package's files in
102`/usr/local/bin', `/usr/local/man', etc.  You can specify an
103installation prefix other than `/usr/local' by giving `configure' the
104option `--prefix=PATH'.
105
106   You can specify separate installation prefixes for
107architecture-specific files and architecture-independent files.  If you
108give `configure' the option `--exec-prefix=PATH', the package will use
109PATH as the prefix for installing programs and libraries.
110Documentation and other data files will still use the regular prefix.
111
112   In addition, if you use an unusual directory layout you can give
113options like `--bindir=PATH' to specify different values for particular
114kinds of files.  Run `configure --help' for a list of the directories
115you can set and what kinds of files go in them.
116
117   If the package supports it, you can cause programs to be installed
118with an extra prefix or suffix on their names by giving `configure' the
119option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
120
121Optional Features
122=================
123
124   Some packages pay attention to `--enable-FEATURE' options to
125`configure', where FEATURE indicates an optional part of the package.
126They may also pay attention to `--with-PACKAGE' options, where PACKAGE
127is something like `gnu-as' or `x' (for the X Window System).  The
128`README' should mention any `--enable-' and `--with-' options that the
129package recognizes.
130
131   For packages that use the X Window System, `configure' can usually
132find the X include and library files automatically, but if it doesn't,
133you can use the `configure' options `--x-includes=DIR' and
134`--x-libraries=DIR' to specify their locations.
135
136   For packages that use the GNU libiconv library, you can use the
137`configure' option `--with-libiconv-prefix' to specify the prefix you
138used while installing libiconv.
139
140Particular Systems
141==================
142
143   On HP-UX, the default C compiler is not ANSI C compatible.  If GNU CC
144is not installed, it is recommended to use the following options in order
145to use an ANSI C compiler:
146
147     ./configure CC="cc -Ae"
148
149and if that doesn't work, install pre-built binaries of GCC for HP-UX.
150
151   On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
152parse its `<wchar.h>' header file.  The option `-nodtk' can be used as
153a workaround.  If GNU CC is not installed, it is therefore recommended
154to try
155
156     ./configure CC="cc"
157
158and if that doesn't work, try
159
160     ./configure CC="cc -nodtk"
161
162   On AIX 3, the C include files by default don't define some necessary
163prototype declarations.  If GNU CC is not installed, it is recommended to
164use the following options:
165
166     ./configure CC="xlc -D_ALL_SOURCE"
167
168   On BeOS, user installed software goes in /boot/home/config, not
169/usr/local.  It is recommended to use the following options:
170
171     ./configure --prefix=/boot/home/config
172
173Specifying the System Type
174==========================
175
176   There may be some features `configure' can not figure out
177automatically, but needs to determine by the type of host the package
178will run on.  Usually `configure' can figure that out, but if it prints
179a message saying it can not guess the host type, give it the
180`--host=TYPE' option.  TYPE can either be a short name for the system
181type, such as `sun4', or a canonical name with three fields:
182     CPU-COMPANY-SYSTEM
183
184See the file `config.sub' for the possible values of each field.  If
185`config.sub' isn't included in this package, then this package doesn't
186need to know the host type.
187
188   If you are building compiler tools for cross-compiling, you can also
189use the `--target=TYPE' option to select the type of system they will
190produce code for and the `--build=TYPE' option to select the type of
191system on which you are compiling the package.
192
193Sharing Defaults
194================
195
196   If you want to set default values for `configure' scripts to share,
197you can create a site shell script called `config.site' that gives
198default values for variables like `CC', `cache_file', and `prefix'.
199`configure' looks for `PREFIX/share/config.site' if it exists, then
200`PREFIX/etc/config.site' if it exists.  Or, you can set the
201`CONFIG_SITE' environment variable to the location of the site script.
202A warning: not all `configure' scripts look for a site script.
203
204Operation Controls
205==================
206
207   `configure' recognizes the following options to control how it
208operates.
209
210`--cache-file=FILE'
211     Use and save the results of the tests in FILE instead of
212     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
213     debugging `configure'.
214
215`--help'
216     Print a summary of the options to `configure', and exit.
217
218`--quiet'
219`--silent'
220`-q'
221     Do not print messages saying which checks are being made.  To
222     suppress all normal output, redirect it to `/dev/null' (any error
223     messages will still be shown).
224
225`--srcdir=DIR'
226     Look for the package's source code in directory DIR.  Usually
227     `configure' can determine that directory automatically.
228
229`--version'
230     Print the version of Autoconf used to generate the `configure'
231     script, and exit.
232
233`configure' also accepts some other, not widely useful, options.
234
235