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

Ole Aamot's avatar
Ole Aamot committed
4 5
   Copyright (C) 1994-1996, 1999-2002, 2004-2016 Free Software
Foundation, Inc.
6 7 8 9 10 11 12 13 14

   Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without warranty of any kind.

Basic Installation
==================

Ole Aamot's avatar
Ole Aamot committed
15
   Briefly, the shell command './configure && make && make install'
16
should configure, build, and install this package.  The following
Ole Aamot's avatar
Ole Aamot committed
17
more-detailed instructions are generic; see the 'README' file for
18
instructions specific to this package.  Some packages provide this
Ole Aamot's avatar
Ole Aamot committed
19
'INSTALL' file but do not implement all of the features documented
20 21 22 23
below.  The lack of an optional feature in a given package is not
necessarily a bug.  More recommendations for GNU packages can be found
in *note Makefile Conventions: (standards)Makefile Conventions.

Ole Aamot's avatar
Ole Aamot committed
24
   The 'configure' shell script attempts to guess correct values for
25
various system-dependent variables used during compilation.  It uses
Ole Aamot's avatar
Ole Aamot committed
26 27 28
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
29
you can run in the future to recreate the current configuration, and a
Ole Aamot's avatar
Ole Aamot committed
30 31
file 'config.log' containing compiler output (useful mainly for
debugging 'configure').
32

Ole Aamot's avatar
Ole Aamot committed
33 34 35 36
   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.
37 38

   If you need to do unusual things to compile the package, please try
Ole Aamot's avatar
Ole Aamot committed
39 40
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
41
be considered for the next release.  If you are using the cache, and at
Ole Aamot's avatar
Ole Aamot committed
42
some point 'config.cache' contains results you don't want to keep, you
43 44
may remove or edit it.

Ole Aamot's avatar
Ole Aamot committed
45 46 47 48
   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'.
49 50 51

   The simplest way to compile this package is:

Ole Aamot's avatar
Ole Aamot committed
52 53
  1. 'cd' to the directory containing the package's source code and type
     './configure' to configure the package for your system.
54

Ole Aamot's avatar
Ole Aamot committed
55
     Running 'configure' might take a while.  While running, it prints
56 57
     some messages telling which features it is checking for.

Ole Aamot's avatar
Ole Aamot committed
58
  2. Type 'make' to compile the package.
59

Ole Aamot's avatar
Ole Aamot committed
60
  3. Optionally, type 'make check' to run any self-tests that come with
61 62
     the package, generally using the just-built uninstalled binaries.

Ole Aamot's avatar
Ole Aamot committed
63
  4. Type 'make install' to install the programs and any data files and
64 65
     documentation.  When installing into a prefix owned by root, it is
     recommended that the package be configured and built as a regular
Ole Aamot's avatar
Ole Aamot committed
66
     user, and only the 'make install' phase executed with root
67 68
     privileges.

Ole Aamot's avatar
Ole Aamot committed
69
  5. Optionally, type 'make installcheck' to repeat any self-tests, but
70 71
     this time using the binaries in their final installed location.
     This target does not install anything.  Running this target as a
Ole Aamot's avatar
Ole Aamot committed
72
     regular user, particularly if the prior 'make install' required
73 74 75 76
     root privileges, verifies that the installation completed
     correctly.

  6. You can remove the program binaries and object files from the
Ole Aamot's avatar
Ole Aamot committed
77 78 79 80
     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
81 82 83 84
     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.

Ole Aamot's avatar
Ole Aamot committed
85
  7. Often, you can also type 'make uninstall' to remove the installed
86 87 88 89
     files again.  In practice, not all packages have tested that
     uninstallation works correctly, even though it is required by the
     GNU Coding Standards.

Ole Aamot's avatar
Ole Aamot committed
90
  8. Some packages, particularly those that use Automake, provide 'make
91
     distcheck', which can by used by developers to test that all other
Ole Aamot's avatar
Ole Aamot committed
92
     targets like 'make install' and 'make uninstall' work correctly.
93 94 95 96 97 98
     This target is generally not run by end users.

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

   Some systems require unusual options for compilation or linking that
Ole Aamot's avatar
Ole Aamot committed
99
the 'configure' script does not know about.  Run './configure --help'
100 101
for details on some of the pertinent environment variables.

Ole Aamot's avatar
Ole Aamot committed
102 103 104
   You can give 'configure' initial values for configuration parameters
by setting variables in the command line or in the environment.  Here is
an example:
105 106 107 108 109 110 111 112 113 114

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

   *Note Defining Variables::, for more details.

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
Ole Aamot's avatar
Ole Aamot committed
115
own directory.  To do this, you can use GNU 'make'.  'cd' to the
116
directory where you want the object files and executables to go and run
Ole Aamot's avatar
Ole Aamot committed
117 118 119
the 'configure' script.  'configure' automatically checks for the source
code in the directory that 'configure' is in and in '..'.  This is known
as a "VPATH" build.
120

Ole Aamot's avatar
Ole Aamot committed
121
   With a non-GNU 'make', it is safer to compile the package for one
