1
- $Id$
2
- $URL$
1
+ Installation Instructions
2
+ *************************
3
3
4
+ Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
5
+ 2006, 2007 Free Software Foundation, Inc.
6
+
7
+ This file is free documentation; the Free Software Foundation gives
8
+ unlimited permission to copy, distribute and modify it.
4
9
5
10
Basic Installation
6
11
==================
7
12
8
- These are generic installation instructions.
13
+ Briefly, the shell commands `./configure; make; make install' should
14
+ configure, build, and install this package. The following
15
+ more-detailed instructions are generic; see the `README' file for
16
+ instructions specific to this package.
9
17
10
18
The `configure' shell script attempts to guess correct values for
11
19
various system-dependent variables used during compilation. It uses
12
20
those values to create a `Makefile' in each directory of the package.
13
21
It may also create one or more `.h' files containing system-dependent
14
22
definitions. Finally, it creates a shell script `config.status' that
15
- you can run in the future to recreate the current configuration, a file
16
- `config.cache' that saves the results of its tests to speed up
17
- reconfiguring, and a file `config.log' containing compiler output
18
- (useful mainly for debugging `configure').
23
+ you can run in the future to recreate the current configuration, and a
24
+ file `config.log' containing compiler output (useful mainly for
25
+ debugging `configure').
26
+
27
+ It can also use an optional file (typically called `config.cache'
28
+ and enabled with `--cache-file=config.cache' or simply `-C') that saves
29
+ the results of its tests to speed up reconfiguring. Caching is
30
+ disabled by default to prevent problems with accidental use of stale
31
+ cache files.
19
32
20
33
If you need to do unusual things to compile the package, please try
21
34
to figure out how `configure' could check whether to do them, and mail
22
35
diffs or instructions to the address given in the `README' so they can
23
- be considered for the next release. If at some point `config.cache'
24
- contains results you don't want to keep, you may remove or edit it.
36
+ be considered for the next release. If you are using the cache, and at
37
+ some point `config.cache' contains results you don't want to keep, you
38
+ may remove or edit it.
25
39
26
- The file `configure.in' is used to create `configure' by a program
27
- called `autoconf'. You only need `configure.in' if you want to change
28
- it or regenerate `configure' using a newer version of `autoconf'.
40
+ The file `configure.ac' (or `configure.in') is used to create
41
+ `configure' by a program called `autoconf'. You need `configure.ac' if
42
+ you want to change it or regenerate `configure' using a newer version
43
+ of `autoconf'.
29
44
30
45
The simplest way to compile this package is:
31
46
32
47
1. `cd' to the directory containing the package's source code and type
33
- `./configure' to configure the package for your system. If you're
34
- using `csh' on an old version of System V, you might need to type
35
- `sh ./configure' instead to prevent `csh' from trying to execute
36
- `configure' itself.
48
+ `./configure' to configure the package for your system.
37
49
38
- Running `configure' takes awhile . While running, it prints some
39
- messages telling which features it is checking for.
50
+ Running `configure' might take a while . While running, it prints
51
+ some messages telling which features it is checking for.
40
52
41
53
2. Type `make' to compile the package.
42
54
@@ -55,52 +67,55 @@ The simplest way to compile this package is:
55
67
all sorts of other programs in order to regenerate files that came
56
68
with the distribution.
57
69
70
+ 6. Often, you can also type `make uninstall' to remove the installed
71
+ files again.
72
+
58
73
Compilers and Options
59
74
=====================
60
75
61
- Some systems require unusual options for compilation or linking that
62
- the `configure' script does not know about. You can give `configure'
63
- initial values for variables by setting them in the environment. Using
64
- a Bourne-compatible shell, you can do that on the command line like
65
- this:
66
- CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
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.
79
+
80
+ You can give `configure' initial values for configuration parameters
81
+ by setting variables in the command line or in the environment. Here
82
+ is an example:
67
83
68
- Or on systems that have the `env' program, you can do it like this:
69
- env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
84
+ ./configure CC=c99 CFLAGS=-g LIBS=-lposix
85
+
86
+ *Note Defining Variables::, for more details.
70
87
71
88
Compiling For Multiple Architectures
72
89
====================================
73
90
74
- You can compile the package for more than one kind of computer at the
91
+ You can compile the package for more than one kind of computer at the
75
92
same time, by placing the object files for each architecture in their
76
- own directory. To do this, you must use a version of `make' that
77
- supports the `VPATH' variable, such as GNU `make'. `cd' to the
93
+ own directory. To do this, you can use GNU `make'. `cd' to the
78
94
directory where you want the object files and executables to go and run
79
95
the `configure' script. `configure' automatically checks for the
80
96
source code in the directory that `configure' is in and in `..'.
81
97
82
- If you have to use a `make' that does not supports the `VPATH'
83
- variable, you have to compile the package for one architecture at a time
84
- in the source code directory. After you have installed the package for
85
- one architecture, use `make distclean' before reconfiguring for another
86
- architecture.
98
+ With a non-GNU `make', it is safer to compile the package for one
99
+ architecture at a time in the source code directory. After you have
100
+ installed the package for one architecture, use `make distclean' before
101
+ reconfiguring for another architecture.
87
102
88
103
Installation Names
89
104
==================
90
105
91
- By default, `make install' will install the package's files in
92
- `/usr/local/bin', `/usr/local/man ', etc. You can specify an
93
- installation prefix other than `/usr/local' by giving `configure' the
94
- option `--prefix=PATH '.
106
+ By default, `make install' installs the package's commands under
107
+ `/usr/local/bin', include files under `/usr/local/include ', etc. You
108
+ can specify an installation prefix other than `/usr/local' by giving
109
+ `configure' the option `--prefix=PREFIX '.
95
110
96
111
You can specify separate installation prefixes for
97
112
architecture-specific files and architecture-independent files. If you
98
- give `configure' the option `--exec-prefix=PATH' , the package will use
99
- PATH as the prefix for installing programs and libraries.
100
- Documentation and other data files will still use the regular prefix.
113
+ pass the option `--exec-prefix=PREFIX' to `configure' , the package uses
114
+ PREFIX as the prefix for installing programs and libraries.
115
+ Documentation and other data files still use the regular prefix.
101
116
102
117
In addition, if you use an unusual directory layout you can give
103
- options like `--bindir=PATH ' to specify different values for particular
118
+ options like `--bindir=DIR ' to specify different values for particular
104
119
kinds of files. Run `configure --help' for a list of the directories
105
120
you can set and what kinds of files go in them.
106
121
@@ -111,7 +126,7 @@ option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
111
126
Optional Features
112
127
=================
113
128
114
- Some packages pay attention to `--enable-FEATURE' options to
129
+ Some packages pay attention to `--enable-FEATURE' options to
115
130
`configure', where FEATURE indicates an optional part of the package.
116
131
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
117
132
is something like `gnu-as' or `x' (for the X Window System). The
@@ -126,48 +141,86 @@ you can use the `configure' options `--x-includes=DIR' and
126
141
Specifying the System Type
127
142
==========================
128
143
129
- There may be some features `configure' can not figure out
130
- automatically, but needs to determine by the type of host the package
131
- will run on. Usually `configure' can figure that out, but if it prints
132
- a message saying it can not guess the host type, give it the
133
- `--host=TYPE' option. TYPE can either be a short name for the system
134
- type, such as `sun4', or a canonical name with three fields:
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
149
+ `--build=TYPE' option. TYPE can either be a short name for the system
150
+ type, such as `sun4', or a canonical name which has the form:
151
+
135
152
CPU-COMPANY-SYSTEM
136
153
137
- See the file `config.sub' for the possible values of each field. If
154
+ where SYSTEM can have one of these forms:
155
+
156
+ OS KERNEL-OS
157
+
158
+ See the file `config.sub' for the possible values of each field. If
138
159
`config.sub' isn't included in this package, then this package doesn't
139
- need to know the host type.
160
+ need to know the machine type.
161
+
162
+ If you are _building_ compiler tools for cross-compiling, you should
163
+ use the option `--target=TYPE' to select the type of system they will
164
+ produce code for.
140
165
141
- If you are building compiler tools for cross-compiling, you can also
142
- use the `--target=TYPE' option to select the type of system they will
143
- produce code for and the `--build=TYPE' option to select the type of
144
- system on which you are compiling the package .
166
+ If you want to _use_ a cross compiler, that generates code for a
167
+ platform different from the build platform, you should specify the
168
+ "host" platform (i.e., that on which the generated programs will
169
+ eventually be run) with `--host=TYPE' .
145
170
146
171
Sharing Defaults
147
172
================
148
173
149
- If you want to set default values for `configure' scripts to share,
150
- you can create a site shell script called `config.site' that gives
151
- default values for variables like `CC', `cache_file', and `prefix'.
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'.
152
177
`configure' looks for `PREFIX/share/config.site' if it exists, then
153
178
`PREFIX/etc/config.site' if it exists. Or, you can set the
154
179
`CONFIG_SITE' environment variable to the location of the site script.
155
180
A warning: not all `configure' scripts look for a site script.
156
181
157
- Operation Controls
182
+ Defining Variables
158
183
==================
159
184
160
- `configure' recognizes the following options to control how it
161
- operates.
185
+ Variables not defined in a site shell script can be set in the
186
+ environment passed to `configure'. However, some packages may run
187
+ configure again during the build, and the customized values of these
188
+ variables may be lost. In order to avoid this problem, you should set
189
+ them in the `configure' command line, using `VAR=value'. For example:
162
190
163
- `--cache-file=FILE'
164
- Use and save the results of the tests in FILE instead of
165
- `./config.cache'. Set FILE to `/dev/null' to disable caching, for
166
- debugging `configure'.
191
+ ./configure CC=/usr/local2/bin/gcc
192
+
193
+ causes the specified `gcc' to be used as the C compiler (unless it is
194
+ overridden in the site shell script).
195
+
196
+ Unfortunately, this technique does not work for `CONFIG_SHELL' due to
197
+ an Autoconf bug. Until the bug is fixed you can use this workaround:
198
+
199
+ CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
200
+
201
+ `configure' Invocation
202
+ ======================
203
+
204
+ `configure' recognizes the following options to control how it operates.
167
205
168
206
`--help'
207
+ `-h'
169
208
Print a summary of the options to `configure', and exit.
170
209
210
+ `--version'
211
+ `-V'
212
+ Print the version of Autoconf used to generate the `configure'
213
+ script, and exit.
214
+
215
+ `--cache-file=FILE'
216
+ Enable the cache: use and save the results of the tests in FILE,
217
+ traditionally `config.cache'. FILE defaults to `/dev/null' to
218
+ disable caching.
219
+
220
+ `--config-cache'
221
+ `-C'
222
+ Alias for `--cache-file=config.cache'.
223
+
171
224
`--quiet'
172
225
`--silent'
173
226
`-q'
@@ -179,8 +232,6 @@ operates.
179
232
Look for the package's source code in directory DIR. Usually
180
233
`configure' can determine that directory automatically.
181
234
182
- `--version'
183
- Print the version of Autoconf used to generate the `configure'
184
- script, and exit.
235
+ `configure' also accepts some other, not widely useful, options. Run
236
+ `configure --help' for more details.
185
237
186
- `configure' also accepts some other, not widely useful, options.
0 commit comments