Basic Installation
|
Basic Installation
|
==================
|
==================
|
|
|
These are installation instructions for Readline-5.1.
|
These are installation instructions for Readline-5.1.
|
|
|
The simplest way to compile readline is:
|
The simplest way to compile readline is:
|
|
|
1. `cd' to the directory containing the readline source code and type
|
1. `cd' to the directory containing the readline source code and type
|
`./configure' to configure readline for your system. If you're
|
`./configure' to configure readline for your system. If you're
|
using `csh' on an old version of System V, you might need to type
|
using `csh' on an old version of System V, you might need to type
|
`sh ./configure' instead to prevent `csh' from trying to execute
|
`sh ./configure' instead to prevent `csh' from trying to execute
|
`configure' itself.
|
`configure' itself.
|
|
|
Running `configure' takes some time. While running, it prints some
|
Running `configure' takes some time. While running, it prints some
|
messages telling which features it is checking for.
|
messages telling which features it is checking for.
|
|
|
2. Type `make' to compile readline and build the static readline
|
2. Type `make' to compile readline and build the static readline
|
and history libraries. If supported, the shared readline and history
|
and history libraries. If supported, the shared readline and history
|
libraries will be built also. See below for instructions on compiling
|
libraries will be built also. See below for instructions on compiling
|
the other parts of the distribution. Typing `make everything' will
|
the other parts of the distribution. Typing `make everything' will
|
cause the static and shared libraries (if supported) and the example
|
cause the static and shared libraries (if supported) and the example
|
programs to be built.
|
programs to be built.
|
|
|
3. Type `make install' to install the static readline and history
|
3. Type `make install' to install the static readline and history
|
libraries, the readline include files, the documentation, and, if
|
libraries, the readline include files, the documentation, and, if
|
supported, the shared readline and history libraries.
|
supported, the shared readline and history libraries.
|
|
|
4. You can remove the created libraries and object files from the
|
4. You can remove the created libraries and object files from the
|
build directory by typing `make clean'. To also remove the
|
build directory by typing `make clean'. To also remove the
|
files that `configure' created (so you can compile readline for
|
files that `configure' created (so you can compile readline for
|
a different kind of computer), type `make distclean'. There is
|
a different kind of computer), type `make distclean'. There is
|
also a `make maintainer-clean' target, but that is intended mainly
|
also a `make maintainer-clean' target, but that is intended mainly
|
for the readline developers, and should be used with care.
|
for the readline developers, and should be used with care.
|
|
|
The `configure' shell script attempts to guess correct values for
|
The `configure' shell script attempts to guess correct values for
|
various system-dependent variables used during compilation. It
|
various system-dependent variables used during compilation. It
|
uses those values to create a `Makefile' in the build directory,
|
uses those values to create a `Makefile' in the build directory,
|
and Makefiles in the `doc', `shlib', and `examples'
|
and Makefiles in the `doc', `shlib', and `examples'
|
subdirectories. It also creates a `config.h' file containing
|
subdirectories. It also creates a `config.h' file containing
|
system-dependent definitions. Finally, it creates a shell script
|
system-dependent definitions. Finally, it creates a shell script
|
`config.status' that you can run in the future to recreate the
|
`config.status' that you can run in the future to recreate the
|
current configuration, a file `config.cache' that saves the
|
current configuration, a file `config.cache' that saves the
|
results of its tests to speed up reconfiguring, and a file
|
results of its tests to speed up reconfiguring, and a file
|
`config.log' containing compiler output (useful mainly for
|
`config.log' containing compiler output (useful mainly for
|
debugging `configure').
|
debugging `configure').
|
|
|
If you need to do unusual things to compile readline, please try
|
If you need to do unusual things to compile readline, please try
|
to figure out how `configure' could check whether to do them, and
|
to figure out how `configure' could check whether to do them, and
|
mail diffs or instructions to so they can
|
mail diffs or instructions to so they can
|
be considered for the next release. If at some point
|
be considered for the next release. If at some point
|
`config.cache' contains results you don't want to keep, you may
|
`config.cache' contains results you don't want to keep, you may
|
remove or edit it.
|
remove or edit it.
|
|
|
The file `configure.in' is used to create `configure' by a
|
The file `configure.in' is used to create `configure' by a
|
program called `autoconf'. You only need `configure.in' if you
|
program called `autoconf'. You only need `configure.in' if you
|
want to change it or regenerate `configure' using a newer version
|
want to change it or regenerate `configure' using a newer version
|
of `autoconf'. The readline `configure.in' requires autoconf
|
of `autoconf'. The readline `configure.in' requires autoconf
|
version 2.50 or newer.
|
version 2.50 or newer.
|
|
|
Compilers and Options
|
Compilers and Options
|
=====================
|
=====================
|
|
|
Some systems require unusual options for compilation or linking that
|
Some systems require unusual options for compilation or linking that
|
the `configure' script does not know about. You can give `configure'
|
the `configure' script does not know about. You can give `configure'
|
initial values for variables by setting them in the environment. Using
|
initial values for variables by setting them in the environment. Using
|
a Bourne-compatible shell, you can do that on the command line like
|
a Bourne-compatible shell, you can do that on the command line like
|
this:
|
this:
|
|
|
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
|
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
|
|
|
Or on systems that have the `env' program, you can do it like this:
|
Or on systems that have the `env' program, you can do it like this:
|
|
|
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
|
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
|
|
|
Compiling For Multiple Architectures
|
Compiling For Multiple Architectures
|
====================================
|
====================================
|
|
|
You can compile readline for more than one kind of computer at the
|
You can compile readline for more than one kind of computer at the
|
same time, by placing the object files for each architecture in their
|
same time, by placing the object files for each architecture in their
|
own directory. To do this, you must use a version of `make' that
|
own directory. To do this, you must use a version of `make' that
|
supports the `VPATH' variable, such as GNU `make'. `cd' to the
|
supports the `VPATH' variable, such as GNU `make'. `cd' to the
|
directory where you want the object files and executables to go and run
|
directory where you want the object files and executables to go and run
|
the `configure' script. `configure' automatically checks for the
|
the `configure' script. `configure' automatically checks for the
|
source code in the directory that `configure' is in and in `..'.
|
source code in the directory that `configure' is in and in `..'.
|
|
|
If you have to use a `make' that does not supports the `VPATH'
|
If you have to use a `make' that does not supports the `VPATH'
|
variable, you have to compile readline for one architecture at a
|
variable, you have to compile readline for one architecture at a
|
time in the source code directory. After you have installed
|
time in the source code directory. After you have installed
|
readline for one architecture, use `make distclean' before
|
readline for one architecture, use `make distclean' before
|
reconfiguring for another architecture.
|
reconfiguring for another architecture.
|
|
|
Installation Names
|
Installation Names
|
==================
|
==================
|
|
|
By default, `make install' will install the readline libraries in
|
By default, `make install' will install the readline libraries in
|
`/usr/local/lib', the include files in
|
`/usr/local/lib', the include files in
|
`/usr/local/include/readline', the man pages in `/usr/local/man',
|
`/usr/local/include/readline', the man pages in `/usr/local/man',
|
and the info files in `/usr/local/info'. You can specify an
|
and the info files in `/usr/local/info'. You can specify an
|
installation prefix other than `/usr/local' by giving `configure'
|
installation prefix other than `/usr/local' by giving `configure'
|
the option `--prefix=PATH' or by supplying a value for the
|
the option `--prefix=PATH' or by supplying a value for the
|
DESTDIR variable when running `make install'.
|
DESTDIR variable when running `make install'.
|
|
|
You can specify separate installation prefixes for
|
You can specify separate installation prefixes for
|
architecture-specific files and architecture-independent files.
|
architecture-specific files and architecture-independent files.
|
If you give `configure' the option `--exec-prefix=PATH', the
|
If you give `configure' the option `--exec-prefix=PATH', the
|
readline Makefiles will use PATH as the prefix for installing the
|
readline Makefiles will use PATH as the prefix for installing the
|
libraries. Documentation and other data files will still use the
|
libraries. Documentation and other data files will still use the
|
regular prefix.
|
regular prefix.
|
|
|
Specifying the System Type
|
Specifying the System Type
|
==========================
|
==========================
|
|
|
There may be some features `configure' can not figure out
|
There may be some features `configure' can not figure out
|
automatically, but need to determine by the type of host readline
|
automatically, but need to determine by the type of host readline
|
will run on. Usually `configure' can figure that out, but if it
|
will run on. Usually `configure' can figure that out, but if it
|
prints a message saying it can not guess the host type, give it
|
prints a message saying it can not guess the host type, give it
|
the `--host=TYPE' option. TYPE can either be a short name for
|
the `--host=TYPE' option. TYPE can either be a short name for
|
the system type, such as `sun4', or a canonical name with three
|
the system type, such as `sun4', or a canonical name with three
|
fields: CPU-COMPANY-SYSTEM (e.g., i386-unknown-freebsd4.2).
|
fields: CPU-COMPANY-SYSTEM (e.g., i386-unknown-freebsd4.2).
|
|
|
See the file `config.sub' for the possible values of each field.
|
See the file `config.sub' for the possible values of each field.
|
|
|
Sharing Defaults
|
Sharing Defaults
|
================
|
================
|
|
|
If you want to set default values for `configure' scripts to share,
|
If you want to set default values for `configure' scripts to share,
|
you can create a site shell script called `config.site' that gives
|
you can create a site shell script called `config.site' that gives
|
default values for variables like `CC', `cache_file', and `prefix'.
|
default values for variables like `CC', `cache_file', and `prefix'.
|
`configure' looks for `PREFIX/share/config.site' if it exists, then
|
`configure' looks for `PREFIX/share/config.site' if it exists, then
|
`PREFIX/etc/config.site' if it exists. Or, you can set the
|
`PREFIX/etc/config.site' if it exists. Or, you can set the
|
`CONFIG_SITE' environment variable to the location of the site script.
|
`CONFIG_SITE' environment variable to the location of the site script.
|
A warning: the readline `configure' looks for a site script, but not
|
A warning: the readline `configure' looks for a site script, but not
|
all `configure' scripts do.
|
all `configure' scripts do.
|
|
|
Operation Controls
|
Operation Controls
|
==================
|
==================
|
|
|
`configure' recognizes the following options to control how it
|
`configure' recognizes the following options to control how it
|
operates.
|
operates.
|
|
|
`--cache-file=FILE'
|
`--cache-file=FILE'
|
Use and save the results of the tests in FILE instead of
|
Use and save the results of the tests in FILE instead of
|
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
|
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
|
debugging `configure'.
|
debugging `configure'.
|
|
|
`--help'
|
`--help'
|
Print a summary of the options to `configure', and exit.
|
Print a summary of the options to `configure', and exit.
|
|
|
`--quiet'
|
`--quiet'
|
`--silent'
|
`--silent'
|
`-q'
|
`-q'
|
Do not print messages saying which checks are being made.
|
Do not print messages saying which checks are being made.
|
|
|
`--srcdir=DIR'
|
`--srcdir=DIR'
|
Look for the package's source code in directory DIR. Usually
|
Look for the package's source code in directory DIR. Usually
|
`configure' can determine that directory automatically.
|
`configure' can determine that directory automatically.
|
|
|
`--version'
|
`--version'
|
Print the version of Autoconf used to generate the `configure'
|
Print the version of Autoconf used to generate the `configure'
|
script, and exit.
|
script, and exit.
|
|
|
`configure' also accepts some other, not widely useful, options.
|
`configure' also accepts some other, not widely useful, options.
|
|
|
Optional Features
|
Optional Features
|
=================
|
=================
|
|
|
The readline `configure' recognizes a single `--with-PACKAGE' option:
|
The readline `configure' recognizes a single `--with-PACKAGE' option:
|
|
|
`--with-curses'
|
`--with-curses'
|
This tells readline that it can find the termcap library functions
|
This tells readline that it can find the termcap library functions
|
(tgetent, et al.) in the curses library, rather than a separate
|
(tgetent, et al.) in the curses library, rather than a separate
|
termcap library. Readline uses the termcap functions, but does not
|
termcap library. Readline uses the termcap functions, but does not
|
link with the termcap or curses library itself, allowing applications
|
link with the termcap or curses library itself, allowing applications
|
which link with readline the to choose an appropriate library.
|
which link with readline the to choose an appropriate library.
|
This option tells readline to link the example programs with the
|
This option tells readline to link the example programs with the
|
curses library rather than libtermcap.
|
curses library rather than libtermcap.
|
|
|
`configure' also recognizes two `--enable-FEATURE' options:
|
`configure' also recognizes two `--enable-FEATURE' options:
|
|
|
`--enable-shared'
|
`--enable-shared'
|
Build the shared libraries by default on supported platforms. The
|
Build the shared libraries by default on supported platforms. The
|
default is `yes'.
|
default is `yes'.
|
|
|
`--enable-static'
|
`--enable-static'
|
Build the static libraries by default. The default is `yes'.
|
Build the static libraries by default. The default is `yes'.
|
|
|
Shared Libraries
|
Shared Libraries
|
================
|
================
|
|
|
There is support for building shared versions of the readline and
|
There is support for building shared versions of the readline and
|
history libraries. The configure script creates a Makefile in
|
history libraries. The configure script creates a Makefile in
|
the `shlib' subdirectory, and typing `make shared' will cause
|
the `shlib' subdirectory, and typing `make shared' will cause
|
shared versions of the readline and history libraries to be built
|
shared versions of the readline and history libraries to be built
|
on supported platforms.
|
on supported platforms.
|
|
|
If `configure' is given the `--enable-shared' option, it will attempt
|
If `configure' is given the `--enable-shared' option, it will attempt
|
to build the shared libraries by default on supported platforms.
|
to build the shared libraries by default on supported platforms.
|
|
|
Configure calls the script support/shobj-conf to test whether or
|
Configure calls the script support/shobj-conf to test whether or
|
not shared library creation is supported and to generate the values
|
not shared library creation is supported and to generate the values
|
of variables that are substituted into shlib/Makefile. If you
|
of variables that are substituted into shlib/Makefile. If you
|
try to build shared libraries on an unsupported platform, `make'
|
try to build shared libraries on an unsupported platform, `make'
|
will display a message asking you to update support/shobj-conf for
|
will display a message asking you to update support/shobj-conf for
|
your platform.
|
your platform.
|
|
|
If you need to update support/shobj-conf, you will need to create
|
If you need to update support/shobj-conf, you will need to create
|
a `stanza' for your operating system and compiler. The script uses
|
a `stanza' for your operating system and compiler. The script uses
|
the value of host_os and ${CC} as determined by configure. For
|
the value of host_os and ${CC} as determined by configure. For
|
instance, FreeBSD 4.2 with any version of gcc is identified as
|
instance, FreeBSD 4.2 with any version of gcc is identified as
|
`freebsd4.2-gcc*'.
|
`freebsd4.2-gcc*'.
|
|
|
In the stanza for your operating system-compiler pair, you will need to
|
In the stanza for your operating system-compiler pair, you will need to
|
define several variables. They are:
|
define several variables. They are:
|
|
|
SHOBJ_CC The C compiler used to compile source files into shareable
|
SHOBJ_CC The C compiler used to compile source files into shareable
|
object files. This is normally set to the value of ${CC}
|
object files. This is normally set to the value of ${CC}
|
by configure, and should not need to be changed.
|
by configure, and should not need to be changed.
|
|
|
SHOBJ_CFLAGS Flags to pass to the C compiler ($SHOBJ_CC) to create
|
SHOBJ_CFLAGS Flags to pass to the C compiler ($SHOBJ_CC) to create
|
position-independent code. If you are using gcc, this
|
position-independent code. If you are using gcc, this
|
should probably be set to `-fpic'.
|
should probably be set to `-fpic'.
|
|
|
SHOBJ_LD The link editor to be used to create the shared library from
|
SHOBJ_LD The link editor to be used to create the shared library from
|
the object files created by $SHOBJ_CC. If you are using
|
the object files created by $SHOBJ_CC. If you are using
|
gcc, a value of `gcc' will probably work.
|
gcc, a value of `gcc' will probably work.
|
|
|
SHOBJ_LDFLAGS Flags to pass to SHOBJ_LD to enable shared object creation.
|
SHOBJ_LDFLAGS Flags to pass to SHOBJ_LD to enable shared object creation.
|
If you are using gcc, `-shared' may be all that is necessary.
|
If you are using gcc, `-shared' may be all that is necessary.
|
These should be the flags needed for generic shared object
|
These should be the flags needed for generic shared object
|
creation.
|
creation.
|
|
|
SHLIB_XLDFLAGS Additional flags to pass to SHOBJ_LD for shared library
|
SHLIB_XLDFLAGS Additional flags to pass to SHOBJ_LD for shared library
|
creation. Many systems use the -R option to the link
|
creation. Many systems use the -R option to the link
|
editor to embed a path within the library for run-time
|
editor to embed a path within the library for run-time
|
library searches. A reasonable value for such systems would
|
library searches. A reasonable value for such systems would
|
be `-R$(libdir)'.
|
be `-R$(libdir)'.
|
|
|
SHLIB_LIBS Any additional libraries that shared libraries should be
|
SHLIB_LIBS Any additional libraries that shared libraries should be
|
linked against when they are created.
|
linked against when they are created.
|
|
|
SHLIB_LIBPREF The prefix to use when generating the filename of the shared
|
SHLIB_LIBPREF The prefix to use when generating the filename of the shared
|
library. The default is `lib'; Cygwin uses `cyg'.
|
library. The default is `lib'; Cygwin uses `cyg'.
|
|
|
SHLIB_LIBSUFF The suffix to add to `libreadline' and `libhistory' when
|
SHLIB_LIBSUFF The suffix to add to `libreadline' and `libhistory' when
|
generating the filename of the shared library. Many systems
|
generating the filename of the shared library. Many systems
|
use `so'; HP-UX uses `sl'.
|
use `so'; HP-UX uses `sl'.
|
|
|
SHLIB_LIBVERSION The string to append to the filename to indicate the version
|
SHLIB_LIBVERSION The string to append to the filename to indicate the version
|
of the shared library. It should begin with $(SHLIB_LIBSUFF),
|
of the shared library. It should begin with $(SHLIB_LIBSUFF),
|
and possibly include version information that allows the
|
and possibly include version information that allows the
|
run-time loader to load the version of the shared library
|
run-time loader to load the version of the shared library
|
appropriate for a particular program. Systems using shared
|
appropriate for a particular program. Systems using shared
|
libraries similar to SunOS 4.x use major and minor library
|
libraries similar to SunOS 4.x use major and minor library
|
version numbers; for those systems a value of
|
version numbers; for those systems a value of
|
`$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)$(SHLIB_MINOR)' is appropriate.
|
`$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)$(SHLIB_MINOR)' is appropriate.
|
Systems based on System V Release 4 don't use minor version
|
Systems based on System V Release 4 don't use minor version
|
numbers; use `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)' on those systems.
|
numbers; use `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)' on those systems.
|
Other Unix versions use different schemes.
|
Other Unix versions use different schemes.
|
|
|
SHLIB_DLLVERSION The version number for shared libraries that determines API
|
SHLIB_DLLVERSION The version number for shared libraries that determines API
|
compatibility between readline versions and the underlying
|
compatibility between readline versions and the underlying
|
system. Used only on Cygwin. Defaults to $SHLIB_MAJOR, but
|
system. Used only on Cygwin. Defaults to $SHLIB_MAJOR, but
|
can be overridden at configuration time by defining DLLVERSION
|
can be overridden at configuration time by defining DLLVERSION
|
in the environment.
|
in the environment.
|
|
|
SHLIB_DOT The character used to separate the name of the shared library
|
SHLIB_DOT The character used to separate the name of the shared library
|
from the suffix and version information. The default is `.';
|
from the suffix and version information. The default is `.';
|
systems like Cygwin which don't separate version information
|
systems like Cygwin which don't separate version information
|
from the library name should set this to the empty string.
|
from the library name should set this to the empty string.
|
|
|
SHLIB_STATUS Set this to `supported' when you have defined the other
|
SHLIB_STATUS Set this to `supported' when you have defined the other
|
necessary variables. Make uses this to determine whether
|
necessary variables. Make uses this to determine whether
|
or not shared library creation should be attempted. If
|
or not shared library creation should be attempted. If
|
shared libraries are not supported, this will be set to
|
shared libraries are not supported, this will be set to
|
`unsupported'.
|
`unsupported'.
|
|
|
You should look at the existing stanzas in support/shobj-conf for ideas.
|
You should look at the existing stanzas in support/shobj-conf for ideas.
|
|
|
Once you have updated support/shobj-conf, re-run configure and type
|
Once you have updated support/shobj-conf, re-run configure and type
|
`make shared' or `make'. The shared libraries will be created in the
|
`make shared' or `make'. The shared libraries will be created in the
|
shlib subdirectory.
|
shlib subdirectory.
|
|
|
If shared libraries are created, `make install' will install them.
|
If shared libraries are created, `make install' will install them.
|
You may install only the shared libraries by running `make
|
You may install only the shared libraries by running `make
|
install-shared' from the top-level build directory. Running `make
|
install-shared' from the top-level build directory. Running `make
|
install' in the shlib subdirectory will also work. If you don't want
|
install' in the shlib subdirectory will also work. If you don't want
|
to install any created shared libraries, run `make install-static'.
|
to install any created shared libraries, run `make install-static'.
|
|
|
