mirror of
https://github.com/troglobit/editline.git
synced 2025-09-17 01:08:08 +08:00
Unify on docs/ directory, which is de facto standard on GitHub
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
This commit is contained in:
68
docs/README
Executable file
68
docs/README
Executable file
@@ -0,0 +1,68 @@
|
||||
Original Minix README
|
||||
=====================
|
||||
|
||||
Below is the original Minix editline README file. It has been
|
||||
split into a modified README and LICENSE file.
|
||||
|
||||
-- Joachim Nilsson, June 7th 2008
|
||||
|
||||
-----------------------------------------------------------------
|
||||
$Revision: 5 $
|
||||
|
||||
This is a line-editing library. It can be linked into almost any
|
||||
program to provide command-line editing and recall.
|
||||
|
||||
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.
|
||||
|
||||
Configuration is done in the Makefile. Type "make testit" to get
|
||||
a small slow shell for testing.
|
||||
|
||||
An earlier version was distributed with Byron's rc. Principal
|
||||
changes over that version include:
|
||||
Faster.
|
||||
Is eight-bit clean (thanks to brendan()cs!widener!edu)
|
||||
Written in K&R C, but ANSI compliant (gcc all warnings)
|
||||
Propagates EOF properly; rc trip test now passes
|
||||
Doesn't need or use or provide memmove.
|
||||
More robust
|
||||
Calling sequence changed to be compatible with readline.
|
||||
Test program, new manpage, better configuration
|
||||
More system-independant; includes Unix and OS-9 support.
|
||||
|
||||
This contains some changes since the posting to comp.sources.misc:
|
||||
Bugfix for completion on absolute pathnames.
|
||||
Better handling of M-n versus showing raw 8bit chars.
|
||||
Better signal handling.
|
||||
Now supports termios/termio/sgttyb ioctl's.
|
||||
Add M-m command to toggle how 8bit data is displayed.
|
||||
|
||||
There is one known bug:
|
||||
History-searching redraws the line wrong if the text
|
||||
retrieved is shorter then the prompt.
|
||||
|
||||
Enjoy,
|
||||
Rich $alz
|
||||
<rsalz()osf!org>
|
||||
|
||||
Copyright 1992,1993 Simmule Turner and Rich Salz. All rights reserved.
|
||||
|
||||
This software is not subject to any license of the American Telephone
|
||||
and Telegraph Company or of the Regents of the University of California.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose on
|
||||
any computer system, and to alter it and redistribute it freely, subject
|
||||
to the following restrictions:
|
||||
1. The authors are not responsible for the consequences of use of this
|
||||
software, no matter how awful, even if they arise from flaws in it.
|
||||
2. The origin of this software must not be misrepresented, either by
|
||||
explicit claim or by omission. Since few users ever read sources,
|
||||
credits must appear in the documentation.
|
||||
3. Altered versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software. Since few users
|
||||
ever read sources, credits must appear in the documentation.
|
||||
4. This notice may not be removed or altered.
|
||||
|
||||
--
|
||||
$PchId: README,v 1.3 1996/02/22 21:18:51 philip Exp $
|
51
docs/TODO.md
Normal file
51
docs/TODO.md
Normal file
@@ -0,0 +1,51 @@
|
||||
TODO
|
||||
====
|
||||
|
||||
Issues in need of work. Mostly compatibility with GNU readline, BSD
|
||||
[libedit][], and usability improvements.
|
||||
|
||||
Remember, the general idea is to keep this library editline small with
|
||||
no external dependencies, except a C library.
|
||||
|
||||
|
||||
Verify custom completion handlers
|
||||
---------------------------------
|
||||
|
||||
Verify for v1.14.0 that custom completion handlers still work After
|
||||
reverting a "fix" in v0.2.2 that made `rl_complete()` a function pointer
|
||||
we need to make sure the same functionality is still available with the
|
||||
new infrastructure. Which is more inspired by BSD libedit and GNU
|
||||
readline.
|
||||
|
||||
|
||||
Check what's needed to run the fileman example
|
||||
----------------------------------------------
|
||||
|
||||
The BSD libedit library has imported the GNU readline "fileman" example
|
||||
into its tree to demonstrate the abilities of that library. This would
|
||||
also be quite useful for this library!
|
||||
|
||||
The first task is to investigate the depependencies and form TODO list
|
||||
items detailing what is missing and, if possible, proposals how to
|
||||
implement including any optional configure flags.
|
||||
|
||||
|
||||
Other minor TODO's
|
||||
------------------
|
||||
|
||||
- Instead of supporting multiline input, try the Emacs approach, line
|
||||
scrolling.
|
||||
- Add support for `rl_bind_key()`, currently only en editline specific
|
||||
`el_bind_key()` exists.
|
||||
- Make `char *rl_prompt;` globally visible.
|
||||
- Add support for `rl_set_prompt()`
|
||||
- Add support for `--enable-utf8` to configure script
|
||||
- Use `strcmp(nl_langinfo(CODESET), "UTF-8")` to look for utf8 capable
|
||||
terminal
|
||||
- Implement simple UTF-8 parser according to
|
||||
http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
|
||||
|
||||
|
||||
[gnu]: http://www.delorie.com/gnu/docs/readline/rlman_41.html#IDX288
|
||||
[libuEv]: https://github.com/troglobit/libuev/
|
||||
[libedit]: http://www.thrysoee.dk/editline/
|
Reference in New Issue
Block a user