1
1
Installation Instructions
2
2
*************************
4
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
5
Software Foundation, Inc.
4
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
5
2006, 2007, 2008, 2009 Free Software Foundation, Inc.
7
This file is free documentation; the Free Software Foundation gives
8
unlimited permission to copy, distribute and modify it.
7
Copying and distribution of this file, with or without modification,
8
are permitted in any medium without royalty provided the copyright
9
notice and this notice are preserved. This file is offered as-is,
10
without warranty of any kind.
13
These are generic installation instructions.
15
Briefly, the shell commands `./configure; make; make install' should
16
configure, build, and install this package. The following
17
more-detailed instructions are generic; see the `README' file for
18
instructions specific to this package. Some packages provide this
19
`INSTALL' file but do not implement all of the features documented
20
below. The lack of an optional feature in a given package is not
21
necessarily a bug. More recommendations for GNU packages can be found
22
in *note Makefile Conventions: (standards)Makefile Conventions.
15
24
The `configure' shell script attempts to guess correct values for
16
25
various system-dependent variables used during compilation. It uses
35
44
may remove or edit it.
37
46
The file `configure.ac' (or `configure.in') is used to create
38
`configure' by a program called `autoconf'. You only need
39
`configure.ac' if you want to change it or regenerate `configure' using
40
a newer version of `autoconf'.
47
`configure' by a program called `autoconf'. You need `configure.ac' if
48
you want to change it or regenerate `configure' using a newer version
42
The simplest way to compile this package is:
51
The simplest way to compile this package is:
44
53
1. `cd' to the directory containing the package's source code and type
45
`./configure' to configure the package for your system. If you're
46
using `csh' on an old version of System V, you might need to type
47
`sh ./configure' instead to prevent `csh' from trying to execute
54
`./configure' to configure the package for your system.
50
Running `configure' takes awhile. While running, it prints some
51
messages telling which features it is checking for.
56
Running `configure' might take a while. While running, it prints
57
some messages telling which features it is checking for.
53
59
2. Type `make' to compile the package.
55
61
3. Optionally, type `make check' to run any self-tests that come with
62
the package, generally using the just-built uninstalled binaries.
58
64
4. Type `make install' to install the programs and any data files and
61
5. You can remove the program binaries and object files from the
65
documentation. When installing into a prefix owned by root, it is
66
recommended that the package be configured and built as a regular
67
user, and only the `make install' phase executed with root
70
5. Optionally, type `make installcheck' to repeat any self-tests, but
71
this time using the binaries in their final installed location.
72
This target does not install anything. Running this target as a
73
regular user, particularly if the prior `make install' required
74
root privileges, verifies that the installation completed
77
6. You can remove the program binaries and object files from the
62
78
source code directory by typing `make clean'. To also remove the
63
79
files that `configure' created (so you can compile the package for
64
80
a different kind of computer), type `make distclean'. There is
67
83
all sorts of other programs in order to regenerate files that came
68
84
with the distribution.
86
7. Often, you can also type `make uninstall' to remove the installed
87
files again. In practice, not all packages have tested that
88
uninstallation works correctly, even though it is required by the
91
8. Some packages, particularly those that use Automake, provide `make
92
distcheck', which can by used by developers to test that all other
93
targets like `make install' and `make uninstall' work correctly.
94
This target is generally not run by end users.
70
96
Compilers and Options
71
97
=====================
73
Some systems require unusual options for compilation or linking that the
74
`configure' script does not know about. Run `./configure --help' for
75
details on some of the pertinent environment variables.
99
Some systems require unusual options for compilation or linking that
100
the `configure' script does not know about. Run `./configure --help'
101
for details on some of the pertinent environment variables.
77
103
You can give `configure' initial values for configuration parameters
78
104
by setting variables in the command line or in the environment. Here
81
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
107
./configure CC=c99 CFLAGS=-g LIBS=-lposix
83
109
*Note Defining Variables::, for more details.
85
111
Compiling For Multiple Architectures
86
112
====================================
88
You can compile the package for more than one kind of computer at the
114
You can compile the package for more than one kind of computer at the
89
115
same time, by placing the object files for each architecture in their
90
own directory. To do this, you must use a version of `make' that
91
supports the `VPATH' variable, such as GNU `make'. `cd' to the
116
own directory. To do this, you can use GNU `make'. `cd' to the
92
117
directory where you want the object files and executables to go and run
93
118
the `configure' script. `configure' automatically checks for the
94
source code in the directory that `configure' is in and in `..'.
96
If you have to use a `make' that does not support the `VPATH'
97
variable, you have to compile the package for one architecture at a
98
time in the source code directory. After you have installed the
99
package for one architecture, use `make distclean' before reconfiguring
100
for another architecture.
119
source code in the directory that `configure' is in and in `..'. This
120
is known as a "VPATH" build.
122
With a non-GNU `make', it is safer to compile the package for one
123
architecture at a time in the source code directory. After you have
124
installed the package for one architecture, use `make distclean' before
125
reconfiguring for another architecture.
127
On MacOS X 10.5 and later systems, you can create libraries and
128
executables that work on multiple system types--known as "fat" or
129
"universal" binaries--by specifying multiple `-arch' options to the
130
compiler but only a single `-arch' option to the preprocessor. Like
133
./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
134
CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
135
CPP="gcc -E" CXXCPP="g++ -E"
137
This is not guaranteed to produce working output in all cases, you
138
may have to build one architecture at a time and combine the results
139
using the `lipo' tool if you have problems.
102
141
Installation Names
103
142
==================
105
By default, `make install' installs the package's commands under
144
By default, `make install' installs the package's commands under
106
145
`/usr/local/bin', include files under `/usr/local/include', etc. You
107
146
can specify an installation prefix other than `/usr/local' by giving
108
`configure' the option `--prefix=PREFIX'.
147
`configure' the option `--prefix=PREFIX', where PREFIX must be an
110
150
You can specify separate installation prefixes for
111
151
architecture-specific files and architecture-independent files. If you
116
156
In addition, if you use an unusual directory layout you can give
117
157
options like `--bindir=DIR' to specify different values for particular
118
158
kinds of files. Run `configure --help' for a list of the directories
119
you can set and what kinds of files go in them.
159
you can set and what kinds of files go in them. In general, the
160
default for these options is expressed in terms of `${prefix}', so that
161
specifying just `--prefix' will affect all of the other directory
162
specifications that were not explicitly provided.
164
The most portable way to affect installation locations is to pass the
165
correct locations to `configure'; however, many packages provide one or
166
both of the following shortcuts of passing variable assignments to the
167
`make install' command line to change installation locations without
168
having to reconfigure or recompile.
170
The first method involves providing an override variable for each
171
affected directory. For example, `make install
172
prefix=/alternate/directory' will choose an alternate location for all
173
directory configuration variables that were expressed in terms of
174
`${prefix}'. Any directories that were specified during `configure',
175
but not in terms of `${prefix}', must each be overridden at install
176
time for the entire installation to be relocated. The approach of
177
makefile variable overrides for each directory variable is required by
178
the GNU Coding Standards, and ideally causes no recompilation.
179
However, some platforms have known limitations with the semantics of
180
shared libraries that end up requiring recompilation when using this
181
method, particularly noticeable in packages that use GNU Libtool.
183
The second method involves providing the `DESTDIR' variable. For
184
example, `make install DESTDIR=/alternate/directory' will prepend
185
`/alternate/directory' before all installation names. The approach of
186
`DESTDIR' overrides is not required by the GNU Coding Standards, and
187
does not work on platforms that have drive letters. On the other hand,
188
it does better at avoiding recompilation issues, and works well even
189
when some directory options were not specified in terms of `${prefix}'
121
195
If the package supports it, you can cause programs to be installed
122
196
with an extra prefix or suffix on their names by giving `configure' the
123
197
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
128
Some packages pay attention to `--enable-FEATURE' options to
199
Some packages pay attention to `--enable-FEATURE' options to
129
200
`configure', where FEATURE indicates an optional part of the package.
130
201
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
131
202
is something like `gnu-as' or `x' (for the X Window System). The
137
208
you can use the `configure' options `--x-includes=DIR' and
138
209
`--x-libraries=DIR' to specify their locations.
211
Some packages offer the ability to configure how verbose the
212
execution of `make' will be. For these packages, running `./configure
213
--enable-silent-rules' sets the default to minimal output, which can be
214
overridden with `make V=1'; while running `./configure
215
--disable-silent-rules' sets the default to verbose, which can be
216
overridden with `make V=0'.
221
On HP-UX, the default C compiler is not ANSI C compatible. If GNU
222
CC is not installed, it is recommended to use the following options in
223
order to use an ANSI C compiler:
225
./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
227
and if that doesn't work, install pre-built binaries of GCC for HP-UX.
229
On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
230
parse its `<wchar.h>' header file. The option `-nodtk' can be used as
231
a workaround. If GNU CC is not installed, it is therefore recommended
236
and if that doesn't work, try
238
./configure CC="cc -nodtk"
240
On Solaris, don't put `/usr/ucb' early in your `PATH'. This
241
directory contains several dysfunctional programs; working variants of
242
these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
243
in your `PATH', put it _after_ `/usr/bin'.
245
On Haiku, software installed for all users goes in `/boot/common',
246
not `/usr/local'. It is recommended to use the following options:
248
./configure --prefix=/boot/common
140
250
Specifying the System Type
141
251
==========================
143
There may be some features `configure' cannot figure out automatically,
144
but needs to determine by the type of machine the package will run on.
145
Usually, assuming the package is built to be run on the _same_
146
architectures, `configure' can figure that out, but if it prints a
147
message saying it cannot guess the machine type, give it the
253
There may be some features `configure' cannot figure out
254
automatically, but needs to determine by the type of machine the package
255
will run on. Usually, assuming the package is built to be run on the
256
_same_ architectures, `configure' can figure that out, but if it prints
257
a message saying it cannot guess the machine type, give it the
148
258
`--build=TYPE' option. TYPE can either be a short name for the system
149
259
type, such as `sun4', or a canonical name which has the form:
173
If you want to set default values for `configure' scripts to share, you
174
can create a site shell script called `config.site' that gives default
175
values for variables like `CC', `cache_file', and `prefix'.
284
If you want to set default values for `configure' scripts to share,
285
you can create a site shell script called `config.site' that gives
286
default values for variables like `CC', `cache_file', and `prefix'.
176
287
`configure' looks for `PREFIX/share/config.site' if it exists, then
177
288
`PREFIX/etc/config.site' if it exists. Or, you can set the
178
289
`CONFIG_SITE' environment variable to the location of the site script.
190
301
./configure CC=/usr/local2/bin/gcc
192
303
causes the specified `gcc' to be used as the C compiler (unless it is
193
overridden in the site shell script). Here is a another example:
195
/bin/bash ./configure CONFIG_SHELL=/bin/bash
197
Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
198
configuration-related scripts to be executed by `/bin/bash'.
304
overridden in the site shell script).
306
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
307
an Autoconf bug. Until the bug is fixed you can use this workaround:
309
CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
200
311
`configure' Invocation
201
312
======================
203
`configure' recognizes the following options to control how it operates.
314
`configure' recognizes the following options to control how it
207
Print a summary of the options to `configure', and exit.
319
Print a summary of all of the options to `configure', and exit.
323
Print a summary of the options unique to this package's
324
`configure', and exit. The `short' variant lists options used
325
only in the top level, while the `recursive' variant lists options
326
also present in any nested packages.
added
removed
INSTALL
