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