1994-07-19 22:37:37 +08:00
|
|
|
@c This file is included by autoconf.texi and is used to produce
|
|
|
|
@c the INSTALL file.
|
|
|
|
|
|
|
|
@node Basic Installation
|
|
|
|
@section Basic Installation
|
|
|
|
|
1994-07-27 01:15:52 +08:00
|
|
|
These are generic installation instructions.
|
1994-07-19 22:37:37 +08:00
|
|
|
|
|
|
|
The @code{configure} shell script attempts to guess correct values for
|
|
|
|
various system-dependent variables used during compilation. It uses
|
|
|
|
those values to create a @file{Makefile} in each directory of the
|
1994-07-27 01:15:52 +08:00
|
|
|
package. It may also create one or more @file{.h} files containing
|
1994-07-19 22:37:37 +08:00
|
|
|
system-dependent definitions. Finally, it creates a shell script
|
|
|
|
@file{config.status} that you can run in the future to recreate the
|
2000-04-05 15:42:06 +08:00
|
|
|
current configuration, and a file @file{config.log} containing compiler
|
|
|
|
output (useful mainly for debugging @code{configure}).
|
|
|
|
|
|
|
|
It can also use an optional file (typically called @file{config.cache}
|
2000-07-04 18:34:21 +08:00
|
|
|
and enabled with @option{--cache-file=config.cache} or simply
|
2000-06-09 19:37:15 +08:00
|
|
|
@option{-C}) that saves the results of its tests to speed up
|
|
|
|
reconfiguring. (Caching is disabled by default to prevent problems with
|
|
|
|
accidental use of stale cache files.)
|
1994-07-19 22:37:37 +08:00
|
|
|
|
|
|
|
If you need to do unusual things to compile the package, please try to
|
|
|
|
figure out how @code{configure} could check whether to do them, and mail
|
|
|
|
diffs or instructions to the address given in the @file{README} so they
|
2000-04-05 15:42:06 +08:00
|
|
|
can be considered for the next release. If you are using the cache, and
|
|
|
|
at some point @file{config.cache} contains results you don't want to
|
|
|
|
keep, you may remove or edit it.
|
1994-07-19 22:37:37 +08:00
|
|
|
|
2001-01-12 17:19:59 +08:00
|
|
|
The file @file{configure.ac} (or @file{configure.in}) is used to create
|
|
|
|
@file{configure} by a program called @code{autoconf}. You only need
|
|
|
|
@file{configure.ac} if you want to change it or regenerate
|
|
|
|
@file{configure} using a newer version of @code{autoconf}.
|
1994-07-19 22:37:37 +08:00
|
|
|
|
|
|
|
@noindent
|
|
|
|
The simplest way to compile this package is:
|
|
|
|
|
|
|
|
@enumerate
|
|
|
|
@item
|
|
|
|
@code{cd} to the directory containing the package's source code and type
|
|
|
|
@samp{./configure} to configure the package for your system. If you're
|
|
|
|
using @code{csh} on an old version of System V, you might need to type
|
|
|
|
@samp{sh ./configure} instead to prevent @code{csh} from trying to
|
|
|
|
execute @code{configure} itself.
|
|
|
|
|
|
|
|
Running @code{configure} takes awhile. While running, it prints some
|
|
|
|
messages telling which features it is checking for.
|
|
|
|
|
|
|
|
@item
|
|
|
|
Type @samp{make} to compile the package.
|
|
|
|
|
|
|
|
@item
|
|
|
|
Optionally, type @samp{make check} to run any self-tests that come with
|
|
|
|
the package.
|
|
|
|
|
|
|
|
@item
|
|
|
|
Type @samp{make install} to install the programs and any data files and
|
|
|
|
documentation.
|
|
|
|
|
|
|
|
@item
|
1995-02-07 07:31:34 +08:00
|
|
|
You can remove the program binaries and object files from the source code
|
1994-07-19 22:37:37 +08:00
|
|
|
directory by typing @samp{make clean}. To also remove the files that
|
1994-07-27 01:15:52 +08:00
|
|
|
@code{configure} created (so you can compile the package for a different
|
1995-02-07 07:31:34 +08:00
|
|
|
kind of computer), type @samp{make distclean}. There is also a
|
1995-02-08 06:41:14 +08:00
|
|
|
@samp{make maintainer-clean} target, but that is intended mainly for the
|
1995-02-07 07:31:34 +08:00
|
|
|
package's developers. If you use it, you may have to get all sorts of
|
|
|
|
other programs in order to regenerate files that came with the distribution.
|
1994-07-19 22:37:37 +08:00
|
|
|
@end enumerate
|
|
|
|
|
|
|
|
@node Compilers and Options
|
|
|
|
@section Compilers and Options
|
|
|
|
|
1999-10-26 11:54:59 +08:00
|
|
|
Some systems require unusual options for compilation or linking that the
|
|
|
|
@code{configure} script does not know about. Run @samp{./configure
|
|
|
|
--help} for details on some of the pertinent environment variables.
|
1994-07-19 22:37:37 +08:00
|
|
|
|
1999-10-26 11:54:59 +08:00
|
|
|
You can give @code{configure} initial values for variables by setting
|
|
|
|
them in the environment. You can do that on the command line like this:
|
2000-06-09 19:37:15 +08:00
|
|
|
|
1994-07-19 22:37:37 +08:00
|
|
|
@example
|
1999-10-26 11:54:59 +08:00
|
|
|
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
|
1994-07-19 22:37:37 +08:00
|
|
|
@end example
|
|
|
|
|
1999-10-26 11:54:59 +08:00
|
|
|
@xref{Environment Variables}, for more details.
|
|
|
|
|
|
|
|
|
1995-02-07 07:31:34 +08:00
|
|
|
@node Multiple Architectures
|
|
|
|
@section Compiling For Multiple Architectures
|
1994-07-19 22:37:37 +08:00
|
|
|
|
1995-02-07 07:31:34 +08:00
|
|
|
You can compile the package for more than one kind of computer at the
|
|
|
|
same time, by placing the object files for each architecture in their
|
|
|
|
own directory. To do this, you must use a version of @code{make} that
|
|
|
|
supports the @code{VPATH} variable, such as GNU @code{make}. @code{cd}
|
|
|
|
to the directory where you want the object files and executables to go
|
|
|
|
and run the @code{configure} script. @code{configure} automatically
|
|
|
|
checks for the source code in the directory that @code{configure} is in
|
|
|
|
and in @file{..}.
|
|
|
|
|
2000-02-10 02:19:58 +08:00
|
|
|
If you have to use a @code{make} that does not support the @code{VPATH}
|
1995-02-07 07:31:34 +08:00
|
|
|
variable, you have to compile the package for one architecture at a time
|
|
|
|
in the source code directory. After you have installed the package for
|
|
|
|
one architecture, use @samp{make distclean} before reconfiguring for
|
|
|
|
another architecture.
|
1994-07-19 22:37:37 +08:00
|
|
|
|
1994-09-07 23:07:09 +08:00
|
|
|
@node Installation Names
|
|
|
|
@section Installation Names
|
1994-07-19 22:37:37 +08:00
|
|
|
|
|
|
|
By default, @samp{make install} will install the package's files in
|
|
|
|
@file{/usr/local/bin}, @file{/usr/local/man}, etc. You can specify an
|
|
|
|
installation prefix other than @file{/usr/local} by giving
|
2000-06-09 19:37:15 +08:00
|
|
|
@code{configure} the option @option{--prefix=@var{path}}.
|
1994-07-19 22:37:37 +08:00
|
|
|
|
|
|
|
You can specify separate installation prefixes for architecture-specific
|
|
|
|
files and architecture-independent files. If you give @code{configure}
|
2000-06-09 19:37:15 +08:00
|
|
|
the option @option{--exec-prefix=@var{path}}, the package will use
|
1994-07-19 22:37:37 +08:00
|
|
|
@var{path} as the prefix for installing programs and libraries.
|
|
|
|
Documentation and other data files will still use the regular prefix.
|
|
|
|
|
1995-06-28 03:09:03 +08:00
|
|
|
In addition, if you use an unusual directory layout you can give options
|
2000-06-09 19:37:15 +08:00
|
|
|
like @option{--bindir=@var{path}} to specify different values for
|
1995-06-28 03:09:03 +08:00
|
|
|
particular kinds of files. Run @samp{configure --help} for a list of
|
|
|
|
the directories you can set and what kinds of files go in them.
|
|
|
|
|
1994-09-07 23:07:09 +08:00
|
|
|
If the package supports it, you can cause programs to be installed with
|
|
|
|
an extra prefix or suffix on their names by giving @code{configure} the
|
2000-06-09 19:37:15 +08:00
|
|
|
option @option{--program-prefix=@var{PREFIX}} or
|
|
|
|
@option{--program-suffix=@var{SUFFIX}}.
|
1994-09-07 23:07:09 +08:00
|
|
|
|
1994-09-28 06:05:22 +08:00
|
|
|
@node Optional Features
|
|
|
|
@section Optional Features
|
|
|
|
|
2000-06-09 19:37:15 +08:00
|
|
|
Some packages pay attention to @option{--enable-@var{feature}} options
|
|
|
|
to @code{configure}, where @var{feature} indicates an optional part of
|
|
|
|
the package. They may also pay attention to
|
|
|
|
@option{--with-@var{package}} options, where @var{package} is something
|
|
|
|
like @samp{gnu-as} or @samp{x} (for the X Window System). The
|
|
|
|
@file{README} should mention any @option{--enable-} and @option{--with-}
|
|
|
|
options that the package recognizes.
|
1994-09-28 06:05:22 +08:00
|
|
|
|
|
|
|
For packages that use the X Window System, @code{configure} can usually
|
|
|
|
find the X include and library files automatically, but if it doesn't,
|
2000-06-09 19:37:15 +08:00
|
|
|
you can use the @code{configure} options @option{--x-includes=@var{dir}}
|
|
|
|
and @option{--x-libraries=@var{dir}} to specify their locations.
|
1994-09-28 06:05:22 +08:00
|
|
|
|
1994-07-19 22:37:37 +08:00
|
|
|
@node System Type
|
|
|
|
@section Specifying the System Type
|
|
|
|
|
1999-09-24 12:24:32 +08:00
|
|
|
There may be some features @code{configure} cannot figure out
|
1994-07-19 22:37:37 +08:00
|
|
|
automatically, but needs to determine by the type of host the package
|
|
|
|
will run on. Usually @code{configure} can figure that out, but if it
|
1999-09-24 12:24:32 +08:00
|
|
|
prints a message saying it cannot guess the host type, give it the
|
2000-06-30 21:34:37 +08:00
|
|
|
@option{--build=@var{type}} option. @var{type} can either be a short
|
2000-06-09 19:37:15 +08:00
|
|
|
name for the system type, such as @samp{sun4}, or a canonical name which
|
|
|
|
has the form:
|
2000-05-19 20:40:45 +08:00
|
|
|
|
1994-07-19 22:37:37 +08:00
|
|
|
@example
|
|
|
|
@var{cpu}-@var{company}-@var{system}
|
|
|
|
@end example
|
2000-05-19 20:40:45 +08:00
|
|
|
|
1994-07-19 22:37:37 +08:00
|
|
|
@noindent
|
2000-05-19 20:40:45 +08:00
|
|
|
where @var{system} can have one of these forms:
|
|
|
|
|
|
|
|
@example
|
|
|
|
@var{os}
|
|
|
|
@var{kernel}-@var{os}
|
|
|
|
@end example
|
|
|
|
|
1994-07-19 22:37:37 +08:00
|
|
|
See the file @file{config.sub} for the possible values of each field.
|
1994-07-27 01:15:52 +08:00
|
|
|
If @file{config.sub} isn't included in this package, then this package
|
|
|
|
doesn't need to know the host type.
|
1994-07-19 22:37:37 +08:00
|
|
|
|
2000-11-29 00:53:56 +08:00
|
|
|
If you are @emph{building} compiler tools for cross-compiling, you should
|
|
|
|
use the @option{--target=@var{type}} option to select the type of system
|
|
|
|
they will produce code for.
|
2000-06-30 21:34:37 +08:00
|
|
|
|
|
|
|
If you want to @emph{use} a cross compiler, that generates code for a
|
|
|
|
platform different from the build platform, you should specify the host
|
|
|
|
platform (i.e., that on which the generated programs will eventually be
|
|
|
|
run) with @option{--host=@var{type}}. In this case, you should also
|
|
|
|
specify the build platform with @option{--build=@var{type}}, because, in
|
|
|
|
this case, it may not be possible to guess the build platform (it
|
|
|
|
sometimes involves compiling and running simple test programs, and this
|
|
|
|
can't be done if the compiler is a cross compiler).
|
1994-07-19 22:37:37 +08:00
|
|
|
|
1994-09-28 06:05:22 +08:00
|
|
|
@node Sharing Defaults
|
|
|
|
@section Sharing Defaults
|
1994-07-19 22:37:37 +08:00
|
|
|
|
1994-09-28 06:05:22 +08:00
|
|
|
If you want to set default values for @code{configure} scripts to share,
|
|
|
|
you can create a site shell script called @file{config.site} that gives
|
|
|
|
default values for variables like @code{CC}, @code{cache_file}, and
|
|
|
|
@code{prefix}. @code{configure} looks for
|
1994-10-19 08:30:09 +08:00
|
|
|
@file{@var{prefix}/share/config.site} if it exists, then
|
2000-02-10 02:19:58 +08:00
|
|
|
@file{@var{prefix}/etc/config.site} if it exists. Or, you can set the
|
|
|
|
@code{CONFIG_SITE} environment variable to the location of the site
|
|
|
|
script. A warning: not all @code{configure} scripts look for a site
|
|
|
|
script.
|
1994-07-19 22:37:37 +08:00
|
|
|
|
1999-10-26 11:54:59 +08:00
|
|
|
@node Environment Variables
|
|
|
|
@section Environment Variables
|
|
|
|
|
|
|
|
Variables not defined in a site shell script can be set in the
|
|
|
|
environment passed to configure. However, some packages may run
|
|
|
|
configure again during the build, and the customized values of these
|
|
|
|
variables may be lost. In order to avoid this problem, you should set
|
|
|
|
them in the @code{configure} command line, using @samp{VAR=value}. For
|
|
|
|
example:
|
2000-02-10 02:19:58 +08:00
|
|
|
|
1999-10-26 11:54:59 +08:00
|
|
|
@example
|
|
|
|
./configure CC=/usr/local2/bin/gcc
|
|
|
|
@end example
|
2000-02-10 02:19:58 +08:00
|
|
|
|
|
|
|
@noindent
|
1999-10-26 11:54:59 +08:00
|
|
|
will cause the specified gcc to be used as the C compiler (unless it is
|
|
|
|
overridden in the site shell script).
|
|
|
|
|
|
|
|
|
2000-05-27 01:12:01 +08:00
|
|
|
@node configure Invocation
|
|
|
|
@section @code{configure} Invocation
|
1994-09-28 06:05:22 +08:00
|
|
|
|
|
|
|
@code{configure} recognizes the following options to control how it
|
|
|
|
operates.
|
1994-07-19 22:37:37 +08:00
|
|
|
|
2000-06-09 19:37:15 +08:00
|
|
|
@table @option
|
2000-02-10 02:19:58 +08:00
|
|
|
@item --help
|
|
|
|
@itemx -h
|
|
|
|
Print a summary of the options to @code{configure}, and exit.
|
|
|
|
|
|
|
|
@item --version
|
2000-03-03 02:17:26 +08:00
|
|
|
@itemx -V
|
2000-02-10 02:19:58 +08:00
|
|
|
Print the version of Autoconf used to generate the @code{configure}
|
|
|
|
script, and exit.
|
|
|
|
|
1994-09-06 04:12:21 +08:00
|
|
|
@item --cache-file=@var{file}
|
2000-04-05 15:42:06 +08:00
|
|
|
@cindex Cache, enabling
|
|
|
|
Enable the cache: use and save the results of the tests in @var{file},
|
2000-07-04 18:34:21 +08:00
|
|
|
traditionally @file{config.cache}. @var{file} defaults to
|
2000-04-05 15:42:06 +08:00
|
|
|
@file{/dev/null} to disable caching.
|
1994-09-06 04:12:21 +08:00
|
|
|
|
2000-05-22 21:31:00 +08:00
|
|
|
@item --config-cache
|
|
|
|
@itemx -C
|
2000-07-04 18:34:21 +08:00
|
|
|
Alias for @option{--cache-file=config.cache}.
|
2000-05-22 21:31:00 +08:00
|
|
|
|
1994-07-27 01:15:52 +08:00
|
|
|
@item --quiet
|
|
|
|
@itemx --silent
|
|
|
|
@itemx -q
|
2000-02-10 02:19:58 +08:00
|
|
|
Do not print messages saying which checks are being made. To suppress
|
|
|
|
all normal output, redirect it to @file{/dev/null} (any error messages
|
|
|
|
will still be shown).
|
1994-07-19 22:37:37 +08:00
|
|
|
|
|
|
|
@item --srcdir=@var{dir}
|
|
|
|
Look for the package's source code in directory @var{dir}. Usually
|
|
|
|
@code{configure} can determine that directory automatically.
|
|
|
|
@end table
|
|
|
|
|
|
|
|
@noindent
|
1994-09-10 04:13:30 +08:00
|
|
|
@code{configure} also accepts some other, not widely useful, options.
|
2000-02-10 02:19:58 +08:00
|
|
|
Run @samp{configure --help} for more details.
|
2001-08-12 21:17:35 +08:00
|
|
|
|
|
|
|
@node INSTALL Copyright Notice
|
|
|
|
@section Copyright Notice for the @file{INSTALL} File
|
|
|
|
|
|
|
|
Copyright 1994, 1995, 1996, 1999, 2000, 2001 Free Software Foundation, Inc.
|
|
|
|
|
|
|
|
The @file{INSTALL} file is free documentation; the Free Software
|
|
|
|
Foundation gives unlimited permission to copy, distribute and modify it.
|