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