6 1. Generate configure scripts:
10 2. Generate makefiles:
22 5. Install application (usually has to be done as root):
26 6. To create the debian package:
28 debuild -b --lintian-opts -X changes-file
30 7. To create the source archive:
35 Installation Instructions
36 *************************
38 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
39 Software Foundation, Inc.
41 This file is free documentation; the Free Software Foundation gives
42 unlimited permission to copy, distribute and modify it.
47 These are generic installation instructions.
49 The `configure' shell script attempts to guess correct values for
50 various system-dependent variables used during compilation. It uses
51 those values to create a `Makefile' in each directory of the package.
52 It may also create one or more `.h' files containing system-dependent
53 definitions. Finally, it creates a shell script `config.status' that
54 you can run in the future to recreate the current configuration, and a
55 file `config.log' containing compiler output (useful mainly for
56 debugging `configure').
58 It can also use an optional file (typically called `config.cache'
59 and enabled with `--cache-file=config.cache' or simply `-C') that saves
60 the results of its tests to speed up reconfiguring. (Caching is
61 disabled by default to prevent problems with accidental use of stale
64 If you need to do unusual things to compile the package, please try
65 to figure out how `configure' could check whether to do them, and mail
66 diffs or instructions to the address given in the `README' so they can
67 be considered for the next release. If you are using the cache, and at
68 some point `config.cache' contains results you don't want to keep, you
69 may remove or edit it.
71 The file `configure.ac' (or `configure.in') is used to create
72 `configure' by a program called `autoconf'. You only need
73 `configure.ac' if you want to change it or regenerate `configure' using
74 a newer version of `autoconf'.
76 The simplest way to compile this package is:
78 1. `cd' to the directory containing the package's source code and type
79 `./configure' to configure the package for your system. If you're
80 using `csh' on an old version of System V, you might need to type
81 `sh ./configure' instead to prevent `csh' from trying to execute
84 Running `configure' takes awhile. While running, it prints some
85 messages telling which features it is checking for.
87 2. Type `make' to compile the package.
89 3. Optionally, type `make check' to run any self-tests that come with
92 4. Type `make install' to install the programs and any data files and
95 5. You can remove the program binaries and object files from the
96 source code directory by typing `make clean'. To also remove the
97 files that `configure' created (so you can compile the package for
98 a different kind of computer), type `make distclean'. There is
99 also a `make maintainer-clean' target, but that is intended mainly
100 for the package's developers. If you use it, you may have to get
101 all sorts of other programs in order to regenerate files that came
102 with the distribution.
104 Compilers and Options
105 =====================
107 Some systems require unusual options for compilation or linking that the
108 `configure' script does not know about. Run `./configure --help' for
109 details on some of the pertinent environment variables.
111 You can give `configure' initial values for configuration parameters
112 by setting variables in the command line or in the environment. Here
115 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
117 *Note Defining Variables::, for more details.
119 Compiling For Multiple Architectures
120 ====================================
122 You can compile the package for more than one kind of computer at the
123 same time, by placing the object files for each architecture in their
124 own directory. To do this, you must use a version of `make' that
125 supports the `VPATH' variable, such as GNU `make'. `cd' to the
126 directory where you want the object files and executables to go and run
127 the `configure' script. `configure' automatically checks for the
128 source code in the directory that `configure' is in and in `..'.
130 If you have to use a `make' that does not support the `VPATH'
131 variable, you have to compile the package for one architecture at a
132 time in the source code directory. After you have installed the
133 package for one architecture, use `make distclean' before reconfiguring
134 for another architecture.
139 By default, `make install' installs the package's commands under
140 `/usr/local/bin', include files under `/usr/local/include', etc. You
141 can specify an installation prefix other than `/usr/local' by giving
142 `configure' the option `--prefix=PREFIX'.
144 You can specify separate installation prefixes for
145 architecture-specific files and architecture-independent files. If you
146 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
147 PREFIX as the prefix for installing programs and libraries.
148 Documentation and other data files still use the regular prefix.
150 In addition, if you use an unusual directory layout you can give
151 options like `--bindir=DIR' to specify different values for particular
152 kinds of files. Run `configure --help' for a list of the directories
153 you can set and what kinds of files go in them.
155 If the package supports it, you can cause programs to be installed
156 with an extra prefix or suffix on their names by giving `configure' the
157 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
162 Some packages pay attention to `--enable-FEATURE' options to
163 `configure', where FEATURE indicates an optional part of the package.
164 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
165 is something like `gnu-as' or `x' (for the X Window System). The
166 `README' should mention any `--enable-' and `--with-' options that the
169 For packages that use the X Window System, `configure' can usually
170 find the X include and library files automatically, but if it doesn't,
171 you can use the `configure' options `--x-includes=DIR' and
172 `--x-libraries=DIR' to specify their locations.
174 Specifying the System Type
175 ==========================
177 There may be some features `configure' cannot figure out automatically,
178 but needs to determine by the type of machine the package will run on.
179 Usually, assuming the package is built to be run on the _same_
180 architectures, `configure' can figure that out, but if it prints a
181 message saying it cannot guess the machine type, give it the
182 `--build=TYPE' option. TYPE can either be a short name for the system
183 type, such as `sun4', or a canonical name which has the form:
187 where SYSTEM can have one of these forms:
191 See the file `config.sub' for the possible values of each field. If
192 `config.sub' isn't included in this package, then this package doesn't
193 need to know the machine type.
195 If you are _building_ compiler tools for cross-compiling, you should
196 use the option `--target=TYPE' to select the type of system they will
199 If you want to _use_ a cross compiler, that generates code for a
200 platform different from the build platform, you should specify the
201 "host" platform (i.e., that on which the generated programs will
202 eventually be run) with `--host=TYPE'.
207 If you want to set default values for `configure' scripts to share, you
208 can create a site shell script called `config.site' that gives default
209 values for variables like `CC', `cache_file', and `prefix'.
210 `configure' looks for `PREFIX/share/config.site' if it exists, then
211 `PREFIX/etc/config.site' if it exists. Or, you can set the
212 `CONFIG_SITE' environment variable to the location of the site script.
213 A warning: not all `configure' scripts look for a site script.
218 Variables not defined in a site shell script can be set in the
219 environment passed to `configure'. However, some packages may run
220 configure again during the build, and the customized values of these
221 variables may be lost. In order to avoid this problem, you should set
222 them in the `configure' command line, using `VAR=value'. For example:
224 ./configure CC=/usr/local2/bin/gcc
226 causes the specified `gcc' to be used as the C compiler (unless it is
227 overridden in the site shell script). Here is a another example:
229 /bin/bash ./configure CONFIG_SHELL=/bin/bash
231 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
232 configuration-related scripts to be executed by `/bin/bash'.
234 `configure' Invocation
235 ======================
237 `configure' recognizes the following options to control how it operates.
241 Print a summary of the options to `configure', and exit.
245 Print the version of Autoconf used to generate the `configure'
249 Enable the cache: use and save the results of the tests in FILE,
250 traditionally `config.cache'. FILE defaults to `/dev/null' to
255 Alias for `--cache-file=config.cache'.
260 Do not print messages saying which checks are being made. To
261 suppress all normal output, redirect it to `/dev/null' (any error
262 messages will still be shown).
265 Look for the package's source code in directory DIR. Usually
266 `configure' can determine that directory automatically.
268 `configure' also accepts some other, not widely useful, options. Run
269 `configure --help' for more details.