Name Date Size

..18-Aug.-20214 KiB

._.gitignoreH A D06-Mar.-20184 KiB

.gitignoreH A D06-Mar.-2018399

aclocal.m4H A D18-Jan.-202156 KiB

ansi_stdlib.hH A D13-Aug.-20171.4 KiB

bind.cH A D04-May-202173.6 KiB

callback.cH A D07-Jan.-201910 KiB

CHANGELOGH A D18-Jan.-202135.3 KiB

CHANGESH A D18-Jan.-202174.6 KiB

chardefs.hH A D13-Aug.-20174.6 KiB

colors.cH A D18-Jan.-20217.9 KiB

colors.hH A D13-Aug.-20173.5 KiB

compat.cH A D07-Jan.-20192.3 KiB

complete.cH A D18-Jan.-202187.7 KiB

config.h.inH A D07-Jan.-20196.8 KiB

configureH A D18-Jan.-2021220.9 KiB

configure.acH A D18-Jan.-20218.8 KiB

COPYINGH A D13-Aug.-201734.3 KiB

display.cH A D18-Jan.-2021113.3 KiB

doc/H18-Jan.-20214 KiB

emacs_keymap.cH A D18-Jan.-202136.8 KiB

examples/H18-Jan.-20214 KiB

funmap.cH A D18-Jan.-20219.6 KiB

histexpand.cH A D18-Jan.-202141.5 KiB

histfile.cH A D18-Jan.-202121.6 KiB

histlib.hH A D07-Jan.-20192.4 KiB

history.cH A D07-Jan.-201915.3 KiB

history.hH A D07-Jan.-201910.5 KiB

histsearch.cH A D07-Jan.-20197 KiB

input.cH A D18-Jan.-202116.1 KiB

INSTALLH A D18-Jan.-202112.2 KiB

isearch.cH A D18-Jan.-202126.1 KiB

keymaps.cH A D07-Jan.-20194 KiB

keymaps.hH A D07-Jan.-20193.2 KiB

kill.cH A D18-Jan.-202119.3 KiB

macro.cH A D07-Jan.-20198 KiB

Makefile.inH A D18-Jan.-202118.8 KiB

MANIFESTH A D07-Jan.-20192.8 KiB

mbutil.cH A D18-Jan.-202112.2 KiB

misc.cH A D18-Jan.-202117.7 KiB

NEWSH A D18-Jan.-202118.3 KiB

nls.cH A D07-Jan.-20196.8 KiB

parens.cH A D07-Jan.-20194.7 KiB

parse-colors.cH A D07-Jan.-201912.8 KiB

parse-colors.hH A D13-Aug.-20171.5 KiB

patchlevelH A D04-May-202149

posixdir.hH A D18-Jan.-20212.3 KiB

posixjmp.hH A D13-Aug.-20171.4 KiB

posixselect.hH A D13-Aug.-20171.3 KiB

posixstat.hH A D18-Jan.-20214.9 KiB

readline.cH A D18-Jan.-202143.2 KiB

readline.hH A D18-Jan.-202138.8 KiB

readline.pc.inH A D18-Jan.-2021332

READMEH A D18-Jan.-20217.8 KiB

rlconf.hH A D07-Jan.-20192.8 KiB

rldefs.hH A D13-Aug.-20174.8 KiB

rlmbutil.hH A D18-Jan.-20216.9 KiB

rlprivate.hH A D18-Jan.-202118.6 KiB

rlshell.hH A D13-Aug.-20171.2 KiB

rlstdc.hH A D13-Aug.-20171.8 KiB

rltty.cH A D07-Jan.-201923.2 KiB

rltty.hH A D13-Aug.-20172.5 KiB

rltypedefs.hH A D13-Aug.-20173.1 KiB

rlwinsize.hH A D13-Aug.-20172.2 KiB

savestring.cH A D07-Jan.-20191.3 KiB

