Skip to content

Commit 0ba2a8a

Browse files
committed
Add generated files for the 1.1 release
Signed-off-by: Christopher Larson <[email protected]>
1 parent e2e03ef commit 0ba2a8a

15 files changed

+35198
-35
lines changed

Diff for: INSTALL

+171-35
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
Installation Instructions
22
*************************
33

4-
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
5-
2006 Free Software Foundation, Inc.
4+
Copyright (C) 1994-1996, 1999-2002, 2004-2011 Free Software Foundation,
5+
Inc.
66

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.
911

1012
Basic Installation
1113
==================
1214

13-
Briefly, the shell commands `./configure; make; make install' should
15+
Briefly, the shell commands `./configure; make; make install' should
1416
configure, build, and install this package. The following
1517
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.
1723

1824
The `configure' shell script attempts to guess correct values for
1925
various system-dependent variables used during compilation. It uses
@@ -42,7 +48,7 @@ may remove or edit it.
4248
you want to change it or regenerate `configure' using a newer version
4349
of `autoconf'.
4450

45-
The simplest way to compile this package is:
51+
The simplest way to compile this package is:
4652

4753
1. `cd' to the directory containing the package's source code and type
4854
`./configure' to configure the package for your system.
@@ -53,12 +59,22 @@ The simplest way to compile this package is:
5359
2. Type `make' to compile the package.
5460

5561
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.
5763

5864
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
6278
source code directory by typing `make clean'. To also remove the
6379
files that `configure' created (so you can compile the package for
6480
a different kind of computer), type `make distclean'. There is
@@ -67,12 +83,22 @@ The simplest way to compile this package is:
6783
all sorts of other programs in order to regenerate files that came
6884
with the distribution.
6985

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+
7096
Compilers and Options
7197
=====================
7298

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.
76102

77103
You can give `configure' initial values for configuration parameters
78104
by setting variables in the command line or in the environment. Here
@@ -85,25 +111,41 @@ is an example:
85111
Compiling For Multiple Architectures
86112
====================================
87113

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
89115
same time, by placing the object files for each architecture in their
90116
own directory. To do this, you can use GNU `make'. `cd' to the
91117
directory where you want the object files and executables to go and run
92118
the `configure' script. `configure' automatically checks for the
93-
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.
94121

95122
With a non-GNU `make', it is safer to compile the package for one
96123
architecture at a time in the source code directory. After you have
97124
installed the package for one architecture, use `make distclean' before
98125
reconfiguring for another architecture.
99126

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+
100141
Installation Names
101142
==================
102143

103-
By default, `make install' installs the package's commands under
144+
By default, `make install' installs the package's commands under
104145
`/usr/local/bin', include files under `/usr/local/include', etc. You
105146
can specify an installation prefix other than `/usr/local' by giving
106-
`configure' the option `--prefix=PREFIX'.
147+
`configure' the option `--prefix=PREFIX', where PREFIX must be an
148+
absolute file name.
107149

108150
You can specify separate installation prefixes for
109151
architecture-specific files and architecture-independent files. If you
@@ -114,16 +156,47 @@ Documentation and other data files still use the regular prefix.
114156
In addition, if you use an unusual directory layout you can give
115157
options like `--bindir=DIR' to specify different values for particular
116158
kinds of files. Run `configure --help' for a list of the directories
117-
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+
=================
118194

119195
If the package supports it, you can cause programs to be installed
120196
with an extra prefix or suffix on their names by giving `configure' the
121197
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
122198

123-
Optional Features
124-
=================
125-
126-
Some packages pay attention to `--enable-FEATURE' options to
199+
Some packages pay attention to `--enable-FEATURE' options to
127200
`configure', where FEATURE indicates an optional part of the package.
128201
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
129202
is something like `gnu-as' or `x' (for the X Window System). The
@@ -135,22 +208,67 @@ find the X include and library files automatically, but if it doesn't,
135208
you can use the `configure' options `--x-includes=DIR' and
136209
`--x-libraries=DIR' to specify their locations.
137210

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+
138255
Specifying the System Type
139256
==========================
140257

141-
There may be some features `configure' cannot figure out automatically,
142-
but needs to determine by the type of machine the package will run on.
143-
Usually, assuming the package is built to be run on the _same_
144-
architectures, `configure' can figure that out, but if it prints a
145-
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
146263
`--build=TYPE' option. TYPE can either be a short name for the system
147264
type, such as `sun4', or a canonical name which has the form:
148265

149266
CPU-COMPANY-SYSTEM
150267

151268
where SYSTEM can have one of these forms:
152269

153-
OS KERNEL-OS
270+
OS
271+
KERNEL-OS
154272

155273
See the file `config.sub' for the possible values of each field. If
156274
`config.sub' isn't included in this package, then this package doesn't
@@ -168,9 +286,9 @@ eventually be run) with `--host=TYPE'.
168286
Sharing Defaults
169287
================
170288

171-
If you want to set default values for `configure' scripts to share, you
172-
can create a site shell script called `config.site' that gives default
173-
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'.
174292
`configure' looks for `PREFIX/share/config.site' if it exists, then
175293
`PREFIX/etc/config.site' if it exists. Or, you can set the
176294
`CONFIG_SITE' environment variable to the location of the site script.
@@ -179,7 +297,7 @@ A warning: not all `configure' scripts look for a site script.
179297
Defining Variables
180298
==================
181299

182-
Variables not defined in a site shell script can be set in the
300+
Variables not defined in a site shell script can be set in the
183301
environment passed to `configure'. However, some packages may run
184302
configure again during the build, and the customized values of these
185303
variables may be lost. In order to avoid this problem, you should set
@@ -198,11 +316,19 @@ an Autoconf bug. Until the bug is fixed you can use this workaround:
198316
`configure' Invocation
199317
======================
200318

201-
`configure' recognizes the following options to control how it operates.
319+
`configure' recognizes the following options to control how it
320+
operates.
202321

203322
`--help'
204323
`-h'
205-
Print a summary of the options to `configure', and exit.
324+
Print a summary of all of the options to `configure', and exit.
325+
326+
`--help=short'
327+
`--help=recursive'
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.
206332

207333
`--version'
208334
`-V'
@@ -229,6 +355,16 @@ an Autoconf bug. Until the bug is fixed you can use this workaround:
229355
Look for the package's source code in directory DIR. Usually
230356
`configure' can determine that directory automatically.
231357

358+
`--prefix=DIR'
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.
362+
363+
`--no-create'
364+
`-n'
365+
Run the configure checks, but stop before creating any output
366+
files.
367+
232368
`configure' also accepts some other, not widely useful, options. Run
233369
`configure --help' for more details.
234370

0 commit comments

Comments
 (0)