INSTALL 9.28 KB
Newer Older
1 2
Installation Instructions
*************************
Jose Maria Celorio's avatar
Jose Maria Celorio committed
3

4 5
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
Software Foundation, Inc.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
6

7 8
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
9

10 11
Basic Installation
==================
Jose Maria Celorio's avatar
Jose Maria Celorio committed
12

13
These are generic installation instructions.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
14 15 16 17 18 19

   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
20 21 22 23 24 25 26 27 28
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.)
Jose Maria Celorio's avatar
Jose Maria Celorio committed
29 30 31 32

   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
33 34 35
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.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
36

37 38 39 40
   The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'.  You only need
`configure.ac' if you want to change it or regenerate `configure' using
a newer version of `autoconf'.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

The simplest way to compile this package is:

  1. `cd' to the directory containing the package's source code and type
     `./configure' to configure the package for your system.  If you're
     using `csh' on an old version of System V, you might need to type
     `sh ./configure' instead to prevent `csh' from trying to execute
     `configure' itself.

     Running `configure' takes awhile.  While running, it prints some
     messages telling which features it is checking for.

  2. Type `make' to compile the package.

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

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

  5. You can remove the program binaries and object files from the
     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.

Compilers and Options
=====================

73 74 75 76 77 78 79
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.

   You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment.  Here
is an example:
Jose Maria Celorio's avatar
Jose Maria Celorio committed
80

81 82 83
     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix

   *Note Defining Variables::, for more details.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
84 85 86 87

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

88
You can compile the package for more than one kind of computer at the
Jose Maria Celorio's avatar
Jose Maria Celorio committed
89 90 91 92 93 94 95
same time, by placing the object files for each architecture in their
own directory.  To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
directory where you want the object files and executables to go and run
the `configure' script.  `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.

96 97 98 99 100
   If you have to use a `make' that does not support the `VPATH'
variable, you have 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.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
101 102 103 104

Installation Names
==================

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

   You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If you
112 113 114
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.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
115 116

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

   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'.

Optional Features
=================

128
Some packages pay attention to `--enable-FEATURE' options to
Jose Maria Celorio's avatar
Jose Maria Celorio committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142
`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
==========================

143 144 145 146 147 148 149 150
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
`--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:

Jose Maria Celorio's avatar
Jose Maria Celorio committed
151 152
     CPU-COMPANY-SYSTEM

153 154 155 156 157
where SYSTEM can have one of these forms:

     OS KERNEL-OS

   See the file `config.sub' for the possible values of each field.  If
Jose Maria Celorio's avatar
Jose Maria Celorio committed
158
`config.sub' isn't included in this package, then this package doesn't
159
need to know the machine type.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
160

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

   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'.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
169 170 171 172

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

173 174 175
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'.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
176 177 178 179 180
`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.

181
Defining Variables
Jose Maria Celorio's avatar
Jose Maria Celorio committed
182 183
==================

184 185 186 187 188
Variables not defined in a site shell script can be set in the
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:
Jose Maria Celorio's avatar
Jose Maria Celorio committed
189

190 191 192 193 194 195 196 197 198 199 200 201 202 203
     ./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).  Here is a another example:

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

Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
configuration-related scripts to be executed by `/bin/bash'.

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

`configure' recognizes the following options to control how it operates.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
204 205

`--help'
206
`-h'
Jose Maria Celorio's avatar
Jose Maria Celorio committed
207 208
     Print a summary of the options to `configure', and exit.

209 210 211 212 213 214 215 216 217 218 219 220 221 222
`--version'
`-V'
     Print the version of Autoconf used to generate the `configure'
     script, and exit.

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

`--config-cache'
`-C'
     Alias for `--cache-file=config.cache'.

Jose Maria Celorio's avatar
Jose Maria Celorio committed
223 224 225 226 227 228 229 230 231 232 233
`--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.

234 235
`configure' also accepts some other, not widely useful, options.  Run
`configure --help' for more details.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
236