INSTALL 9.29 KB
Newer Older
1
Installation Instructions
2
*************************
3

4
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
5
2006, 2007 Free Software Foundation, Inc.
6

7 8
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
9

10 11
Basic Installation
==================
12

13
Briefly, the shell commands `./configure; make; make install' should
14 15
configure, build, and install this package.  The following
more-detailed instructions are generic; see the `README' file for
16
instructions specific to this package.
17 18 19 20 21 22

   The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation.  It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions.  Finally, it creates a shell script `config.status' that
23 24 25 26 27 28 29 30 31
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').

   It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring.  Caching is
disabled by default to prevent problems with accidental use of stale
cache files.
32 33 34 35

   If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
36 37 38
be considered for the next release.  If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
39

40 41 42 43
   The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'.  You need `configure.ac' if
you want to change it or regenerate `configure' using a newer version
of `autoconf'.
44

45
The simplest way to compile this package is:
46 47

  1. `cd' to the directory containing the package's source code and type
48
     `./configure' to configure the package for your system.
49

50 51
     Running `configure' might take a while.  While running, it prints
     some messages telling which features it is checking for.
52 53 54 55

  2. Type `make' to compile the package.

  3. Optionally, type `make check' to run any self-tests that come with
56
     the package.
57 58

  4. Type `make install' to install the programs and any data files and
59 60 61
     documentation.

  5. You can remove the program binaries and object files from the
62 63 64 65 66 67 68 69
     source code directory by typing `make clean'.  To also remove the
     files that `configure' created (so you can compile the package for
     a different kind of computer), type `make distclean'.  There is
     also a `make maintainer-clean' target, but that is intended mainly
     for the package's developers.  If you use it, you may have to get
     all sorts of other programs in order to regenerate files that came
     with the distribution.

70 71
  6. Often, you can also type `make uninstall' to remove the installed
     files again.
72

73 74 75
Compilers and Options
=====================

76 77 78
Some systems require unusual options for compilation or linking that the
`configure' script does not know about.  Run `./configure --help' for
details on some of the pertinent environment variables.
79 80 81 82 83 84

   You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment.  Here
is an example:

     ./configure CC=c99 CFLAGS=-g LIBS=-lposix
85

86
   *Note Defining Variables::, for more details.
87 88 89 90

Compiling For Multiple Architectures
====================================

91
You can compile the package for more than one kind of computer at the
92
same time, by placing the object files for each architecture in their
93
own directory.  To do this, you can use GNU `make'.  `cd' to the
94 95
directory where you want the object files and executables to go and run
the `configure' script.  `configure' automatically checks for the
96
source code in the directory that `configure' is in and in `..'.
97

98 99 100 101 102
   With a non-GNU `make', it is safer to compile the package for one
architecture at a time in the source code directory.  After you have
installed the package for one architecture, use `make distclean' before
reconfiguring for another architecture.

103 104 105
Installation Names
==================

106
By default, `make install' installs the package's commands under
107 108
`/usr/local/bin', include files under `/usr/local/include', etc.  You
can specify an installation prefix other than `/usr/local' by giving
109
`configure' the option `--prefix=PREFIX'.
110 111 112

   You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If you
113 114 115
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
PREFIX as the prefix for installing programs and libraries.
Documentation and other data files still use the regular prefix.
116 117

   In addition, if you use an unusual directory layout you can give
118
options like `--bindir=DIR' to specify different values for particular
119
kinds of files.  Run `configure --help' for a list of the directories
120
you can set and what kinds of files go in them.
121 122 123 124 125

   If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

126 127 128 129
Optional Features
=================

Some packages pay attention to `--enable-FEATURE' options to
130 131 132 133 134 135 136 137 138 139 140 141 142 143
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System).  The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.

   For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.

Specifying the System Type
==========================

144 145 146 147 148
There may be some features `configure' cannot figure out automatically,
but needs to determine by the type of machine the package will run on.
Usually, assuming the package is built to be run on the _same_
architectures, `configure' can figure that out, but if it prints a
message saying it cannot guess the machine type, give it the
149 150 151
`--build=TYPE' option.  TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:

152 153
     CPU-COMPANY-SYSTEM

154 155
where SYSTEM can have one of these forms:

156
     OS KERNEL-OS
157 158

   See the file `config.sub' for the possible values of each field.  If
159
`config.sub' isn't included in this package, then this package doesn't
160 161 162 163 164
need to know the machine type.

   If you are _building_ compiler tools for cross-compiling, you should
use the option `--target=TYPE' to select the type of system they will
produce code for.
165

166 167 168 169
   If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
170 171 172 173

Sharing Defaults
================

174 175 176
If you want to set default values for `configure' scripts to share, you
can create a site shell script called `config.site' that gives default
values for variables like `CC', `cache_file', and `prefix'.
177 178 179 180 181
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists.  Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.

182
Defining Variables
183 184
==================

185
Variables not defined in a site shell script can be set in the
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
environment passed to `configure'.  However, some packages may run
configure again during the build, and the customized values of these
variables may be lost.  In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'.  For example:

     ./configure CC=/usr/local2/bin/gcc

causes the specified `gcc' to be used as the C compiler (unless it is
overridden in the site shell script).

Unfortunately, this technique does not work for `CONFIG_SHELL' due to
an Autoconf bug.  Until the bug is fixed you can use this workaround:

     CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash

`configure' Invocation
======================

204
`configure' recognizes the following options to control how it operates.
205

206 207
`--help'
`-h'
208
     Print a summary of the options to `configure', and exit.
209 210 211 212 213 214

`--version'
`-V'
     Print the version of Autoconf used to generate the `configure'
     script, and exit.

215
`--cache-file=FILE'
216 217 218
     Enable the cache: use and save the results of the tests in FILE,
     traditionally `config.cache'.  FILE defaults to `/dev/null' to
     disable caching.
219

220 221 222
`--config-cache'
`-C'
     Alias for `--cache-file=config.cache'.
223 224 225 226 227 228 229 230 231 232 233 234

`--quiet'
`--silent'
`-q'
     Do not print messages saying which checks are being made.  To
     suppress all normal output, redirect it to `/dev/null' (any error
     messages will still be shown).

`--srcdir=DIR'
     Look for the package's source code in directory DIR.  Usually
     `configure' can determine that directory automatically.

235 236
`configure' also accepts some other, not widely useful, options.  Run
`configure --help' for more details.
237