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