INSTALL 11.6 KB
Newer Older
Erick's avatar
Erick committed
1 2 3 4 5 6 7 8 9
Installation Instructions
*************************

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

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

eg's avatar
eg committed
10 11 12
Basic Installation
==================

Erick's avatar
Erick committed
13 14 15 16
   Briefly, the shell commands `./configure; make; make install' should
configure, build, and install this package.  The following
more-detailed instructions are generic; see the `README' file for
instructions specific to this package.
eg's avatar
eg committed
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
Erick's avatar
Erick committed
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.
eg's avatar
eg committed
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
Erick's avatar
Erick committed
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.
eg's avatar
eg committed
39

Erick's avatar
Erick committed
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'.
eg's avatar
eg committed
44 45 46 47

The simplest way to compile this package is:

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

Erick's avatar
Erick committed
50 51
     Running `configure' might take a while.  While running, it prints
     some messages telling which features it is checking for.
eg's avatar
eg committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69

  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.

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

eg's avatar
eg committed
73 74 75 76
Compilers and Options
=====================

   Some systems require unusual options for compilation or linking that
Erick's avatar
Erick committed
77 78
the `configure' script does not know about.  Run `./configure --help'
for details on some of the pertinent environment variables.
eg's avatar
eg committed
79

Erick's avatar
Erick committed
80 81 82 83 84 85 86
   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

   *Note Defining Variables::, for more details.
eg's avatar
eg committed
87 88 89 90 91 92

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

   You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
Erick's avatar
Erick committed
93
own directory.  To do this, you can use GNU `make'.  `cd' to the
eg's avatar
eg committed
94 95 96 97
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 `..'.

Erick's avatar
Erick committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
   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.

   On MacOS X 10.5 and later systems, you can create libraries and
executables that work on multiple system types--known as "fat" or
"universal" binaries--by specifying multiple `-arch' options to the
compiler but only a single `-arch' option to the preprocessor.  Like
this:

     ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
                 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
                 CPP="gcc -E" CXXCPP="g++ -E"

   This is not guaranteed to produce working output in all cases, you
may have to build one architecture at a time and combine the results
using the `lipo' tool if you have problems.
eg's avatar
eg committed
116 117 118 119

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

Erick's avatar
Erick committed
120 121 122 123
   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'.
eg's avatar
eg committed
124 125 126

   You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If you
Erick's avatar
Erick committed
127 128 129
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.
eg's avatar
eg committed
130 131

   In addition, if you use an unusual directory layout you can give
Erick's avatar
Erick committed
132
options like `--bindir=DIR' to specify different values for particular
eg's avatar
eg committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
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
=================

   Some packages pay attention to `--enable-FEATURE' options to
`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.

Erick's avatar
Erick committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
Particular systems
==================

   On HP-UX, the default C compiler is not ANSI C compatible.  If GNU
CC is not installed, it is recommended to use the following options in
order to use an ANSI C compiler:

     ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"

and if that doesn't work, install pre-built binaries of GCC for HP-UX.

   On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
parse its `<wchar.h>' header file.  The option `-nodtk' can be used as
a workaround.  If GNU CC is not installed, it is therefore recommended
to try

     ./configure CC="cc"

and if that doesn't work, try

     ./configure CC="cc -nodtk"

   On Solaris, don't put `/usr/ucb' early in your `PATH'.  This
directory contains several dysfunctional programs; working variants of
these programs are available in `/usr/bin'.  So, if you need `/usr/ucb'
in your `PATH', put it _after_ `/usr/bin'.

   On Haiku, software installed for all users goes in `/boot/common',
not `/usr/local'.  It is recommended to use the following options:

     ./configure --prefix=/boot/common

eg's avatar
eg committed
187 188 189
Specifying the System Type
==========================

Erick's avatar
Erick committed
190 191 192 193 194 195 196 197
   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:

eg's avatar
eg committed
198 199
     CPU-COMPANY-SYSTEM

Erick's avatar
Erick committed
200 201 202 203 204 205
where SYSTEM can have one of these forms:

     OS
     KERNEL-OS

   See the file `config.sub' for the possible values of each field.  If
eg's avatar
eg committed
206
`config.sub' isn't included in this package, then this package doesn't
Erick's avatar
Erick committed
207
need to know the machine type.
eg's avatar
eg committed
208

Erick's avatar
Erick committed
209 210 211 212 213 214 215 216
   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.

   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'.
eg's avatar
eg committed
217 218 219 220 221 222 223 224 225 226 227 228

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

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

Erick's avatar
Erick committed
229
Defining Variables
eg's avatar
eg committed
230 231
==================

Erick's avatar
Erick committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
   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:

     ./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
======================

eg's avatar
eg committed
251 252 253
   `configure' recognizes the following options to control how it
operates.

Erick's avatar
Erick committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
`--help'
`-h'
     Print a summary of all of the options to `configure', and exit.

`--help=short'
`--help=recursive'
     Print a summary of the options unique to this package's
     `configure', and exit.  The `short' variant lists options used
     only in the top level, while the `recursive' variant lists options
     also present in any nested packages.

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

eg's avatar
eg committed
270
`--cache-file=FILE'
Erick's avatar
Erick committed
271 272 273
     Enable the cache: use and save the results of the tests in FILE,
     traditionally `config.cache'.  FILE defaults to `/dev/null' to
     disable caching.
eg's avatar
eg committed
274

Erick's avatar
Erick committed
275 276 277
`--config-cache'
`-C'
     Alias for `--cache-file=config.cache'.
eg's avatar
eg committed
278 279 280 281 282 283 284 285 286 287 288 289

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

Erick's avatar
Erick committed
290 291 292 293 294 295 296 297 298 299 300 301
`--prefix=DIR'
     Use DIR as the installation prefix.  *Note Installation Names::
     for more details, including other options available for fine-tuning
     the installation locations.

`--no-create'
`-n'
     Run the configure checks, but stop before creating any output
     files.

`configure' also accepts some other, not widely useful, options.  Run
`configure --help' for more details.
eg's avatar
eg committed
302