A small replacement for GNU readline() for UNIX
Go to file
Joachim Nilsson 0a75b182b1 Improve GNU readline compat, patch by Steve Tell in 1997 and 1998
This changeset adds support for:
   * rl_prep_terminal(),
   * rl_deprep_terminal(), both of which are only wrappers to rl_ttyset().
   * rl_getc()

and:
   * (*rl_getc_function), defaults to rl_getc()
   * (*rl_event_hook)
   * (*rl_prep_term_function), defaults to rl_prep_terminal()
   * (*rl_deprep_term_function), defaults to rl_deprep_terminal()

For further details, see http://www.cs.unc.edu/~tell/dist/magic-readline.README

Differences from Steve's commit include: signal safety in rl_getc(), restart
read() on EINTR, and make sure to support "int meta_flag" to rl_prep_terminal()
which is the GNU syntax.  To that end I reused the inverse of rl_meta_chars.
2010-08-05 01:08:30 +02:00
debian Merge in changes to debian/ from editline_1.12-6.debian.tar.gz 2010-07-17 19:57:40 +02:00
doc Minor cleanup before release. 2010-03-09 21:18:03 +01:00
examples Build examples (tests) as static, for easy debugging. 2010-08-04 02:44:20 +02:00
include Improve GNU readline compat, patch by Steve Tell in 1997 and 1998 2010-08-05 01:08:30 +02:00
m4 Migrate to libtool and regenerate configure script 2010-07-17 22:00:06 +02:00
man Update man page slightly. 2010-07-31 02:27:24 +02:00
src Improve GNU readline compat, patch by Steve Tell in 1997 and 1998 2010-08-05 01:08:30 +02:00
.gitignore Update .gitignore 2010-07-18 02:50:09 +02:00
aclocal.m4 Migrate to libtool and regenerate configure script 2010-07-17 22:00:06 +02:00
config.guess Make sure to keep copies of config.guess & config.sub, not symlinks. 2010-07-17 22:04:08 +02:00
config.h.in Remove unused constant 'HIDE' 2010-08-04 03:08:38 +02:00
config.sub Make sure to keep copies of config.guess & config.sub, not symlinks. 2010-07-17 22:04:08 +02:00
configure Remove unused constant 'HIDE' 2010-08-04 03:08:38 +02:00
configure.ac Remove unused constant 'HIDE' 2010-08-04 03:08:38 +02:00
depcomp Add standard GNU configure and build system (autoconf+automake). 2008-06-07 21:03:48 +02:00
install-sh Add standard GNU configure and build system (autoconf+automake). 2008-06-07 21:03:48 +02:00
LICENSE New replacement LICENSE and README files. 2008-06-07 17:44:13 +02:00
ltmain.sh Migrate to libtool and regenerate configure script 2010-07-17 22:00:06 +02:00
Make.os9 Restore previously discarded (and incomplete) OS9 backend files. 2010-08-03 00:14:48 +02:00
Makefile.am Migrate to libtool and regenerate configure script 2010-07-17 22:00:06 +02:00
Makefile.in Add configurable support for using termcap library for terminal size. 2010-07-18 18:57:07 +02:00
missing Add standard GNU configure and build system (autoconf+automake). 2008-06-07 21:03:48 +02:00
NEWS Change name from Minix editline to just editline. This also affects 2009-06-14 20:17:10 +02:00
README Minor update. 2010-07-18 01:39:07 +02:00
TODO Update with more wish-list items, UTF-8 support is not high prio, but would be neat. 2010-07-30 01:56:25 +02:00

README                                          -*-text-*-

This is a line editing library.  It can be linked into almost any program to
provide command-line editing and history.

It is call-compatible with the FSF readline library, but it is a fraction of
the size (and offers fewer features).  It does not use standard I/O.  It is
distributed under a "C News-like" copyright, see the file LICENSE for details.

Configuration is made by supplying different options to the GNU configure
script.  In the examples/ directory you can find some small code snippets
used for testing.

Before finding out about the Debian version I was on the lookout for a really
small replacement for the GNU readline package. Not only was libreadline large
and GPL:ed (instead of LGPL:ed), it also depends on libncurses, the resulting
size was a bit too much for my embedded system.  I eventually stubmled upon the
BSD libedit library, which was sufficient for a while, even though it too
depends on libncurses.  I searched my soul and went back to where I, back in
1996, started out -- Minix.  And there it was, a really small readline
replacement!

In 2000 Jim Studt packaged libeditline for Debian[1], the exact origin of the
Debian code base is unclear, see the Sid package[2] for details. There were
some notable differences between that version and the upstream Minix sources,
all of which have now been merged here.

An explanation of the version numbering may be in order.  I didn't know about
the Debian version for quite some time, so I kept a different name for the
package and a different versioning scheme.  In June 2009, I decided to line up
alongside Debian, with the intent of merging the efforts.  Sorry for any
confusion this might cause.

Enjoy,
	Joachim Nilsson <troglobit()vmlinux!org>

[1] - http://lists.debian.org/debian-devel/2000/05/msg00548.html
[2] - http://packages.debian.org/sid/libeditline0