122
architecture at a time in the source code directory.  After you have
Ole Aamot's avatar
Ole Aamot committed
123
installed the package for one architecture, use 'make distclean' before
124 125 126 127
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
Ole Aamot's avatar
Ole Aamot committed
128 129
"universal" binaries--by specifying multiple '-arch' options to the
compiler but only a single '-arch' option to the preprocessor.  Like
130 131 132 133 134 135 136 137
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
Ole Aamot's avatar
Ole Aamot committed
138
using the 'lipo' tool if you have problems.
139 140 141 142

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

Ole Aamot's avatar
Ole Aamot committed
143 144 145 146
   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', where PREFIX must be an
147 148 149 150
absolute file name.

   You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If you
Ole Aamot's avatar
Ole Aamot committed
151
pass the option '--exec-prefix=PREFIX' to 'configure', the package uses
152 153 154 155
PREFIX as the prefix for installing programs and libraries.
Documentation and other data files still use the regular prefix.

   In addition, if you use an unusual directory layout you can give
Ole Aamot's avatar
Ole Aamot committed
156 157 158 159 160
options like '--bindir=DIR' to specify different values for particular
kinds of files.  Run 'configure --help' for a list of the directories
you can set and what kinds of files go in them.  In general, the default
for these options is expressed in terms of '${prefix}', so that
specifying just '--prefix' will affect all of the other directory
161 162 163
specifications that were not explicitly provided.

   The most portable way to affect installation locations is to pass the
Ole Aamot's avatar
Ole Aamot committed
164
correct locations to 'configure'; however, many packages provide one or
165
both of the following shortcuts of passing variable assignments to the
Ole Aamot's avatar
Ole Aamot committed
166
'make install' command line to change installation locations without
167 168 169
having to reconfigure or recompile.

   The first method involves providing an override variable for each
Ole Aamot's avatar
Ole Aamot committed
170
affected directory.  For example, 'make install
171 172
prefix=/alternate/directory' will choose an alternate location for all
directory configuration variables that were expressed in terms of
Ole Aamot's avatar
Ole Aamot committed
173 174 175 176 177 178 179 180 181 182 183 184 185
'${prefix}'.  Any directories that were specified during 'configure',
but not in terms of '${prefix}', must each be overridden at install time
for the entire installation to be relocated.  The approach of makefile
variable overrides for each directory variable is required by the GNU
Coding Standards, and ideally causes no recompilation.  However, some
platforms have known limitations with the semantics of shared libraries
that end up requiring recompilation when using this method, particularly
noticeable in packages that use GNU Libtool.

   The second method involves providing the 'DESTDIR' variable.  For
example, 'make install DESTDIR=/alternate/directory' will prepend
'/alternate/directory' before all installation names.  The approach of
'DESTDIR' overrides is not required by the GNU Coding Standards, and
186 187
does not work on platforms that have drive letters.  On the other hand,
it does better at avoiding recompilation issues, and works well even
Ole Aamot's avatar
Ole Aamot committed
188 189
when some directory options were not specified in terms of '${prefix}'
at 'configure' time.
190 191 192 193 194

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

   If the package supports it, you can cause programs to be installed
Ole Aamot's avatar
Ole Aamot committed
195 196 197 198 199 200 201 202
with an extra prefix or suffix on their names by giving 'configure' the
option '--program-prefix=PREFIX' or '--program-suffix=SUFFIX'.

   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
203 204
package recognizes.

Ole Aamot's avatar
Ole Aamot committed
205
   For packages that use the X Window System, 'configure' can usually
206
find the X include and library files automatically, but if it doesn't,
Ole Aamot's avatar
Ole Aamot committed
207 208
you can use the 'configure' options '--x-includes=DIR' and
'--x-libraries=DIR' to specify their locations.
209 210

   Some packages offer the ability to configure how verbose the
Ole Aamot's avatar
Ole Aamot committed
211
execution of 'make' will be.  For these packages, running './configure
212
--enable-silent-rules' sets the default to minimal output, which can be
Ole Aamot's avatar
Ole Aamot committed
213
overridden with 'make V=1'; while running './configure
214
--disable-silent-rules' sets the default to verbose, which can be
Ole Aamot's avatar
Ole Aamot committed
215
overridden with 'make V=0'.
216 217 218 219

Particular systems
==================

Ole Aamot's avatar
Ole Aamot committed
220 221
   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
222 223 224 225 226 227
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.

Ole Aamot's avatar
Ole Aamot committed
228 229 230
   HP-UX 'make' updates targets which have the same time stamps as their
prerequisites, which makes it generally unusable when shipped generated
files such as 'configure' are involved.  Use GNU 'make' instead.
231 232

   On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
Ole Aamot's avatar
Ole Aamot committed
233 234 235
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
236 237 238 239 240 241 242

     ./configure CC="cc"

and if that doesn't work, try

     ./configure CC="cc -nodtk"

Ole Aamot's avatar
Ole Aamot committed
243
   On Solaris, don't put '/usr/ucb' early in your 'PATH'.  This
