INSTALL

   1 Basic Installation
   2 ==================
   3
   4    These are generic installation instructions.
   5
   6    The `configure' shell script attempts to guess correct values for
   7 various system-dependent variables used during compilation.  It uses
   8 those values to create a `Makefile' in each directory of the package.
   9 It may also create one or more `.h' files containing system-dependent
  10 definitions.  Finally, it creates a shell script `config.status' that
  11 you can run in the future to recreate the current configuration, a file
  12 `config.cache' that saves the results of its tests to speed up
  13 reconfiguring, and a file `config.log' containing compiler output
  14 (useful mainly for debugging `configure').
  15
  16    The file `configure.ac' is used to create `configure' by a program
  17 called `autoconf'.  You only need `configure.ac' if you want to change
  18 it or regenerate `configure' using a newer version of
  19 `autoconf'. Please use the autogen.sh shell script, which will run all
  20 the autotools to generate the `configure' script if it is missing.
  21
  22 The simplest way to compile this package is:
  23
  24   1. `cd' to the directory containing the package's source code and type
  25      `./configure' to configure the package for your system.  If you're
  26      using `csh' on an old version of System V, you might need to type
  27      `sh ./configure' instead to prevent `csh' from trying to execute
  28      `configure' itself.
  29
  30      Running `configure' takes awhile.  While running, it prints some
  31      messages telling which features it is checking for.
  32
  33   2. Type `make' to compile the package.
  34
  35   3. Optionally, type `make check' to run any self-tests that come with
  36      the package.
  37
  38   4. Type `make install' to install the programs and any data files and
  39      documentation.
  40
  41   5. You can remove the program binaries and object files from the
  42      source code directory by typing `make clean'.  To also remove the
  43      files that `configure' created (so you can compile the package for
  44      a different kind of computer), type `make distclean'.  There is
  45      also a `make maintainer-clean' target, but that is intended mainly
  46      for the package's developers.  If you use it, you may have to get
  47      all sorts of other programs in order to regenerate files that came
  48      with the distribution.
  49
  50 Compilers and Options
  51 =====================
  52
  53    Some systems require unusual options for compilation or linking that
  54 the `configure' script does not know about.  You can give `configure'
  55 initial values for variables by setting them in the environment.  Using
  56 a Bourne-compatible shell, you can do that on the command line like
  57 this:
  58      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
  59
  60 Or on systems that have the `env' program, you can do it like this:
  61      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
  62
  63 Compiling For Multiple Architectures
  64 ====================================
  65
  66    You can compile the package for more than one kind of computer at the
  67 same time, by placing the object files for each architecture in their
  68 own directory.  To do this, you must use a version of `make' that
  69 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
  70 directory where you want the object files and executables to go and run
  71 the `configure' script.  `configure' automatically checks for the
  72 source code in the directory that `configure' is in and in `..'.
  73
  74    If you have to use a `make' that does not supports the `VPATH'
  75 variable, you have to compile the package for one architecture at a time
  76 in the source code directory.  After you have installed the package for
  77 one architecture, use `make distclean' before reconfiguring for another
  78 architecture.
  79
  80 Installation Names
  81 ==================
  82
  83    By default, `make install' will install the package's files in
  84 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
  85 installation prefix other than `/usr/local' by giving `configure' the
  86 option `--prefix=PATH'.
  87
  88    You can specify separate installation prefixes for
  89 architecture-specific files and architecture-independent files.  If you
  90 give `configure' the option `--exec-prefix=PATH', the package will use
  91 PATH as the prefix for installing programs and libraries.
  92 Documentation and other data files will still use the regular prefix.
  93
  94    In addition, if you use an unusual directory layout you can give
  95 options like `--bindir=PATH' to specify different values for particular
  96 kinds of files.  Run `configure --help' for a list of the directories
  97 you can set and what kinds of files go in them.
  98
  99    If the package supports it, you can cause programs to be installed
 100 with an extra prefix or suffix on their names by giving `configure' the
 101 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 102
 103 Optional Features
 104 =================
 105
 106    Some packages pay attention to `--enable-FEATURE' options to
 107 `configure', where FEATURE indicates an optional part of the package.
 108 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 109 is something like `gnu-as' or `x' (for the X Window System).  The
 110 `README' should mention any `--enable-' and `--with-' options that the
 111 package recognizes.
 112
 113    For packages that use the X Window System, `configure' can usually
 114 find the X include and library files automatically, but if it doesn't,
 115 you can use the `configure' options `--x-includes=DIR' and
 116 `--x-libraries=DIR' to specify their locations.
 117
 118 Specifying the System Type
 119 ==========================
 120
 121    There may be some features `configure' can not figure out
 122 automatically, but needs to determine by the type of host the package
 123 will run on.  Usually `configure' can figure that out, but if it prints
 124 a message saying it can not guess the host type, give it the
 125 `--host=TYPE' option.  TYPE can either be a short name for the system
 126 type, such as `sun4', or a canonical name with three fields:
 127      CPU-COMPANY-SYSTEM
 128
 129 See the file `config.sub' for the possible values of each field.  If
 130 `config.sub' isn't included in this package, then this package doesn't
 131 need to know the host type.
 132
 133    If you are building compiler tools for cross-compiling, you can also
 134 use the `--target=TYPE' option to select the type of system they will
 135 produce code for and the `--build=TYPE' option to select the type of
 136 system on which you are compiling the package.
 137
 138 Sharing Defaults
 139 ================
 140
 141    If you want to set default values for `configure' scripts to share,
 142 you can create a site shell script called `config.site' that gives
 143 default values for variables like `CC', `cache_file', and `prefix'.
 144 `configure' looks for `PREFIX/share/config.site' if it exists, then
 145 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 146 `CONFIG_SITE' environment variable to the location of the site script.
 147 A warning: not all `configure' scripts look for a site script.
 148
 149 Operation Controls
 150 ==================
 151
 152    `configure' recognizes the following options to control how it
 153 operates.
 154
 155 `--cache-file=FILE'
 156      Use and save the results of the tests in FILE instead of
 157      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 158      debugging `configure'.
 159
 160 `--help'
 161      Print a summary of the options to `configure', and exit.
 162
 163 `--quiet'
 164 `--silent'
 165 `-q'
 166      Do not print messages saying which checks are being made.  To
 167      suppress all normal output, redirect it to `/dev/null' (any error
 168      messages will still be shown).
 169
 170 `--srcdir=DIR'
 171      Look for the package's source code in directory DIR.  Usually
 172      `configure' can determine that directory automatically.
 173
 174 `--version'
 175      Print the version of Autoconf used to generate the `configure'
 176      script, and exit.
 177
 178 `configure' also accepts some other, not widely useful, options.
 179