1- Copyright 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
2- Foundation, Inc.
1+ Installation Instructions
2+ *************************
33
4- This file is free documentation; the Free Software Foundation gives
5- unlimited permission to copy, distribute and modify it.
4+ Copyright (C) 1994-1996, 1999-2002, 2004-2013 Free Software Foundation,
5+ Inc.
6+
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.
611
712Basic Installation
813==================
914
10- 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.
1123
1224 The `configure' shell script attempts to guess correct values for
1325various system-dependent variables used during compilation. It uses
@@ -20,9 +32,9 @@ debugging `configure').
2032
2133 It can also use an optional file (typically called `config.cache'
2234and enabled with `--cache-file=config.cache' or simply `-C') that saves
23- the results of its tests to speed up reconfiguring. ( Caching is
35+ the results of its tests to speed up reconfiguring. Caching is
2436disabled by default to prevent problems with accidental use of stale
25- cache files.)
37+ cache files.
2638
2739 If you need to do unusual things to compile the package, please try
2840to figure out how `configure' could check whether to do them, and mail
@@ -32,30 +44,37 @@ some point `config.cache' contains results you don't want to keep, you
3244may remove or edit it.
3345
3446 The file `configure.ac' (or `configure.in') is used to create
35- `configure' by a program called `autoconf'. You only need
36- `configure.ac' if you want to change it or regenerate `configure' using
37- 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
49+ of `autoconf'.
3850
39- The simplest way to compile this package is:
51+ The simplest way to compile this package is:
4052
4153 1. `cd' to the directory containing the package's source code and type
42- `./configure' to configure the package for your system. If you're
43- using `csh' on an old version of System V, you might need to type
44- `sh ./configure' instead to prevent `csh' from trying to execute
45- `configure' itself.
54+ `./configure' to configure the package for your system.
4655
47- Running `configure' takes awhile . While running, it prints some
48- 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.
4958
5059 2. Type `make' to compile the package.
5160
5261 3. Optionally, type `make check' to run any self-tests that come with
53- the package.
62+ the package, generally using the just-built uninstalled binaries .
5463
5564 4. Type `make install' to install the programs and any data files and
56- documentation.
57-
58- 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
5978 source code directory by typing `make clean'. To also remove the
6079 files that `configure' created (so you can compile the package for
6180 a different kind of computer), type `make distclean'. There is
@@ -64,6 +83,16 @@ The simplest way to compile this package is:
6483 all sorts of other programs in order to regenerate files that came
6584 with the distribution.
6685
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.
95+
6796Compilers and Options
6897=====================
6998
@@ -75,7 +104,7 @@ for details on some of the pertinent environment variables.
75104by setting variables in the command line or in the environment. Here
76105is an example:
77106
78- ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
107+ ./configure CC=c99 CFLAGS=-g LIBS=-lposix
79108
80109 *Note Defining Variables::, for more details.
81110
@@ -84,44 +113,89 @@ Compiling For Multiple Architectures
84113
85114 You can compile the package for more than one kind of computer at the
86115same time, by placing the object files for each architecture in their
87- own directory. To do this, you must use a version of `make' that
88- 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
89117directory where you want the object files and executables to go and run
90118the `configure' script. `configure' automatically checks for the
91- 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.
121+
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.
92126
93- If you have to use a `make' that does not support the `VPATH'
94- variable, you have to compile the package for one architecture at a
95- time in the source code directory. After you have installed the
96- package for one architecture, use `make distclean' before reconfiguring
97- 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
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.
98140
99141Installation Names
100142==================
101143
102- By default, `make install' will install the package's files in
103- `/usr/local/bin', `/usr/local/man', etc. You can specify an
104- installation prefix other than `/usr/local' by giving `configure' the
105- option `--prefix=PATH'.
144+ By default, `make install' installs the package's commands under
145+ `/usr/local/bin', include files under `/usr/local/include', etc. You
146+ can specify an installation prefix other than `/usr/local' by giving
147+ `configure' the option `--prefix=PREFIX', where PREFIX must be an
148+ absolute file name.
106149
107150 You can specify separate installation prefixes for
108151architecture-specific files and architecture-independent files. If you
109- give `configure' the option `--exec-prefix=PATH' , the package will use
110- PATH as the prefix for installing programs and libraries.
111- Documentation and other data files will still use the regular prefix.
152+ pass the option `--exec-prefix=PREFIX' to `configure' , the package uses
153+ PREFIX as the prefix for installing programs and libraries.
154+ Documentation and other data files still use the regular prefix.
112155
113156 In addition, if you use an unusual directory layout you can give
114- options like `--bindir=PATH ' to specify different values for particular
157+ options like `--bindir=DIR ' to specify different values for particular
115158kinds of files. Run `configure --help' for a list of the directories
116- 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+ =================
117194
118195 If the package supports it, you can cause programs to be installed
119196with an extra prefix or suffix on their names by giving `configure' the
120197option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
121198
122- Optional Features
123- =================
124-
125199 Some packages pay attention to `--enable-FEATURE' options to
126200`configure', where FEATURE indicates an optional part of the package.
127201They may also pay attention to `--with-PACKAGE' options, where PACKAGE
@@ -134,6 +208,50 @@ find the X include and library files automatically, but if it doesn't,
134208you can use the `configure' options `--x-includes=DIR' and
135209`--x-libraries=DIR' to specify their locations.
136210
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+ 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'
232+ instead.
233+
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
237+ to try
238+
239+ ./configure CC="cc"
240+
241+ and if that doesn't work, try
242+
243+ ./configure CC="cc -nodtk"
244+
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'.
249+
250+ On Haiku, software installed for all users goes in `/boot/common',
251+ not `/usr/local'. It is recommended to use the following options:
252+
253+ ./configure --prefix=/boot/common
254+
137255Specifying the System Type
138256==========================
139257
@@ -149,14 +267,15 @@ type, such as `sun4', or a canonical name which has the form:
149267
150268where SYSTEM can have one of these forms:
151269
152- OS KERNEL-OS
270+ OS
271+ KERNEL-OS
153272
154273 See the file `config.sub' for the possible values of each field. If
155274`config.sub' isn't included in this package, then this package doesn't
156275need to know the machine type.
157276
158277 If you are _building_ compiler tools for cross-compiling, you should
159- use the `--target=TYPE' option to select the type of system they will
278+ use the option `--target=TYPE' to select the type of system they will
160279produce code for.
161280
162281 If you want to _use_ a cross compiler, that generates code for a
@@ -186,9 +305,15 @@ them in the `configure' command line, using `VAR=value'. For example:
186305
187306 ./configure CC=/usr/local2/bin/gcc
188307
189- will cause the specified gcc to be used as the C compiler (unless it is
308+ causes the specified ` gcc' to be used as the C compiler (unless it is
190309overridden in the site shell script).
191310
311+ Unfortunately, this technique does not work for `CONFIG_SHELL' due to
312+ an Autoconf limitation. Until the limitation is lifted, you can use
313+ this workaround:
314+
315+ CONFIG_SHELL=/bin/bash ./configure CONFIG_SHELL=/bin/bash
316+
192317`configure' Invocation
193318======================
194319
@@ -197,7 +322,14 @@ operates.
197322
198323`--help'
199324`-h'
200- Print a summary of the options to `configure', and exit.
325+ Print a summary of all of the options to `configure', and exit.
326+
327+ `--help=short'
328+ `--help=recursive'
329+ Print a summary of the options unique to this package's
330+ `configure', and exit. The `short' variant lists options used
331+ only in the top level, while the `recursive' variant lists options
332+ also present in any nested packages.
201333
202334`--version'
203335`-V'
@@ -224,6 +356,15 @@ operates.
224356 Look for the package's source code in directory DIR. Usually
225357 `configure' can determine that directory automatically.
226358
359+ `--prefix=DIR'
360+ Use DIR as the installation prefix. *note Installation Names::
361+ for more details, including other options available for fine-tuning
362+ the installation locations.
363+
364+ `--no-create'
365+ `-n'
366+ Run the configure checks, but stop before creating any output
367+ files.
368+
227369`configure' also accepts some other, not widely useful, options. Run
228370`configure --help' for more details.
229-
0 commit comments