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