Index of /bashinfo/source/readline-5.0.5
Name Last modified Size Description
![[DIR]](/spicons/back.gif)
Parent Directory -
![[TXT]](/spicons/text.gif)
CHANGELOG 22-Apr-2004 16:54 19K
CHANGES 19-Jul-2004 16:02 32K
COPYING 05-Aug-1999 10:46 18K
INSTALL 26-Sep-2003 16:27 11K
MANIFEST 21-Jul-2004 08:56 2.1K
Makefile.in 22-Apr-2004 16:44 16K
NEWS 29-Jun-2004 10:57 2.3K
![[ ]](/spicons/unknown.gif)
USAGE 23-Jul-1999 10:09 2.0K
aclocal.m4 13-May-2004 13:37 124K
ansi_stdlib.h 17-Oct-2001 16:08 1.5K
bind.c 03-Mar-2004 22:39 53K
callback.c 31-Jan-2003 13:14 4.2K
chardefs.h 01-Feb-2003 17:43 4.5K
compat.c 22-Aug-2001 09:38 2.5K
complete.c 01-Jul-2004 13:57 63K
config.h.in 03-Feb-2003 16:49 4.8K
configure 29-Jun-2004 10:58 225K
configure.in 29-Jun-2004 10:58 5.2K
display.c 08-Sep-2004 11:19 65K
![[DIR]](/spicons/folder.gif)
doc/ 22-May-2005 04:04 -
emacs_keymap.c 29-Nov-2001 12:04 37K
examples/ 22-May-2005 04:04 -
funmap.c 28-Jan-2004 15:41 8.7K
histexpand.c 22-Mar-2004 08:27 38K
histfile.c 03-Mar-2004 22:39 13K
histlib.h 12-Mar-2002 11:26 2.4K
history.c 15-Jul-2003 16:04 11K
history.h 31-Jul-2003 08:38 10K
histsearch.c 22-Sep-2003 08:58 4.9K
input.c 12-Jul-2004 15:33 12K
isearch.c 13-Mar-2002 08:22 15K
keymaps.c 07-Oct-2002 13:25 3.5K
keymaps.h 20-Nov-2001 12:42 3.4K
kill.c 28-Jan-2004 15:38 15K
macro.c 13-Mar-2002 16:44 6.6K
mbutil.c 08-Sep-2004 11:20 8.4K
misc.c 08-Sep-2004 11:19 12K
nls.c 18-Oct-2002 22:05 6.1K
parens.c 03-Mar-2004 22:39 4.7K
posixdir.h 22-Mar-2004 16:00 2.0K
posixjmp.h 05-Aug-1999 07:50 1.3K
posixstat.h 05-Aug-1999 07:51 4.3K
readline.c 18-Sep-2003 11:04 26K
readline.h 13-Jul-2004 10:54 33K
rlconf.h 22-Jan-2002 12:54 2.1K
rldefs.h 27-Aug-2003 15:57 4.6K
rlmbutil.h 13-May-2003 09:38 4.1K
rlprivate.h 08-May-2004 19:38 9.5K
rlshell.h 22-Aug-2001 09:37 1.4K
rlstdc.h 30-May-2003 15:08 1.5K
rltty.c 31-Jan-2003 23:35 22K
rltty.h 31-Jan-2003 22:43 2.6K
rltypedefs.h 28-Jan-2004 13:31 2.9K
rlwinsize.h 05-Aug-1999 08:13 2.1K
savestring.c 09-Dec-2003 16:06 1.3K
search.c 25-Sep-2003 08:51 12K
shell.c 29-Sep-2003 11:42 4.4K
shlib/ 22-May-2005 04:04 -
signals.c 23-Apr-2003 08:32 11K
support/ 22-May-2005 04:04 -
tcap.h 05-Aug-1999 08:15 1.7K
terminal.c 18-Sep-2003 11:03 17K
text.c 10-May-2004 08:45 34K
tilde.c 12-Mar-2002 11:29 12K
tilde.h 20-Dec-2001 14:15 3.0K
undo.c 27-Nov-2001 12:30 5.8K
util.c 27-Aug-2003 15:51 7.7K
vi_keymap.c 29-Nov-2001 12:05 36K
vi_mode.c 08-Sep-2004 11:19 33K
xmalloc.c 02-Aug-2001 12:48 2.2K
xmalloc.h 09-Dec-2003 16:05 1.4K
Introduction
============
This is the Gnu Readline library, version 5.0.
The Readline library provides a set of functions for use by applications
that allow users to edit command lines as they are typed in. Both
Emacs and vi editing modes are available. The Readline library includes
additional functions to maintain a list of previously-entered command
lines, to recall and perhaps reedit those lines, and perform csh-like
history expansion on previous commands.
The history facilites are also placed into a separate library, the
History library, as part of the build process. The History library
may be used without Readline in applications which desire its
capabilities.
The Readline library is free software, distributed under the terms of
the [GNU] General Public License, version 2. For more information, see
the file COPYING.
To build the library, try typing `./configure', then `make'. The
configuration process is automated, so no further intervention should
be necessary. Readline builds with `gcc' by default if it is
available. If you want to use `cc' instead, type
CC=cc ./configure
if you are using a Bourne-style shell. If you are not, the following
may work:
env CC=cc ./configure
Read the file INSTALL in this directory for more information about how
to customize and control the build process.
The file rlconf.h contains C preprocessor defines that enable and disable
certain Readline features.
The special make target `everything' will build the static and shared
libraries (if the target platform supports them) and the examples.
Examples
========
There are several example programs that use Readline features in the
examples directory. The `rl' program is of particular interest. It
is a command-line interface to Readline, suitable for use in shell
scripts in place of `read'.
Shared Libraries
================
There is skeletal support for building shared versions of the
Readline and History libraries. The configure script creates
a Makefile in the `shlib' subdirectory, and typing `make shared'
will cause shared versions of the Readline and History libraries
to be built on supported platforms.
If `configure' is given the `--enable-shared' option, it will attempt
to build the shared libraries by default on supported platforms.
Configure calls the script support/shobj-conf to test whether or
not shared library creation is supported and to generate the values
of variables that are substituted into shlib/Makefile. If you
try to build shared libraries on an unsupported platform, `make'
will display a message asking you to update support/shobj-conf for
your platform.
If you need to update support/shobj-conf, you will need to create
a `stanza' for your operating system and compiler. The script uses
the value of host_os and ${CC} as determined by configure. For
instance, FreeBSD 4.2 with any version of gcc is identified as
`freebsd4.2-gcc*'.
In the stanza for your operating system-compiler pair, you will need to
define several variables. They are:
SHOBJ_CC The C compiler used to compile source files into shareable
object files. This is normally set to the value of ${CC}
by configure, and should not need to be changed.
SHOBJ_CFLAGS Flags to pass to the C compiler ($SHOBJ_CC) to create
position-independent code. If you are using gcc, this
should probably be set to `-fpic'.
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
gcc, a value of `gcc' will probably work.
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.
These should be the flags needed for generic shared object
creation.
SHLIB_XLDFLAGS Additional flags to pass to SHOBJ_LD for shared library
creation. Many systems use the -R option to the link
editor to embed a path within the library for run-time
library searches. A reasonable value for such systems would
be `-R$(libdir)'.
SHLIB_LIBS Any additional libraries that shared libraries should be
linked against when they are created.
SHLIB_LIBSUFF The suffix to add to `libreadline' and `libhistory' when
generating the filename of the shared library. Many systems
use `so'; HP-UX uses `sl'.
SHLIB_LIBVERSION The string to append to the filename to indicate the version
of the shared library. It should begin with $(SHLIB_LIBSUFF),
and possibly include version information that allows the
run-time loader to load the version of the shared library
appropriate for a particular program. Systems using shared
libraries similar to SunOS 4.x use major and minor library
version numbers; for those systems a value of
`$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)$(SHLIB_MINOR)' is appropriate.
Systems based on System V Release 4 don't use minor version
numbers; use `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)' on those systems.
Other Unix versions use different schemes.
SHLIB_STATUS Set this to `supported' when you have defined the other
necessary variables. Make uses this to determine whether
or not shared library creation should be attempted.
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
`make shared'. The shared libraries will be created in the shlib
subdirectory.
If shared libraries are created, `make install' will install them.
You may install only the shared libraries by 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
to install any created shared libraries, run `make install-static'.
Documentation
=============
The documentation for the Readline and History libraries appears in
the `doc' subdirectory. There are three texinfo files and a
Unix-style manual page describing the facilities available in the
Readline library. The texinfo files include both user and
programmer's manuals. HTML versions of the manuals appear in the
`doc' subdirectory as well.
Reporting Bugs
==============
Bug reports for Readline should be sent to:
bug-readline@gnu.org
When reporting a bug, please include the following information:
* the version number and release status of Readline (e.g., 4.2-release)
* the machine and OS that it is running on
* a list of the compilation flags or the contents of `config.h', if
appropriate
* a description of the bug
* a recipe for recreating the bug reliably
* a fix for the bug if you have one!
If you would like to contact the Readline maintainer directly, send mail
to bash-maintainers@gnu.org.
Since Readline is developed along with bash, the bug-bash@gnu.org mailing
list (mirrored to the Usenet newsgroup gnu.bash.bug) often contains
Readline bug reports and fixes.
Chet Ramey
chet@po.cwru.edu