1
1
Installation Instructions
2
2
*************************
4
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
5
2006, 2007 Free Software Foundation, Inc.
4
Copyright (C) 1994-1996, 1999-2002, 2004-2011 Free Software Foundation,
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
Briefly, the shell commands `./configure; make; make install' should
15
Briefly, the shell commands `./configure; make; make install' should
14
16
configure, build, and install this package. The following
15
17
more-detailed instructions are generic; see the `README' file for
16
instructions specific to this package.
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.
18
24
The `configure' shell script attempts to guess correct values for
19
25
various system-dependent variables used during compilation. It uses
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.
70
6. Often, you can also type `make uninstall' to remove the installed
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.
73
96
Compilers and Options
74
97
=====================
76
Some systems require unusual options for compilation or linking that the
77
`configure' script does not know about. Run `./configure --help' for
78
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.
80
103
You can give `configure' initial values for configuration parameters
81
104
by setting variables in the command line or in the environment. Here
88
111
Compiling For Multiple Architectures
89
112
====================================
91
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
92
115
same time, by placing the object files for each architecture in their
93
116
own directory. To do this, you can use GNU `make'. `cd' to the
94
117
directory where you want the object files and executables to go and run
95
118
the `configure' script. `configure' automatically checks for the
96
source code in the directory that `configure' is in and in `..'.
119
source code in the directory that `configure' is in and in `..'. This
120
is known as a "VPATH" build.
98
122
With a non-GNU `make', it is safer to compile the package for one
99
123
architecture at a time in the source code directory. After you have
100
124
installed the package for one architecture, use `make distclean' before
101
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.
103
141
Installation Names
104
142
==================
106
By default, `make install' installs the package's commands under
144
By default, `make install' installs the package's commands under
107
145
`/usr/local/bin', include files under `/usr/local/include', etc. You
108
146
can specify an installation prefix other than `/usr/local' by giving
109
`configure' the option `--prefix=PREFIX'.
147
`configure' the option `--prefix=PREFIX', where PREFIX must be an
111
150
You can specify separate installation prefixes for
112
151
architecture-specific files and architecture-independent files. If you
117
156
In addition, if you use an unusual directory layout you can give
118
157
options like `--bindir=DIR' to specify different values for particular
119
158
kinds of files. Run `configure --help' for a list of the directories
120
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}'
122
195
If the package supports it, you can cause programs to be installed
123
196
with an extra prefix or suffix on their names by giving `configure' the
124
197
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
129
Some packages pay attention to `--enable-FEATURE' options to
199
Some packages pay attention to `--enable-FEATURE' options to
130
200
`configure', where FEATURE indicates an optional part of the package.
131
201
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
132
202
is something like `gnu-as' or `x' (for the X Window System). The
138
208
you can use the `configure' options `--x-includes=DIR' and
139
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
HP-UX `make' updates targets which have the same time stamps as
230
their prerequisites, which makes it generally unusable when shipped
231
generated files such as `configure' are involved. Use GNU `make'
234
On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
235
parse its `<wchar.h>' header file. The option `-nodtk' can be used as
236
a workaround. If GNU CC is not installed, it is therefore recommended
241
and if that doesn't work, try
243
./configure CC="cc -nodtk"
245
On Solaris, don't put `/usr/ucb' early in your `PATH'. This
246
directory contains several dysfunctional programs; working variants of
247
these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
248
in your `PATH', put it _after_ `/usr/bin'.
250
On Haiku, software installed for all users goes in `/boot/common',
251
not `/usr/local'. It is recommended to use the following options:
253
./configure --prefix=/boot/common
141
255
Specifying the System Type
142
256
==========================
144
There may be some features `configure' cannot figure out automatically,
145
but needs to determine by the type of machine the package will run on.
146
Usually, assuming the package is built to be run on the _same_
147
architectures, `configure' can figure that out, but if it prints a
148
message saying it cannot guess the machine type, give it the
258
There may be some features `configure' cannot figure out
259
automatically, but needs to determine by the type of machine the package
260
will run on. Usually, assuming the package is built to be run on the
261
_same_ architectures, `configure' can figure that out, but if it prints
262
a message saying it cannot guess the machine type, give it the
149
263
`--build=TYPE' option. TYPE can either be a short name for the system
150
264
type, such as `sun4', or a canonical name which has the form:
174
If you want to set default values for `configure' scripts to share, you
175
can create a site shell script called `config.site' that gives default
176
values for variables like `CC', `cache_file', and `prefix'.
289
If you want to set default values for `configure' scripts to share,
290
you can create a site shell script called `config.site' that gives
291
default values for variables like `CC', `cache_file', and `prefix'.
177
292
`configure' looks for `PREFIX/share/config.site' if it exists, then
178
293
`PREFIX/etc/config.site' if it exists. Or, you can set the
179
294
`CONFIG_SITE' environment variable to the location of the site script.
201
316
`configure' Invocation
202
317
======================
204
`configure' recognizes the following options to control how it operates.
319
`configure' recognizes the following options to control how it
208
Print a summary of the options to `configure', and exit.
324
Print a summary of all of the options to `configure', and exit.
328
Print a summary of the options unique to this package's
329
`configure', and exit. The `short' variant lists options used
330
only in the top level, while the `recursive' variant lists options
331
also present in any nested packages.
232
355
Look for the package's source code in directory DIR. Usually
233
356
`configure' can determine that directory automatically.
359
Use DIR as the installation prefix. *note Installation Names::
360
for more details, including other options available for fine-tuning
361
the installation locations.
365
Run the configure checks, but stop before creating any output
235
368
`configure' also accepts some other, not widely useful, options. Run
236
369
`configure --help' for more details.
added
removed
INSTALL
