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