• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

COPYINGH A D10-Feb-202217.6 KiB340281

INSTALLH A D10-Feb-202212 KiB288226

READMEH A D10-Feb-20227.4 KiB187142

ansi_stdlib.hH A D10-Feb-20221.5 KiB5520

bind.cH A D10-Feb-202255.9 KiB2,3121,716

callback.cH A D10-Feb-20227.1 KiB259170

chardefs.hH A D10-Feb-20224.6 KiB167111

compat.cH A D10-Feb-20222.5 KiB11474

complete.cH A D10-Feb-202264.6 KiB2,2241,468

config_readline.hH A D10-Feb-2022828 3823

configure.inH A D10-Feb-20227.5 KiB297236

display.cH A D10-Feb-202271.2 KiB2,4531,721

emacs_keymap.cH A D10-Feb-202236.9 KiB874784

funmap.cH A D10-Feb-20228.7 KiB256202

histexpand.cH A D10-Feb-202238.4 KiB1,5931,121

histfile.cH A D10-Feb-202213.7 KiB551390

histlib.hH A D10-Feb-20222.4 KiB8344

history.cH A D10-Feb-202212.6 KiB519342

history.hH A D10-Feb-202210 KiB26782

histsearch.cH A D10-Feb-20224.9 KiB196124

input.cH A D10-Feb-202212.6 KiB586419

isearch.cH A D10-Feb-202218.7 KiB667443

keymaps.cH A D10-Feb-20223.5 KiB15089

keymaps.hH A D10-Feb-20223.4 KiB10438

kill.cH A D10-Feb-202215.8 KiB695494

macro.cH A D10-Feb-20227 KiB272170

mbutil.cH A D10-Feb-20228.9 KiB374262

misc.cH A D10-Feb-202214.3 KiB604421

nls.cH A D10-Feb-20226.1 KiB255172

parens.cH A D10-Feb-20224.7 KiB184131

posixdir.hH A D10-Feb-20222 KiB6233

posixjmp.hH A D10-Feb-20221.3 KiB4115

posixstat.hH A D10-Feb-20224.3 KiB14387

readline.cH A D10-Feb-202231.1 KiB1,201761

readline.hH A D10-Feb-202233.7 KiB854422

rlconf.hH A D10-Feb-20222.3 KiB6412

rldefs.hH A D10-Feb-20224.7 KiB16195

rlmbutil.hH A D10-Feb-20225.1 KiB15682

rlprivate.hH A D10-Feb-202213 KiB426244

rlshell.hH A D10-Feb-20221.4 KiB359

rlstdc.hH A D10-Feb-20221.5 KiB4615

rltty.cH A D10-Feb-202223.8 KiB1,034770

rltty.hH A D10-Feb-20222.6 KiB8345

rltypedefs.hH A D10-Feb-20222.9 KiB9541

rlwinsize.hH A D10-Feb-20222.2 KiB5824

savestring.cH A D10-Feb-20221.3 KiB3812

search.cH A D10-Feb-202214.5 KiB572392

shell.cH A D10-Feb-20224.6 KiB209139

signals.cH A D10-Feb-202212.3 KiB467330

tcap.hH A D10-Feb-20221.7 KiB6125

terminal.cH A D10-Feb-202218.8 KiB736506

text.cH A D10-Feb-202236.7 KiB1,6401,178

tilde.cH A D10-Feb-202212.9 KiB503339

tilde.hH A D10-Feb-20223.1 KiB8224

undo.cH A D10-Feb-20227.2 KiB331231

util.cH A D10-Feb-20228.4 KiB361246

vi_keymap.cH A D10-Feb-202235.8 KiB878789

vi_mode.cH A D10-Feb-202238.3 KiB1,7491,356

xmalloc.cH A D10-Feb-20222.3 KiB8946

xmalloc.hH A D10-Feb-20221.4 KiB4718

README

