@@ -2,18 +2,24 @@ Installation Instructions
2
2
*************************
3
3
4
4
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
5
- 2006, 2007 Free Software Foundation, Inc.
5
+ 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6
6
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.
9
11
10
12
Basic Installation
11
13
==================
12
14
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.
17
23
18
24
The `configure' shell script attempts to guess correct values for
19
25
various system-dependent variables used during compilation. It uses
@@ -42,7 +48,7 @@ may remove or edit it.
42
48
you want to change it or regenerate `configure' using a newer version
43
49
of `autoconf'.
44
50
45
- The simplest way to compile this package is:
51
+ The simplest way to compile this package is:
46
52
47
53
1. `cd' to the directory containing the package's source code and type
48
54
`./configure' to configure the package for your system.
@@ -53,12 +59,22 @@ The simplest way to compile this package is:
53
59
2. Type `make' to compile the package.
54
60
55
61
3. Optionally, type `make check' to run any self-tests that come with
56
- the package.
62
+ the package, generally using the just-built uninstalled binaries .
57
63
58
64
4. Type `make install' to install the programs and any data files and
59
- documentation.
60
-
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
68
+ privileges.
69
+
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
75
+ correctly.
76
+
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,15 +83,22 @@ The simplest way to compile this package is:
67
83
all sorts of other programs in order to regenerate files that came
68
84
with the distribution.
69
85
70
- 6. Often, you can also type `make uninstall' to remove the installed
71
- files again.
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
89
+ GNU Coding Standards.
90
+
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.
72
95
73
96
Compilers and Options
74
97
=====================
75
98
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.
79
102
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,25 +111,41 @@ is an example:
88
111
Compiling For Multiple Architectures
89
112
====================================
90
113
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.
97
121
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.
102
126
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
131
+ this:
132
+
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"
136
+
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.
140
+
103
141
Installation Names
104
142
==================
105
143
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
148
+ absolute file name.
110
149
111
150
You can specify separate installation prefixes for
112
151
architecture-specific files and architecture-independent files. If you
@@ -117,16 +156,47 @@ Documentation and other data files still use the regular prefix.
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.
163
+
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.
169
+
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.
182
+
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}'
190
+ at `configure' time.
191
+
192
+ Optional Features
193
+ =================
121
194
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'.
125
198
126
- Optional Features
127
- =================
128
-
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,22 +208,62 @@ find the X include and library files automatically, but if it doesn't,
138
208
you can use the `configure' options `--x-includes=DIR' and
139
209
`--x-libraries=DIR' to specify their locations.
140
210
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'.
217
+
218
+ Particular systems
219
+ ==================
220
+
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:
224
+
225
+ ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
226
+
227
+ and if that doesn't work, install pre-built binaries of GCC for HP-UX.
228
+
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
232
+ to try
233
+
234
+ ./configure CC="cc"
235
+
236
+ and if that doesn't work, try
237
+
238
+ ./configure CC="cc -nodtk"
239
+
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'.
244
+
245
+ On Haiku, software installed for all users goes in `/boot/common',
246
+ not `/usr/local'. It is recommended to use the following options:
247
+
248
+ ./configure --prefix=/boot/common
249
+
141
250
Specifying the System Type
142
251
==========================
143
252
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
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
149
258
`--build=TYPE' option. TYPE can either be a short name for the system
150
259
type, such as `sun4', or a canonical name which has the form:
151
260
152
261
CPU-COMPANY-SYSTEM
153
262
154
263
where SYSTEM can have one of these forms:
155
264
156
- OS KERNEL-OS
265
+ OS
266
+ KERNEL-OS
157
267
158
268
See the file `config.sub' for the possible values of each field. If
159
269
`config.sub' isn't included in this package, then this package doesn't
@@ -171,9 +281,9 @@ eventually be run) with `--host=TYPE'.
171
281
Sharing Defaults
172
282
================
173
283
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'.
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'.
177
287
`configure' looks for `PREFIX/share/config.site' if it exists, then
178
288
`PREFIX/etc/config.site' if it exists. Or, you can set the
179
289
`CONFIG_SITE' environment variable to the location of the site script.
@@ -182,7 +292,7 @@ A warning: not all `configure' scripts look for a site script.
182
292
Defining Variables
183
293
==================
184
294
185
- Variables not defined in a site shell script can be set in the
295
+ Variables not defined in a site shell script can be set in the
186
296
environment passed to `configure'. However, some packages may run
187
297
configure again during the build, and the customized values of these
188
298
variables may be lost. In order to avoid this problem, you should set
@@ -201,11 +311,19 @@ an Autoconf bug. Until the bug is fixed you can use this workaround:
201
311
`configure' Invocation
202
312
======================
203
313
204
- `configure' recognizes the following options to control how it operates.
314
+ `configure' recognizes the following options to control how it
315
+ operates.
205
316
206
317
`--help'
207
318
`-h'
208
- Print a summary of the options to `configure', and exit.
319
+ Print a summary of all of the options to `configure', and exit.
320
+
321
+ `--help=short'
322
+ `--help=recursive'
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.
209
327
210
328
`--version'
211
329
`-V'
@@ -232,6 +350,16 @@ an Autoconf bug. Until the bug is fixed you can use this workaround:
232
350
Look for the package's source code in directory DIR. Usually
233
351
`configure' can determine that directory automatically.
234
352
353
+ `--prefix=DIR'
354
+ Use DIR as the installation prefix. *note Installation Names::
355
+ for more details, including other options available for fine-tuning
356
+ the installation locations.
357
+
358
+ `--no-create'
359
+ `-n'
360
+ Run the configure checks, but stop before creating any output
361
+ files.
362
+
235
363
`configure' also accepts some other, not widely useful, options. Run
236
364
`configure --help' for more details.
237
365
0 commit comments