INSTALL

   1 Installation Instructions
   2 *************************
   3
   4 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
   5 2006 Free Software Foundation, Inc.
   6
   7 This file is free documentation; the Free Software Foundation gives
   8 unlimited permission to copy, distribute and modify it.
   9
  10 Basic Installation
  11 ==================
  12
  13 Briefly, the shell commands `./autogen.sh; ./configure; make; make install'
  14 should configure, build, and install this package.  The following
  15 more-detailed instructions are generic; see the `README' file for
  16 instructions specific to this package.
  17
  18    The `configure' shell script attempts to guess correct values for
  19 various system-dependent variables used during compilation.  It uses
  20 those values to create a `Makefile' in each directory of the package.
  21 It may also create one or more `.h' files containing system-dependent
  22 definitions.  Finally, it creates a shell script `config.status' that
  23 you can run in the future to recreate the current configuration, and a
  24 file `config.log' containing compiler output (useful mainly for
  25 debugging `configure').
  26
  27    It can also use an optional file (typically called `config.cache'
  28 and enabled with `--cache-file=config.cache' or simply `-C') that saves
  29 the results of its tests to speed up reconfiguring.  Caching is
  30 disabled by default to prevent problems with accidental use of stale
  31 cache files.
  32
  33    If you need to do unusual things to compile the package, please try
  34 to figure out how `configure' could check whether to do them, and mail
  35 diffs or instructions to the address given in the `README' so they can
  36 be considered for the next release.  If you are using the cache, and at
  37 some point `config.cache' contains results you don't want to keep, you
  38 may remove or edit it.
  39
  40    The file `configure.ac' (or `configure.in') is used to create
  41 `configure' by a program called `autoconf'.  You need `configure.ac' if
  42 you want to change it or regenerate `configure' using a newer version
  43 of `autoconf'.
  44
  45 The simplest way to compile this package is:
  46
  47   0. If the sources are not coming from a package maintainer and the
  48      'configure' file does not exist, you should run './autogen.sh' in
  49      the directory containing the package's source code in order to
  50      generate the 'configure' file from the 'configure.ac' file.
  51
  52   1. `cd' to the directory containing the package's source code and type
  53      `./configure' to configure the package for your system.
  54
  55      Running `configure' might take a while.  While running, it prints
  56      some messages telling which features it is checking for.
  57
  58   2. Type `make' to compile the package.
  59
  60   3. Optionally, type `make check' to run any self-tests that come with
  61      the package.
  62
  63   4. Type `make install' to install the programs and any data files and
  64      documentation.
  65
  66   5. You can remove the program binaries and object files from the
  67      source code directory by typing `make clean'.  To also remove the
  68      files that `configure' created (so you can compile the package for
  69      a different kind of computer), type `make distclean'.  There is
  70      also a `make maintainer-clean' target, but that is intended mainly
  71      for the package's developers.  If you use it, you may have to get
  72      all sorts of other programs in order to regenerate files that came
  73      with the distribution.
  74
  75 Compilers and Options
  76 =====================
  77
  78 Some systems require unusual options for compilation or linking that the
  79 `configure' script does not know about.  Run `./configure --help' for
  80 details on some of the pertinent environment variables.
  81
  82    You can give `configure' initial values for configuration parameters
  83 by setting variables in the command line or in the environment.  Here
  84 is an example:
  85
  86      ./configure CC=c99 CFLAGS=-g LIBS=-lposix
  87
  88    *Note Defining Variables::, for more details.
  89
  90 Compiling For Multiple Architectures
  91 ====================================
  92
  93 You can compile the package for more than one kind of computer at the
  94 same time, by placing the object files for each architecture in their
  95 own directory.  To do this, you can use GNU `make'.  `cd' to the
  96 directory where you want the object files and executables to go and run
  97 the `configure' script.  `configure' automatically checks for the
  98 source code in the directory that `configure' is in and in `..'.
  99
 100    With a non-GNU `make', it is safer to compile the package for one
 101 architecture at a time in the source code directory.  After you have
 102 installed the package for one architecture, use `make distclean' before
 103 reconfiguring for another architecture.
 104
 105 Installation Names
 106 ==================
 107
 108 By default, `make install' installs the package's commands under
 109 `/usr/local/bin', include files under `/usr/local/include', etc.  You
 110 can specify an installation prefix other than `/usr/local' by giving
 111 `configure' the option `--prefix=PREFIX'.
 112
 113    You can specify separate installation prefixes for
 114 architecture-specific files and architecture-independent files.  If you
 115 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 116 PREFIX as the prefix for installing programs and libraries.
 117 Documentation and other data files still use the regular prefix.
 118
 119    In addition, if you use an unusual directory layout you can give
 120 options like `--bindir=DIR' to specify different values for particular
 121 kinds of files.  Run `configure --help' for a list of the directories
 122 you can set and what kinds of files go in them.
 123
 124    If the package supports it, you can cause programs to be installed
 125 with an extra prefix or suffix on their names by giving `configure' the
 126 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 127
 128 Optional Features
 129 =================
 130
 131 Some packages pay attention to `--enable-FEATURE' options to
 132 `configure', where FEATURE indicates an optional part of the package.
 133 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 134 is something like `gnu-as' or `x' (for the X Window System).  The
 135 `README' should mention any `--enable-' and `--with-' options that the
 136 package recognizes.
 137
 138    For packages that use the X Window System, `configure' can usually
 139 find the X include and library files automatically, but if it doesn't,
 140 you can use the `configure' options `--x-includes=DIR' and
 141 `--x-libraries=DIR' to specify their locations.
 142
 143 Specifying the System Type
 144 ==========================
 145
 146 There may be some features `configure' cannot figure out automatically,
 147 but needs to determine by the type of machine the package will run on.
 148 Usually, assuming the package is built to be run on the _same_
 149 architectures, `configure' can figure that out, but if it prints a
 150 message saying it cannot guess the machine type, give it the
 151 `--build=TYPE' option.  TYPE can either be a short name for the system
 152 type, such as `sun4', or a canonical name which has the form:
 153
 154      CPU-COMPANY-SYSTEM
 155
 156 where SYSTEM can have one of these forms:
 157
 158      OS KERNEL-OS
 159
 160    See the file `config.sub' for the possible values of each field.  If
 161 `config.sub' isn't included in this package, then this package doesn't
 162 need to know the machine type.
 163
 164    If you are _building_ compiler tools for cross-compiling, you should
 165 use the option `--target=TYPE' to select the type of system they will
 166 produce code for.
 167
 168    If you want to _use_ a cross compiler, that generates code for a
 169 platform different from the build platform, you should specify the
 170 "host" platform (i.e., that on which the generated programs will
 171 eventually be run) with `--host=TYPE'.
 172
 173 Sharing Defaults
 174 ================
 175
 176 If you want to set default values for `configure' scripts to share, you
 177 can create a site shell script called `config.site' that gives default
 178 values for variables like `CC', `cache_file', and `prefix'.
 179 `configure' looks for `PREFIX/share/config.site' if it exists, then
 180 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 181 `CONFIG_SITE' environment variable to the location of the site script.
 182 A warning: not all `configure' scripts look for a site script.
 183
 184 Defining Variables
 185 ==================
 186
 187 Variables not defined in a site shell script can be set in the
 188 environment passed to `configure'.  However, some packages may run
 189 configure again during the build, and the customized values of these
 190 variables may be lost.  In order to avoid this problem, you should set
 191 them in the `configure' command line, using `VAR=value'.  For example:
 192
 193      ./configure CC=/usr/local2/bin/gcc
 194
 195 causes the specified `gcc' to be used as the C compiler (unless it is
 196 overridden in the site shell script).
 197
 198 Unfortunately, this technique does not work for `CONFIG_SHELL' due to
 199 an Autoconf bug.  Until the bug is fixed you can use this workaround:
 200
 201      CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
 202
 203 `configure' Invocation
 204 ======================
 205
 206 `configure' recognizes the following options to control how it operates.
 207
 208 `--help'
 209 `-h'
 210      Print a summary of the options to `configure', and exit.
 211
 212 `--version'
 213 `-V'
 214      Print the version of Autoconf used to generate the `configure'
 215      script, and exit.
 216
 217 `--cache-file=FILE'
 218      Enable the cache: use and save the results of the tests in FILE,
 219      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 220      disable caching.
 221
 222 `--config-cache'
 223 `-C'
 224      Alias for `--cache-file=config.cache'.
 225
 226 `--quiet'
 227 `--silent'
 228 `-q'
 229      Do not print messages saying which checks are being made.  To
 230      suppress all normal output, redirect it to `/dev/null' (any error
 231      messages will still be shown).
 232
 233 `--srcdir=DIR'
 234      Look for the package's source code in directory DIR.  Usually
 235      `configure' can determine that directory automatically.
 236
 237 `configure' also accepts some other, not widely useful, options.  Run
 238 `configure --help' for more details.
 239