search.cH A D18-Jan.-202118.4 KiB

shell.cH A D07-Jan.-20194.6 KiB

shlib/H18-Jan.-20214 KiB

signals.cH A D18-Jan.-202120.6 KiB

support/H18-Jan.-20214 KiB

tcap.hH A D13-Aug.-20171.6 KiB

terminal.cH A D18-Jan.-202121.4 KiB

text.cH A D18-Jan.-202141.9 KiB

tilde.cH A D18-Jan.-202112.8 KiB

tilde.hH A D13-Aug.-20173 KiB

undo.cH A D18-Jan.-20218 KiB

USAGEH A D13-Aug.-20172 KiB

util.cH A D18-Jan.-202111.8 KiB

vi_keymap.cH A D07-Jan.-201935.7 KiB

vi_mode.cH A D18-Jan.-202155 KiB

xfree.cH A D07-Jan.-20191.5 KiB

xmalloc.cH A D07-Jan.-20192 KiB

xmalloc.hH A D13-Aug.-20171.3 KiB


4This is the Gnu Readline library, version 8.1.
6The Readline library provides a set of functions for use by applications
7that allow users to edit command lines as they are typed in.  Both
8Emacs and vi editing modes are available.  The Readline library includes
9additional functions to maintain a list of previously-entered command
10lines, to recall and perhaps reedit those lines, and perform csh-like
11history expansion on previous commands.
13The history facilites are also placed into a separate library, the
14History library, as part of the build process.  The History library
15may be used without Readline in applications which desire its
18The Readline library is free software, distributed under the terms of
19the [GNU] General Public License as published by the Free Software
20Foundation, version 3 of the License.  For more information, see the
21file COPYING.
23To build the library, try typing `./configure', then `make'.  The
24configuration process is automated, so no further intervention should
25be necessary.  Readline builds with `gcc' by default if it is
26available.  If you want to use `cc' instead, type
28        CC=cc ./configure
30if you are using a Bourne-style shell.  If you are not, the following
31may work:
33        env CC=cc ./configure
35Read the file INSTALL in this directory for more information about how
36to customize and control the build process.
38The file rlconf.h contains C preprocessor defines that enable and disable
39certain Readline features.
41The special make target `everything' will build the static and shared
42libraries (if the target platform supports them) and the examples.
47There are several example programs that use Readline features in the
48examples directory.  The `rl' program is of particular interest.  It
49is a command-line interface to Readline, suitable for use in shell
50scripts in place of `read'.
52Shared Libraries
55There is skeletal support for building shared versions of the
56Readline and History libraries.  The configure script creates
57a Makefile in the `shlib' subdirectory, and typing `make shared'
58will cause shared versions of the Readline and History libraries
59to be built on supported platforms.
61If `configure' is given the `--enable-shared' option, it will attempt
62to build the shared libraries by default on supported platforms.
64Configure calls the script support/shobj-conf to test whether or
65not shared library creation is supported and to generate the values
66of variables that are substituted into shlib/Makefile.  If you
67try to build shared libraries on an unsupported platform, `make'
68will display a message asking you to update support/shobj-conf for
69your platform.
71If you need to update support/shobj-conf, you will need to create
72a `stanza' for your operating system and compiler.  The script uses
73the value of host_os and ${CC} as determined by configure.  For
74instance, FreeBSD 4.2 with any version of gcc is identified as
77In the stanza for your operating system-compiler pair, you will need to
78define several variables.  They are:
80SHOBJ_CC	The C compiler used to compile source files into shareable
81		object files.  This is normally set to the value of ${CC}
82		by configure, and should not need to be changed.
84SHOBJ_CFLAGS	Flags to pass to the C compiler ($SHOBJ_CC) to create
85		position-independent code.  If you are using gcc, this
86		should probably be set to `-fpic'.
88SHOBJ_LD	The link editor to be used to create the shared library from
89		the object files created by $SHOBJ_CC.  If you are using
90		gcc, a value of `gcc' will probably work.
92SHOBJ_LDFLAGS	Flags to pass to SHOBJ_LD to enable shared object creation.
93		If you are using gcc, `-shared' may be all that is necessary.
94		These should be the flags needed for generic shared object
95		creation.
97SHLIB_XLDFLAGS	Additional flags to pass to SHOBJ_LD for shared library
98		creation.  Many systems use the -R option to the link
99		editor to embed a path within the library for run-time
100		library searches.  A reasonable value for such systems would
101		be `-R$(libdir)'.
103SHLIB_LIBS	Any additional libraries that shared libraries should be
104		linked against when they are created.
106SHLIB_LIBPREF	The prefix to use when generating the filename of the shared
107		library.  The default is `lib'; Cygwin uses `cyg'.
109SHLIB_LIBSUFF	The suffix to add to `libreadline' and `libhistory' when
110		generating the filename of the shared library.  Many systems
111		use `so'; HP-UX uses `sl'.
113SHLIB_LIBVERSION The string to append to the filename to indicate the version
114		of the shared library.  It should begin with $(SHLIB_LIBSUFF),
115		and possibly include version information that allows the
116		run-time loader to load the version of the shared library
117		appropriate for a particular program.  Systems using shared
118		libraries similar to SunOS 4.x use major and minor library
119		version numbers; for those systems a value of
120		`$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)$(SHLIB_MINOR)' is appropriate.
121		Systems based on System V Release 4 don't use minor version
122		numbers; use `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)' on those systems.
123		Other Unix versions use different schemes.
125SHLIB_DLLVERSION The version number for shared libraries that determines API
126		compatibility between readline versions and the underlying
127		system.  Used only on Cygwin.  Defaults to $SHLIB_MAJOR, but
128		can be overridden at configuration time by defining DLLVERSION
129		in the environment.
131SHLIB_DOT	The character used to separate the name of the shared library
132		from the suffix and version information.  The default is `.';
133		systems like Cygwin which don't separate version information
134		from the library name should set this to the empty string.
136SHLIB_STATUS	Set this to `supported' when you have defined the other
137		necessary variables.  Make uses this to determine whether
138		or not shared library creation should be attempted.
140You should look at the existing stanzas in support/shobj-conf for ideas.
142Once you have updated support/shobj-conf, re-run configure and type
143`make shared'.  The shared libraries will be created in the shlib
146If shared libraries are created, `make install' will install them. 
147You may install only the shared libraries by running `make
148install-shared' from the top-level build directory.  Running `make
149install' in the shlib subdirectory will also work.  If you don't want
150to install any created shared libraries, run `make install-static'. 
155The documentation for the Readline and History libraries appears in
156the `doc' subdirectory.  There are three texinfo files and a
157Unix-style manual page describing the facilities available in the
158Readline library.  The texinfo files include both user and
159programmer's manuals.  HTML versions of the manuals appear in the
160`doc' subdirectory as well. 
165Our position on the use of Readline through a shared-library linking
166mechanism is that there is no legal difference between shared-library
167linking and static linking--either kind of linking combines various
168modules into a single larger work.  The conditions for using Readline
169in a larger work are stated in section 3 of the GNU GPL.
171Reporting Bugs
174Bug reports for Readline should be sent to:
178When reporting a bug, please include the following information:
180        * the version number and release status of Readline (e.g., 4.2-release)
181        * the machine and OS that it is running on
182        * a list of the compilation flags or the contents of `config.h', if
183          appropriate
184        * a description of the bug
185        * a recipe for recreating the bug reliably
186        * a fix for the bug if you have one!
188If you would like to contact the Readline maintainer directly, send mail
191Since Readline is developed along with bash, the mailing
192list (mirrored to the Usenet newsgroup gnu.bash.bug) often contains
193Readline bug reports and fixes. 
195Chet Ramey