1Introduction
2============
3
4This is the Gnu Readline library, version 5.2.
5
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.
12
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
16capabilities.
17
18The Readline library is free software, distributed under the terms of
19the [GNU] General Public License, version 2.  For more information, see
20the file COPYING.
21
22To build the library, try typing `./configure', then `make'.  The
23configuration process is automated, so no further intervention should
24be necessary.  Readline builds with `gcc' by default if it is
25available.  If you want to use `cc' instead, type
26
27        CC=cc ./configure
28
29if you are using a Bourne-style shell.  If you are not, the following
30may work:
31
32        env CC=cc ./configure
33
34Read the file INSTALL in this directory for more information about how
35to customize and control the build process.
36
37The file rlconf.h contains C preprocessor defines that enable and disable
38certain Readline features.
39
40The special make target `everything' will build the static and shared
41libraries (if the target platform supports them) and the examples.
42
43Examples
44========
45
46There are several example programs that use Readline features in the
47examples directory.  The `rl' program is of particular interest.  It
48is a command-line interface to Readline, suitable for use in shell
49scripts in place of `read'.
50
51Shared Libraries
52================
53
54There is skeletal support for building shared versions of the
55Readline and History libraries.  The configure script creates
56a Makefile in the `shlib' subdirectory, and typing `make shared'
57will cause shared versions of the Readline and History libraries
58to be built on supported platforms.
59
60If `configure' is given the `--enable-shared' option, it will attempt
61to build the shared libraries by default on supported platforms.
62
63Configure calls the script support/shobj-conf to test whether or
64not shared library creation is supported and to generate the values
65of variables that are substituted into shlib/Makefile.  If you
66try to build shared libraries on an unsupported platform, `make'
67will display a message asking you to update support/shobj-conf for
68your platform.
69
70If you need to update support/shobj-conf, you will need to create
71a `stanza' for your operating system and compiler.  The script uses
72the value of host_os and ${CC} as determined by configure.  For
73instance, FreeBSD 4.2 with any version of gcc is identified as
74`freebsd4.2-gcc*'.
75
76In the stanza for your operating system-compiler pair, you will need to
77define several variables.  They are:
78
79SHOBJ_CC	The C compiler used to compile source files into shareable
80		object files.  This is normally set to the value of ${CC}
81		by configure, and should not need to be changed.
82
83SHOBJ_CFLAGS	Flags to pass to the C compiler ($SHOBJ_CC) to create
84		position-independent code.  If you are using gcc, this
85		should probably be set to `-fpic'.
86
87SHOBJ_LD	The link editor to be used to create the shared library from
88		the object files created by $SHOBJ_CC.  If you are using
89		gcc, a value of `gcc' will probably work.
90
91SHOBJ_LDFLAGS	Flags to pass to SHOBJ_LD to enable shared object creation.
92		If you are using gcc, `-shared' may be all that is necessary.
93		These should be the flags needed for generic shared object
94		creation.
95
96SHLIB_XLDFLAGS	Additional flags to pass to SHOBJ_LD for shared library
97		creation.  Many systems use the -R option to the link
98		editor to embed a path within the library for run-time
99		library searches.  A reasonable value for such systems would
100		be `-R$(libdir)'.
101
102SHLIB_LIBS	Any additional libraries that shared libraries should be
103		linked against when they are created.
104
105SHLIB_LIBPREF	The prefix to use when generating the filename of the shared
106		library.  The default is `lib'; Cygwin uses `cyg'.
107
108SHLIB_LIBSUFF	The suffix to add to `libreadline' and `libhistory' when
109		generating the filename of the shared library.  Many systems
110		use `so'; HP-UX uses `sl'.
111
112SHLIB_LIBVERSION The string to append to the filename to indicate the version
113		of the shared library.  It should begin with $(SHLIB_LIBSUFF),
114		and possibly include version information that allows the
115		run-time loader to load the version of the shared library
116		appropriate for a particular program.  Systems using shared
117		libraries similar to SunOS 4.x use major and minor library
118		version numbers; for those systems a value of
119		`$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)$(SHLIB_MINOR)' is appropriate.
120		Systems based on System V Release 4 don't use minor version
121		numbers; use `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)' on those systems.
122		Other Unix versions use different schemes.
123
124SHLIB_DLLVERSION The version number for shared libraries that determines API
125		compatibility between readline versions and the underlying
126		system.  Used only on Cygwin.  Defaults to $SHLIB_MAJOR, but
127		can be overridden at configuration time by defining DLLVERSION
128		in the environment.
129
130SHLIB_DOT	The character used to separate the name of the shared library
131		from the suffix and version information.  The default is `.';
132		systems like Cygwin which don't separate version information
133		from the library name should set this to the empty string.
134
135SHLIB_STATUS	Set this to `supported' when you have defined the other
136		necessary variables.  Make uses this to determine whether
137		or not shared library creation should be attempted.
138
139You should look at the existing stanzas in support/shobj-conf for ideas.
140
141Once you have updated support/shobj-conf, re-run configure and type
142`make shared'.  The shared libraries will be created in the shlib
143subdirectory.
144
145If shared libraries are created, `make install' will install them.
146You may install only the shared libraries by running `make
147install-shared' from the top-level build directory.  Running `make
148install' in the shlib subdirectory will also work.  If you don't want
149to install any created shared libraries, run `make install-static'.
150
151Documentation
152=============
153
154The documentation for the Readline and History libraries appears in
155the `doc' subdirectory.  There are three texinfo files and a
156Unix-style manual page describing the facilities available in the
157Readline library.  The texinfo files include both user and
158programmer's manuals.  HTML versions of the manuals appear in the
159`doc' subdirectory as well.
160
161Reporting Bugs
162==============
163
164Bug reports for Readline should be sent to:
165
166        bug-readline@gnu.org
167
168When reporting a bug, please include the following information:
169
170        * the version number and release status of Readline (e.g., 4.2-release)
171        * the machine and OS that it is running on
172        * a list of the compilation flags or the contents of `config.h', if
173          appropriate
174        * a description of the bug
175        * a recipe for recreating the bug reliably
176        * a fix for the bug if you have one!
177
178If you would like to contact the Readline maintainer directly, send mail
179to bash-maintainers@gnu.org.
180
181Since Readline is developed along with bash, the bug-bash@gnu.org mailing
182list (mirrored to the Usenet newsgroup gnu.bash.bug) often contains
183Readline bug reports and fixes.
184
185Chet Ramey
186chet.ramey@case.edu
187