\doxysection{Installation}
\label{group__install}\index{Installation@{Installation}}
\doxysubsection{I\+N\+S\+T\+A\+LL}\label{group__install_install}

\begin{DoxyCodeInclude}{0}
\DoxyCodeLine{Basic Installation}
\DoxyCodeLine{==================}
\DoxyCodeLine{}
\DoxyCodeLine{   These are generic installation instructions.}
\DoxyCodeLine{}
\DoxyCodeLine{   The `configure' shell script attempts to guess correct values for}
\DoxyCodeLine{various system-\/dependent variables used during compilation.  It uses}
\DoxyCodeLine{those values to create a `Makefile' in each directory of the package.}
\DoxyCodeLine{It may also create one or more `.h' files containing system-\/dependent}
\DoxyCodeLine{definitions.  Finally, it creates a shell script `config.status' that}
\DoxyCodeLine{you can run in the future to recreate the current configuration, a file}
\DoxyCodeLine{`config.cache' that saves the results of its tests to speed up}
\DoxyCodeLine{reconfiguring, and a file `config.log' containing compiler output}
\DoxyCodeLine{(useful mainly for debugging `configure').}
\DoxyCodeLine{}
\DoxyCodeLine{   If you need to do unusual things to compile the package, please try}
\DoxyCodeLine{to figure out how `configure' could check whether to do them, and mail}
\DoxyCodeLine{diffs or instructions to the address given in the `README' so they can}
\DoxyCodeLine{be considered for the next release.  If at some point `config.cache'}
\DoxyCodeLine{contains results you don't want to keep, you may remove or edit it.}
\DoxyCodeLine{}
\DoxyCodeLine{   The file `configure.in' is used to create `configure' by a program}
\DoxyCodeLine{called `autoconf'.  You only need `configure.in' if you want to change}
\DoxyCodeLine{it or regenerate `configure' using a newer version of `autoconf'.}
\DoxyCodeLine{}
\DoxyCodeLine{The simplest way to compile this package is:}
\DoxyCodeLine{}
\DoxyCodeLine{  1. `cd' to the directory containing the package's source code and type}
\DoxyCodeLine{     `./configure' to configure the package for your system.  If you're}
\DoxyCodeLine{     using `csh' on an old version of System V, you might need to type}
\DoxyCodeLine{     `sh ./configure' instead to prevent `csh' from trying to execute}
\DoxyCodeLine{     `configure' itself.}
\DoxyCodeLine{}
\DoxyCodeLine{     Running `configure' takes awhile.  While running, it prints some}
\DoxyCodeLine{     messages telling which features it is checking for.}
\DoxyCodeLine{}
\DoxyCodeLine{  2. Type `make' to compile the package.}
\DoxyCodeLine{}
\DoxyCodeLine{  3. Optionally, type `make check' to run any self-\/tests that come with}
\DoxyCodeLine{     the package.}
\DoxyCodeLine{}
\DoxyCodeLine{  4. Type `make install' to install the programs and any data files and}
\DoxyCodeLine{     documentation.}
\DoxyCodeLine{}
\DoxyCodeLine{  5. You can remove the program binaries and object files from the}
\DoxyCodeLine{     source code directory by typing `make clean'.  To also remove the}
\DoxyCodeLine{     files that `configure' created (so you can compile the package for}
\DoxyCodeLine{     a different kind of computer), type `make distclean'.  There is}
\DoxyCodeLine{     also a `make maintainer-\/clean' target, but that is intended mainly}
\DoxyCodeLine{     for the package's developers.  If you use it, you may have to get}
\DoxyCodeLine{     all sorts of other programs in order to regenerate files that came}
\DoxyCodeLine{     with the distribution.}
\DoxyCodeLine{}
\DoxyCodeLine{Compilers and Options}
\DoxyCodeLine{=====================}
\DoxyCodeLine{}
\DoxyCodeLine{   Some systems require unusual options for compilation or linking that}
\DoxyCodeLine{the `configure' script does not know about.  You can give `configure'}
\DoxyCodeLine{initial values for variables by setting them in the environment.  Using}
\DoxyCodeLine{a Bourne-\/compatible shell, you can do that on the command line like}
\DoxyCodeLine{this:}
\DoxyCodeLine{     CC=c89 CFLAGS=-\/O2 LIBS=-\/lposix ./configure}
\DoxyCodeLine{}
\DoxyCodeLine{Or on systems that have the `env' program, you can do it like this:}
\DoxyCodeLine{     env CPPFLAGS=-\/I/usr/local/include LDFLAGS=-\/s ./configure}
\DoxyCodeLine{}
\DoxyCodeLine{Compiling For Multiple Architectures}
\DoxyCodeLine{====================================}
\DoxyCodeLine{}
\DoxyCodeLine{   You can compile the package for more than one kind of computer at the}
\DoxyCodeLine{same time, by placing the object files for each architecture in their}
\DoxyCodeLine{own directory.  To do this, you must use a version of `make' that}
\DoxyCodeLine{supports the `VPATH' variable, such as GNU `make'.  `cd' to the}
\DoxyCodeLine{directory where you want the object files and executables to go and run}
\DoxyCodeLine{the `configure' script.  `configure' automatically checks for the}
\DoxyCodeLine{source code in the directory that `configure' is in and in `..'.}
\DoxyCodeLine{}
\DoxyCodeLine{   If you have to use a `make' that does not supports the `VPATH'}
\DoxyCodeLine{variable, you have to compile the package for one architecture at a time}
\DoxyCodeLine{in the source code directory.  After you have installed the package for}
\DoxyCodeLine{one architecture, use `make distclean' before reconfiguring for another}
\DoxyCodeLine{architecture.}
\DoxyCodeLine{}
\DoxyCodeLine{Installation Names}
\DoxyCodeLine{==================}
\DoxyCodeLine{}
\DoxyCodeLine{   By default, `make install' will install the package's files in}
\DoxyCodeLine{`/usr/local/bin', `/usr/local/man', etc.  You can specify an}
\DoxyCodeLine{installation prefix other than `/usr/local' by giving `configure' the}
\DoxyCodeLine{option `-\/-\/prefix=PATH'.}
\DoxyCodeLine{}
\DoxyCodeLine{   You can specify separate installation prefixes for}
\DoxyCodeLine{architecture-\/specific files and architecture-\/independent files.  If you}
\DoxyCodeLine{give `configure' the option `-\/-\/exec-\/prefix=PATH', the package will use}
\DoxyCodeLine{PATH as the prefix for installing programs and libraries.}
\DoxyCodeLine{Documentation and other data files will still use the regular prefix.}
\DoxyCodeLine{}
\DoxyCodeLine{   In addition, if you use an unusual directory layout you can give}
\DoxyCodeLine{options like `-\/-\/bindir=PATH' to specify different values for particular}
\DoxyCodeLine{kinds of files.  Run `configure -\/-\/help' for a list of the directories}
\DoxyCodeLine{you can set and what kinds of files go in them.}
\DoxyCodeLine{}
\DoxyCodeLine{   If the package supports it, you can cause programs to be installed}
\DoxyCodeLine{with an extra prefix or suffix on their names by giving `configure' the}
\DoxyCodeLine{option `-\/-\/program-\/prefix=PREFIX' or `-\/-\/program-\/suffix=SUFFIX'.}
\DoxyCodeLine{}
\DoxyCodeLine{Optional Features}
\DoxyCodeLine{=================}
\DoxyCodeLine{}
\DoxyCodeLine{   Some packages pay attention to `-\/-\/enable-\/FEATURE' options to}
\DoxyCodeLine{`configure', where FEATURE indicates an optional part of the package.}
\DoxyCodeLine{They may also pay attention to `-\/-\/with-\/PACKAGE' options, where PACKAGE}
\DoxyCodeLine{is something like `gnu-\/as' or `x' (for the X Window System).  The}
\DoxyCodeLine{`README' should mention any `-\/-\/enable-\/' and `-\/-\/with-\/' options that the}
\DoxyCodeLine{package recognizes.}
\DoxyCodeLine{}
\DoxyCodeLine{   For packages that use the X Window System, `configure' can usually}
\DoxyCodeLine{find the X include and library files automatically, but if it doesn't,}
\DoxyCodeLine{you can use the `configure' options `-\/-\/x-\/includes=DIR' and}
\DoxyCodeLine{`-\/-\/x-\/libraries=DIR' to specify their locations.}
\DoxyCodeLine{}
\DoxyCodeLine{Specifying the System Type}
\DoxyCodeLine{==========================}
\DoxyCodeLine{}
\DoxyCodeLine{   There may be some features `configure' can not figure out}
\DoxyCodeLine{automatically, but needs to determine by the type of host the package}
\DoxyCodeLine{will run on.  Usually `configure' can figure that out, but if it prints}
\DoxyCodeLine{a message saying it can not guess the host type, give it the}
\DoxyCodeLine{`-\/-\/host=TYPE' option.  TYPE can either be a short name for the system}
\DoxyCodeLine{type, such as `sun4', or a canonical name with three fields:}
\DoxyCodeLine{     CPU-\/COMPANY-\/SYSTEM}
\DoxyCodeLine{}
\DoxyCodeLine{See the file `config.sub' for the possible values of each field.  If}
\DoxyCodeLine{`config.sub' isn't included in this package, then this package doesn't}
\DoxyCodeLine{need to know the host type.}
\DoxyCodeLine{}
\DoxyCodeLine{   If you are building compiler tools for cross-\/compiling, you can also}
\DoxyCodeLine{use the `-\/-\/target=TYPE' option to select the type of system they will}
\DoxyCodeLine{produce code for and the `-\/-\/build=TYPE' option to select the type of}
\DoxyCodeLine{system on which you are compiling the package.}
\DoxyCodeLine{}
\DoxyCodeLine{Sharing Defaults}
\DoxyCodeLine{================}
\DoxyCodeLine{}
\DoxyCodeLine{   If you want to set default values for `configure' scripts to share,}
\DoxyCodeLine{you can create a site shell script called `config.site' that gives}
\DoxyCodeLine{default values for variables like `CC', `cache\_file', and `prefix'.}
\DoxyCodeLine{`configure' looks for `PREFIX/share/config.site' if it exists, then}
\DoxyCodeLine{`PREFIX/etc/config.site' if it exists.  Or, you can set the}
\DoxyCodeLine{`CONFIG\_SITE' environment variable to the location of the site script.}
\DoxyCodeLine{A warning: not all `configure' scripts look for a site script.}
\DoxyCodeLine{}
\DoxyCodeLine{Operation Controls}
\DoxyCodeLine{==================}
\DoxyCodeLine{}
\DoxyCodeLine{   `configure' recognizes the following options to control how it}
\DoxyCodeLine{operates.}
\DoxyCodeLine{}
\DoxyCodeLine{`-\/-\/cache-\/file=FILE'}
\DoxyCodeLine{     Use and save the results of the tests in FILE instead of}
\DoxyCodeLine{     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for}
\DoxyCodeLine{     debugging `configure'.}
\DoxyCodeLine{}
\DoxyCodeLine{`-\/-\/help'}
\DoxyCodeLine{     Print a summary of the options to `configure', and exit.}
\DoxyCodeLine{}
\DoxyCodeLine{`-\/-\/quiet'}
\DoxyCodeLine{`-\/-\/silent'}
\DoxyCodeLine{`-\/q'}
\DoxyCodeLine{     Do not print messages saying which checks are being made.  To}
\DoxyCodeLine{     suppress all normal output, redirect it to `/dev/null' (any error}
\DoxyCodeLine{     messages will still be shown).}
\DoxyCodeLine{}
\DoxyCodeLine{`-\/-\/srcdir=DIR'}
\DoxyCodeLine{     Look for the package's source code in directory DIR.  Usually}
\DoxyCodeLine{     `configure' can determine that directory automatically.}
\DoxyCodeLine{}
\DoxyCodeLine{`-\/-\/version'}
\DoxyCodeLine{     Print the version of Autoconf used to generate the `configure'}
\DoxyCodeLine{     script, and exit.}
\DoxyCodeLine{}
\DoxyCodeLine{`configure' also accepts some other, not widely useful, options.}
\end{DoxyCodeInclude}
 