244
directory contains several dysfunctional programs; working variants of
Ole Aamot's avatar
Ole Aamot committed
245 246
these programs are available in '/usr/bin'.  So, if you need '/usr/ucb'
in your 'PATH', put it _after_ '/usr/bin'.
247

Ole Aamot's avatar
Ole Aamot committed
248 249
   On Haiku, software installed for all users goes in '/boot/common',
not '/usr/local'.  It is recommended to use the following options:
250 251 252 253 254 255

     ./configure --prefix=/boot/common

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

Ole Aamot's avatar
Ole Aamot committed
256
   There may be some features 'configure' cannot figure out
257 258
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
Ole Aamot's avatar
Ole Aamot committed
259
_same_ architectures, 'configure' can figure that out, but if it prints
260
a message saying it cannot guess the machine type, give it the
Ole Aamot's avatar
Ole Aamot committed
261 262
'--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:
263 264 265 266 267 268 269 270

     CPU-COMPANY-SYSTEM

where SYSTEM can have one of these forms:

     OS
     KERNEL-OS

Ole Aamot's avatar
Ole Aamot committed
271 272
   See the file 'config.sub' for the possible values of each field.  If
'config.sub' isn't included in this package, then this package doesn't
273 274 275
need to know the machine type.

   If you are _building_ compiler tools for cross-compiling, you should
Ole Aamot's avatar
Ole Aamot committed
276
use the option '--target=TYPE' to select the type of system they will
277 278 279 280 281
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
Ole Aamot's avatar
Ole Aamot committed
282
eventually be run) with '--host=TYPE'.
283 284 285 286

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

Ole Aamot's avatar
Ole Aamot committed
287 288 289 290 291 292 293
   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.
294 295 296 297 298

Defining Variables
==================

   Variables not defined in a site shell script can be set in the
Ole Aamot's avatar
Ole Aamot committed
299
environment passed to 'configure'.  However, some packages may run
300 301
configure again during the build, and the customized values of these
variables may be lost.  In order to avoid this problem, you should set
Ole Aamot's avatar
Ole Aamot committed
302
them in the 'configure' command line, using 'VAR=value'.  For example:
303 304 305

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

Ole Aamot's avatar
Ole Aamot committed
306
causes the specified 'gcc' to be used as the C compiler (unless it is
307 308
overridden in the site shell script).

Ole Aamot's avatar
Ole Aamot committed
309 310 311
Unfortunately, this technique does not work for 'CONFIG_SHELL' due to an
Autoconf limitation.  Until the limitation is lifted, you can use this
workaround:
312 313 314

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

Ole Aamot's avatar
Ole Aamot committed
315
'configure' Invocation
316 317
======================

Ole Aamot's avatar
Ole Aamot committed
318
   'configure' recognizes the following options to control how it
319 320
operates.

Ole Aamot's avatar
Ole Aamot committed
321 322 323
'--help'
'-h'
     Print a summary of all of the options to 'configure', and exit.
324

Ole Aamot's avatar
Ole Aamot committed
325 326
'--help=short'
'--help=recursive'
327
     Print a summary of the options unique to this package's
Ole Aamot's avatar
Ole Aamot committed
328 329 330
     '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.
331

Ole Aamot's avatar
Ole Aamot committed
332 333 334
'--version'
'-V'
     Print the version of Autoconf used to generate the 'configure'
335 336
     script, and exit.

Ole Aamot's avatar
Ole Aamot committed
337
'--cache-file=FILE'
338
     Enable the cache: use and save the results of the tests in FILE,
Ole Aamot's avatar
Ole Aamot committed
339
     traditionally 'config.cache'.  FILE defaults to '/dev/null' to
340 341
     disable caching.

Ole Aamot's avatar
Ole Aamot committed
342 343 344
'--config-cache'
'-C'
     Alias for '--cache-file=config.cache'.
345

Ole Aamot's avatar
Ole Aamot committed
346 347 348
'--quiet'
'--silent'
'-q'
349
     Do not print messages saying which checks are being made.  To
Ole Aamot's avatar
Ole Aamot committed
350
     suppress all normal output, redirect it to '/dev/null' (any error
351 352
     messages will still be shown).

Ole Aamot's avatar
Ole Aamot committed
353
'--srcdir=DIR'
354
     Look for the package's source code in directory DIR.  Usually
Ole Aamot's avatar
Ole Aamot committed
355
     'configure' can determine that directory automatically.
356

Ole Aamot's avatar
Ole Aamot committed
357 358 359 360
'--prefix=DIR'
     Use DIR as the installation prefix.  *note Installation Names:: for
     more details, including other options available for fine-tuning the
     installation locations.
361

Ole Aamot's avatar
Ole Aamot committed
362 363
'--no-create'
'-n'
364 365 366
     Run the configure checks, but stop before creating any output
     files.

Ole Aamot's avatar
Ole Aamot committed
367 368
'configure' also accepts some other, not widely useful, options.  Run
'configure --help' for more details.