2
2
*************************
4
4
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
5
2006, 2007, 2008 Free Software Foundation, Inc.
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
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
=====================
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
120
144
By default, `make install' installs the package's commands under
121
145
`/usr/local/bin', include files under `/usr/local/include', etc. You
122
146
can specify an installation prefix other than `/usr/local' by giving
123
`configure' the option `--prefix=PREFIX'.
147
`configure' the option `--prefix=PREFIX', where PREFIX must be an
125
150
You can specify separate installation prefixes for
126
151
architecture-specific files and architecture-independent files. If you
131
156
In addition, if you use an unusual directory layout you can give
132
157
options like `--bindir=DIR' to specify different values for particular
133
158
kinds of files. Run `configure --help' for a list of the directories
134
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}'
136
195
If the package supports it, you can cause programs to be installed
137
196
with an extra prefix or suffix on their names by giving `configure' the
138
197
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
143
199
Some packages pay attention to `--enable-FEATURE' options to
144
200
`configure', where FEATURE indicates an optional part of the package.
145
201
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
152
208
you can use the `configure' options `--x-includes=DIR' and
153
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'.
155
218
Particular systems
156
219
==================
175
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
177
250
Specifying the System Type
178
251
==========================