zhangyiss/editline
1
0
Fork 0
mirror of https://github.com/troglobit/editline.git synced 2025-05-06 04:21:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Reflow paragraphs, add link to original comp.sources.unix posting

Browse Source 
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
This commit is contained in:
Joachim Nilsson 2017-11-29 17:58:42 +01:00
parent 6137feacdf
commit 621f126128
1 changed files with 33 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.md
View File

@ -16,20 +16,20 @@ Table of Contents
Introduction Introduction
------------ ------------
This is a small [line editing][] library. It can be linked into almost This is a small [line editing][] library. It can be linked into almost
any program to provide command line editing and history functions. It any program to provide command line editing and history functions. It
is call compatible with the [FSF readline][] library, but at a fraction is call compatible with the [FSF readline][] library, but at a fraction
of the size, and as a result fewer features. It is also distributed of the size, and as a result fewer features. It is also distributed
under a much more liberal [LICENSE][]. under a much more liberal [LICENSE][].
The small size (<30k), lack of dependencies (no ncurses needed!), and The small size (<30k), lack of dependencies (ncurses not needed!), and
the free license should make this library interesting to many embedded the free license should make this library interesting to many embedded
developers. developers.
Editline has several optional build-time features that can be enabled by Editline has several optional build-time features that can be enabled by
by supplying different options to the GNU configure script. See the supplying different options to the GNU configure script. See the output
output from <kbd>configure --help</kbd> for details. In the `examples/` from <kbd>configure --help</kbd> for details. Some useful hints on how
directory you can find some small code snippets used for testing. to use the library is available in the `examples/` directory.
Editline is maintained collaboratively at [GitHub][]. Editline is maintained collaboratively at [GitHub][].
@ -125,46 +125,47 @@ Build & Install
Editline was originally designed for older UNIX systems and Plan 9. The Editline was originally designed for older UNIX systems and Plan 9. The
current maintainer works exclusively on GNU/Linux systems, so it may use current maintainer works exclusively on GNU/Linux systems, so it may use
GCC and GNU Make specific extensions here and there. This is not on GCC and GNU Make specific extensions here and there. This is not on
purpose and patches or pull requests to correct this are most welcome! purpose and patches or pull requests to correct this are most welcome!
1. Configure editline with default features: <kbd>./configure</kbd> 1. Configure editline with default features: <kbd>./configure</kbd>
2. Build the library and examples: <kbd>make all</kbd> 2. Build the library and examples: <kbd>make all</kbd>
3. Install using <kbd>make install</kbd> 3. Install using <kbd>make install</kbd>
The `$DESTDIR` environment variable is honored at install. See The `$DESTDIR` environment variable is honored at install. For more
<kbd>./configure --help</kbd> for more options. options, see <kbd>./configure --help</kbd>
Origin & References Origin & References
-------------------- --------------------
This [line editing][] library was created by Simmule Turner and This [line editing][] library was created by [Rich Salz][] and Simmule
[Rich Salz][upstream] in in 1992. It is distributed under a “C Turner and in 1992. It is distributed under a “C News-like” license,
News-like” license, similar to the [BSD license][]. Rich's latest similar to the [BSD license][]. Rich's latest version is however under
version is however under the Apache license. For details on the the Apache license. For details on the licensing terms of this version
licensing terms of this version of the software, see [LICENSE][]. of the software, see [LICENSE][].
This version of the editline library was forked from the [Minix 3][] This version of the editline library was forked from the [Minix 3][]
source tree and is *not* related to the similarily named NetBSD version source tree and is *not* related to the similarily named NetBSD version
that [Jess Thrysøe][jess] disitributes to the world outside BSD. The that [Jess Thrysøe][jess] disitributes to the world outside *BSD. The
libraries have much in common, but the latter is heavily refactored and libraries have much in common, but the latter is heavily refactored and
also relies on libtermcap (usually supplied by ncurses), whereas this also relies on libtermcap (usually supplied by ncurses), whereas this
library only uses termios from the standard C library. library only uses termios from the standard C library.
Patches and bug fixes from the following forks, all based on the Patches and bug fixes from the following forks, based on the original
original comp.sources.unix posting, have been merged: [comp.sources.unix][] posting, have been merged:
* Debian [libeditline][] * Debian [libeditline][]
* [Heimdal][] * [Heimdal][]
* [Festival][] speech-tools * [Festival][] speech-tools
* [Steve Tell][]'s editline patches * [Steve Tell][]'s editline patches
The version numbering scheme today follows that of the Debian version, The version numbering scheme today follows that of the Debian version,
which can be seen in the [ChangeLog.md][]. The Debian version was details available in the [ChangeLog.md][]. The current [maintainer][]
unknown to the current [maintainer][] for quite some time, so a was unaware of the Debian version for quite some time, so a different
different name and different versioning scheme was used. In June 2009 name and versioning scheme was used. In June 2009 this was changed to
this was changed to line up alongside Debian, with the intent is to line up alongside Debian, with the intent is to eventually merge the
eventually merge the efforts. efforts.
Outstanding issues are listed in the [TODO.md][] file. Outstanding issues are listed in the [TODO.md][] file.
@ -175,7 +176,8 @@ Outstanding issues are listed in the [TODO.md][] file.
[TODO.md]: https://github.com/troglobit/editline/blob/master/TODO.md [TODO.md]: https://github.com/troglobit/editline/blob/master/TODO.md
[ChangeLog.md]: https://github.com/troglobit/editline/blob/master/ChangeLog.md [ChangeLog.md]: https://github.com/troglobit/editline/blob/master/ChangeLog.md
[FSF readline]: http://www.gnu.org/software/readline/ [FSF readline]: http://www.gnu.org/software/readline/
[upstream]: https://github.com/richsalz/editline/ [Rich Salz]: https://github.com/richsalz/editline/
[comp.sources.unix]: http://ftp.cs.toronto.edu/pub/white/pub/rc/editline.shar
[Minix 3]: http://www.cise.ufl.edu/~cop4600/cgi-bin/lxr/http/source.cgi/lib/editline/ [Minix 3]: http://www.cise.ufl.edu/~cop4600/cgi-bin/lxr/http/source.cgi/lib/editline/
[jess]: http://thrysoee.dk/editline/ [jess]: http://thrysoee.dk/editline/
[BSD license]: http://en.wikipedia.org/wiki/BSD_licenses [BSD license]: http://en.wikipedia.org/wiki/BSD_licenses
@ -187,9 +189,3 @@ Outstanding issues are listed in the [TODO.md][] file.
[Travis Status]: https://travis-ci.org/troglobit/editline.png?branch=master [Travis Status]: https://travis-ci.org/troglobit/editline.png?branch=master
[Coverity Scan]: https://scan.coverity.com/projects/2982 [Coverity Scan]: https://scan.coverity.com/projects/2982
[Coverity Status]: https://scan.coverity.com/projects/2982/badge.svg [Coverity Status]: https://scan.coverity.com/projects/2982/badge.svg
<!--
-- Local Variables:
-- mode: markdown
-- End:
-->