INSTALL

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