INSTALL
changeset 24 adf633a3ae6f
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/INSTALL	Sat Feb 18 17:08:22 2012 +0000
     1.3 @@ -0,0 +1,365 @@
     1.4 +Installation Instructions
     1.5 +*************************
     1.6 +
     1.7 +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
     1.8 +2006, 2007, 2008, 2009 Free Software Foundation, Inc.
     1.9 +
    1.10 +   Copying and distribution of this file, with or without modification,
    1.11 +are permitted in any medium without royalty provided the copyright
    1.12 +notice and this notice are preserved.  This file is offered as-is,
    1.13 +without warranty of any kind.
    1.14 +
    1.15 +Basic Installation
    1.16 +==================
    1.17 +
    1.18 +   Briefly, the shell commands `./configure; make; make install' should
    1.19 +configure, build, and install this package.  The following
    1.20 +more-detailed instructions are generic; see the `README' file for
    1.21 +instructions specific to this package.  Some packages provide this
    1.22 +`INSTALL' file but do not implement all of the features documented
    1.23 +below.  The lack of an optional feature in a given package is not
    1.24 +necessarily a bug.  More recommendations for GNU packages can be found
    1.25 +in *note Makefile Conventions: (standards)Makefile Conventions.
    1.26 +
    1.27 +   The `configure' shell script attempts to guess correct values for
    1.28 +various system-dependent variables used during compilation.  It uses
    1.29 +those values to create a `Makefile' in each directory of the package.
    1.30 +It may also create one or more `.h' files containing system-dependent
    1.31 +definitions.  Finally, it creates a shell script `config.status' that
    1.32 +you can run in the future to recreate the current configuration, and a
    1.33 +file `config.log' containing compiler output (useful mainly for
    1.34 +debugging `configure').
    1.35 +
    1.36 +   It can also use an optional file (typically called `config.cache'
    1.37 +and enabled with `--cache-file=config.cache' or simply `-C') that saves
    1.38 +the results of its tests to speed up reconfiguring.  Caching is
    1.39 +disabled by default to prevent problems with accidental use of stale
    1.40 +cache files.
    1.41 +
    1.42 +   If you need to do unusual things to compile the package, please try
    1.43 +to figure out how `configure' could check whether to do them, and mail
    1.44 +diffs or instructions to the address given in the `README' so they can
    1.45 +be considered for the next release.  If you are using the cache, and at
    1.46 +some point `config.cache' contains results you don't want to keep, you
    1.47 +may remove or edit it.
    1.48 +
    1.49 +   The file `configure.ac' (or `configure.in') is used to create
    1.50 +`configure' by a program called `autoconf'.  You need `configure.ac' if
    1.51 +you want to change it or regenerate `configure' using a newer version
    1.52 +of `autoconf'.
    1.53 +
    1.54 +   The simplest way to compile this package is:
    1.55 +
    1.56 +  1. `cd' to the directory containing the package's source code and type
    1.57 +     `./configure' to configure the package for your system.
    1.58 +
    1.59 +     Running `configure' might take a while.  While running, it prints
    1.60 +     some messages telling which features it is checking for.
    1.61 +
    1.62 +  2. Type `make' to compile the package.
    1.63 +
    1.64 +  3. Optionally, type `make check' to run any self-tests that come with
    1.65 +     the package, generally using the just-built uninstalled binaries.
    1.66 +
    1.67 +  4. Type `make install' to install the programs and any data files and
    1.68 +     documentation.  When installing into a prefix owned by root, it is
    1.69 +     recommended that the package be configured and built as a regular
    1.70 +     user, and only the `make install' phase executed with root
    1.71 +     privileges.
    1.72 +
    1.73 +  5. Optionally, type `make installcheck' to repeat any self-tests, but
    1.74 +     this time using the binaries in their final installed location.
    1.75 +     This target does not install anything.  Running this target as a
    1.76 +     regular user, particularly if the prior `make install' required
    1.77 +     root privileges, verifies that the installation completed
    1.78 +     correctly.
    1.79 +
    1.80 +  6. You can remove the program binaries and object files from the
    1.81 +     source code directory by typing `make clean'.  To also remove the
    1.82 +     files that `configure' created (so you can compile the package for
    1.83 +     a different kind of computer), type `make distclean'.  There is
    1.84 +     also a `make maintainer-clean' target, but that is intended mainly
    1.85 +     for the package's developers.  If you use it, you may have to get
    1.86 +     all sorts of other programs in order to regenerate files that came
    1.87 +     with the distribution.
    1.88 +
    1.89 +  7. Often, you can also type `make uninstall' to remove the installed
    1.90 +     files again.  In practice, not all packages have tested that
    1.91 +     uninstallation works correctly, even though it is required by the
    1.92 +     GNU Coding Standards.
    1.93 +
    1.94 +  8. Some packages, particularly those that use Automake, provide `make
    1.95 +     distcheck', which can by used by developers to test that all other
    1.96 +     targets like `make install' and `make uninstall' work correctly.
    1.97 +     This target is generally not run by end users.
    1.98 +
    1.99 +Compilers and Options
   1.100 +=====================
   1.101 +
   1.102 +   Some systems require unusual options for compilation or linking that
   1.103 +the `configure' script does not know about.  Run `./configure --help'
   1.104 +for details on some of the pertinent environment variables.
   1.105 +
   1.106 +   You can give `configure' initial values for configuration parameters
   1.107 +by setting variables in the command line or in the environment.  Here
   1.108 +is an example:
   1.109 +
   1.110 +     ./configure CC=c99 CFLAGS=-g LIBS=-lposix
   1.111 +
   1.112 +   *Note Defining Variables::, for more details.
   1.113 +
   1.114 +Compiling For Multiple Architectures
   1.115 +====================================
   1.116 +
   1.117 +   You can compile the package for more than one kind of computer at the
   1.118 +same time, by placing the object files for each architecture in their
   1.119 +own directory.  To do this, you can use GNU `make'.  `cd' to the
   1.120 +directory where you want the object files and executables to go and run
   1.121 +the `configure' script.  `configure' automatically checks for the
   1.122 +source code in the directory that `configure' is in and in `..'.  This
   1.123 +is known as a "VPATH" build.
   1.124 +
   1.125 +   With a non-GNU `make', it is safer to compile the package for one
   1.126 +architecture at a time in the source code directory.  After you have
   1.127 +installed the package for one architecture, use `make distclean' before
   1.128 +reconfiguring for another architecture.
   1.129 +
   1.130 +   On MacOS X 10.5 and later systems, you can create libraries and
   1.131 +executables that work on multiple system types--known as "fat" or
   1.132 +"universal" binaries--by specifying multiple `-arch' options to the
   1.133 +compiler but only a single `-arch' option to the preprocessor.  Like
   1.134 +this:
   1.135 +
   1.136 +     ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
   1.137 +                 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
   1.138 +                 CPP="gcc -E" CXXCPP="g++ -E"
   1.139 +
   1.140 +   This is not guaranteed to produce working output in all cases, you
   1.141 +may have to build one architecture at a time and combine the results
   1.142 +using the `lipo' tool if you have problems.
   1.143 +
   1.144 +Installation Names
   1.145 +==================
   1.146 +
   1.147 +   By default, `make install' installs the package's commands under
   1.148 +`/usr/local/bin', include files under `/usr/local/include', etc.  You
   1.149 +can specify an installation prefix other than `/usr/local' by giving
   1.150 +`configure' the option `--prefix=PREFIX', where PREFIX must be an
   1.151 +absolute file name.
   1.152 +
   1.153 +   You can specify separate installation prefixes for
   1.154 +architecture-specific files and architecture-independent files.  If you
   1.155 +pass the option `--exec-prefix=PREFIX' to `configure', the package uses
   1.156 +PREFIX as the prefix for installing programs and libraries.
   1.157 +Documentation and other data files still use the regular prefix.
   1.158 +
   1.159 +   In addition, if you use an unusual directory layout you can give
   1.160 +options like `--bindir=DIR' to specify different values for particular
   1.161 +kinds of files.  Run `configure --help' for a list of the directories
   1.162 +you can set and what kinds of files go in them.  In general, the
   1.163 +default for these options is expressed in terms of `${prefix}', so that
   1.164 +specifying just `--prefix' will affect all of the other directory
   1.165 +specifications that were not explicitly provided.
   1.166 +
   1.167 +   The most portable way to affect installation locations is to pass the
   1.168 +correct locations to `configure'; however, many packages provide one or
   1.169 +both of the following shortcuts of passing variable assignments to the
   1.170 +`make install' command line to change installation locations without
   1.171 +having to reconfigure or recompile.
   1.172 +
   1.173 +   The first method involves providing an override variable for each
   1.174 +affected directory.  For example, `make install
   1.175 +prefix=/alternate/directory' will choose an alternate location for all
   1.176 +directory configuration variables that were expressed in terms of
   1.177 +`${prefix}'.  Any directories that were specified during `configure',
   1.178 +but not in terms of `${prefix}', must each be overridden at install
   1.179 +time for the entire installation to be relocated.  The approach of
   1.180 +makefile variable overrides for each directory variable is required by
   1.181 +the GNU Coding Standards, and ideally causes no recompilation.
   1.182 +However, some platforms have known limitations with the semantics of
   1.183 +shared libraries that end up requiring recompilation when using this
   1.184 +method, particularly noticeable in packages that use GNU Libtool.
   1.185 +
   1.186 +   The second method involves providing the `DESTDIR' variable.  For
   1.187 +example, `make install DESTDIR=/alternate/directory' will prepend
   1.188 +`/alternate/directory' before all installation names.  The approach of
   1.189 +`DESTDIR' overrides is not required by the GNU Coding Standards, and
   1.190 +does not work on platforms that have drive letters.  On the other hand,
   1.191 +it does better at avoiding recompilation issues, and works well even
   1.192 +when some directory options were not specified in terms of `${prefix}'
   1.193 +at `configure' time.
   1.194 +
   1.195 +Optional Features
   1.196 +=================
   1.197 +
   1.198 +   If the package supports it, you can cause programs to be installed
   1.199 +with an extra prefix or suffix on their names by giving `configure' the
   1.200 +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
   1.201 +
   1.202 +   Some packages pay attention to `--enable-FEATURE' options to
   1.203 +`configure', where FEATURE indicates an optional part of the package.
   1.204 +They may also pay attention to `--with-PACKAGE' options, where PACKAGE
   1.205 +is something like `gnu-as' or `x' (for the X Window System).  The
   1.206 +`README' should mention any `--enable-' and `--with-' options that the
   1.207 +package recognizes.
   1.208 +
   1.209 +   For packages that use the X Window System, `configure' can usually
   1.210 +find the X include and library files automatically, but if it doesn't,
   1.211 +you can use the `configure' options `--x-includes=DIR' and
   1.212 +`--x-libraries=DIR' to specify their locations.
   1.213 +
   1.214 +   Some packages offer the ability to configure how verbose the
   1.215 +execution of `make' will be.  For these packages, running `./configure
   1.216 +--enable-silent-rules' sets the default to minimal output, which can be
   1.217 +overridden with `make V=1'; while running `./configure
   1.218 +--disable-silent-rules' sets the default to verbose, which can be
   1.219 +overridden with `make V=0'.
   1.220 +
   1.221 +Particular systems
   1.222 +==================
   1.223 +
   1.224 +   On HP-UX, the default C compiler is not ANSI C compatible.  If GNU
   1.225 +CC is not installed, it is recommended to use the following options in
   1.226 +order to use an ANSI C compiler:
   1.227 +
   1.228 +     ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
   1.229 +
   1.230 +and if that doesn't work, install pre-built binaries of GCC for HP-UX.
   1.231 +
   1.232 +   On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
   1.233 +parse its `<wchar.h>' header file.  The option `-nodtk' can be used as
   1.234 +a workaround.  If GNU CC is not installed, it is therefore recommended
   1.235 +to try
   1.236 +
   1.237 +     ./configure CC="cc"
   1.238 +
   1.239 +and if that doesn't work, try
   1.240 +
   1.241 +     ./configure CC="cc -nodtk"
   1.242 +
   1.243 +   On Solaris, don't put `/usr/ucb' early in your `PATH'.  This
   1.244 +directory contains several dysfunctional programs; working variants of
   1.245 +these programs are available in `/usr/bin'.  So, if you need `/usr/ucb'
   1.246 +in your `PATH', put it _after_ `/usr/bin'.
   1.247 +
   1.248 +   On Haiku, software installed for all users goes in `/boot/common',
   1.249 +not `/usr/local'.  It is recommended to use the following options:
   1.250 +
   1.251 +     ./configure --prefix=/boot/common
   1.252 +
   1.253 +Specifying the System Type
   1.254 +==========================
   1.255 +
   1.256 +   There may be some features `configure' cannot figure out
   1.257 +automatically, but needs to determine by the type of machine the package
   1.258 +will run on.  Usually, assuming the package is built to be run on the
   1.259 +_same_ architectures, `configure' can figure that out, but if it prints
   1.260 +a message saying it cannot guess the machine type, give it the
   1.261 +`--build=TYPE' option.  TYPE can either be a short name for the system
   1.262 +type, such as `sun4', or a canonical name which has the form:
   1.263 +
   1.264 +     CPU-COMPANY-SYSTEM
   1.265 +
   1.266 +where SYSTEM can have one of these forms:
   1.267 +
   1.268 +     OS
   1.269 +     KERNEL-OS
   1.270 +
   1.271 +   See the file `config.sub' for the possible values of each field.  If
   1.272 +`config.sub' isn't included in this package, then this package doesn't
   1.273 +need to know the machine type.
   1.274 +
   1.275 +   If you are _building_ compiler tools for cross-compiling, you should
   1.276 +use the option `--target=TYPE' to select the type of system they will
   1.277 +produce code for.
   1.278 +
   1.279 +   If you want to _use_ a cross compiler, that generates code for a
   1.280 +platform different from the build platform, you should specify the
   1.281 +"host" platform (i.e., that on which the generated programs will
   1.282 +eventually be run) with `--host=TYPE'.
   1.283 +
   1.284 +Sharing Defaults
   1.285 +================
   1.286 +
   1.287 +   If you want to set default values for `configure' scripts to share,
   1.288 +you can create a site shell script called `config.site' that gives
   1.289 +default values for variables like `CC', `cache_file', and `prefix'.
   1.290 +`configure' looks for `PREFIX/share/config.site' if it exists, then
   1.291 +`PREFIX/etc/config.site' if it exists.  Or, you can set the
   1.292 +`CONFIG_SITE' environment variable to the location of the site script.
   1.293 +A warning: not all `configure' scripts look for a site script.
   1.294 +
   1.295 +Defining Variables
   1.296 +==================
   1.297 +
   1.298 +   Variables not defined in a site shell script can be set in the
   1.299 +environment passed to `configure'.  However, some packages may run
   1.300 +configure again during the build, and the customized values of these
   1.301 +variables may be lost.  In order to avoid this problem, you should set
   1.302 +them in the `configure' command line, using `VAR=value'.  For example:
   1.303 +
   1.304 +     ./configure CC=/usr/local2/bin/gcc
   1.305 +
   1.306 +causes the specified `gcc' to be used as the C compiler (unless it is
   1.307 +overridden in the site shell script).
   1.308 +
   1.309 +Unfortunately, this technique does not work for `CONFIG_SHELL' due to
   1.310 +an Autoconf bug.  Until the bug is fixed you can use this workaround:
   1.311 +
   1.312 +     CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
   1.313 +
   1.314 +`configure' Invocation
   1.315 +======================
   1.316 +
   1.317 +   `configure' recognizes the following options to control how it
   1.318 +operates.
   1.319 +
   1.320 +`--help'
   1.321 +`-h'
   1.322 +     Print a summary of all of the options to `configure', and exit.
   1.323 +
   1.324 +`--help=short'
   1.325 +`--help=recursive'
   1.326 +     Print a summary of the options unique to this package's
   1.327 +     `configure', and exit.  The `short' variant lists options used
   1.328 +     only in the top level, while the `recursive' variant lists options
   1.329 +     also present in any nested packages.
   1.330 +
   1.331 +`--version'
   1.332 +`-V'
   1.333 +     Print the version of Autoconf used to generate the `configure'
   1.334 +     script, and exit.
   1.335 +
   1.336 +`--cache-file=FILE'
   1.337 +     Enable the cache: use and save the results of the tests in FILE,
   1.338 +     traditionally `config.cache'.  FILE defaults to `/dev/null' to
   1.339 +     disable caching.
   1.340 +
   1.341 +`--config-cache'
   1.342 +`-C'
   1.343 +     Alias for `--cache-file=config.cache'.
   1.344 +
   1.345 +`--quiet'
   1.346 +`--silent'
   1.347 +`-q'
   1.348 +     Do not print messages saying which checks are being made.  To
   1.349 +     suppress all normal output, redirect it to `/dev/null' (any error
   1.350 +     messages will still be shown).
   1.351 +
   1.352 +`--srcdir=DIR'
   1.353 +     Look for the package's source code in directory DIR.  Usually
   1.354 +     `configure' can determine that directory automatically.
   1.355 +
   1.356 +`--prefix=DIR'
   1.357 +     Use DIR as the installation prefix.  *note Installation Names::
   1.358 +     for more details, including other options available for fine-tuning
   1.359 +     the installation locations.
   1.360 +
   1.361 +`--no-create'
   1.362 +`-n'
   1.363 +     Run the configure checks, but stop before creating any output
   1.364 +     files.
   1.365 +
   1.366 +`configure' also accepts some other, not widely useful, options.  Run
   1.367 +`configure --help' for more details.
   1.368 +