Imported Upstream version 1.0.0
[platform/upstream/js.git] / js / src / editline / README
1 The files in this directory provide simple line-editing and history
2 support for the standalone javascript engine, through the 'editline'
3 library.
4
5 editline has only been enabled for those platforms on which it is
6 known to build; to try it on a different platform, define JS_EDITLINE
7 before building.  Line editing (and js.c) is not a supported feature
8 of the javascript library, so your mileage my vary.
9
10 The editline API is a compatible subset of the FSF readline API; if
11 you have readline installed and would like to link to that instead,
12 define JS_READLINE.  Note that the readline library is distributed
13 under the GPL, so any resulting binaries are not legally
14 distributable.
15
16 The editline files used here have been modified to work with the js
17 build system and to quiet some compiler warnings, and also to remove
18 filename-completion support.
19
20 If anyone knows of a more recent version of these files, or a site on
21 which they are being maintained, please let me know!
22
23 Mike McCabe, mccabe@netscape.com
24
25
26 The original README file distributed with the editline library follows.
27
28
29
30 This is a line-editing library.  It can be linked into almost any
31 program to provide command-line editing and recall.
32
33 It is call-compatible with the FSF readline library, but it is a
34 fraction of the size (and offers fewer features).  It does not use
35 standard I/O.  It is distributed under a "C News-like" copyright.
36
37 Configuration is done in the Makefile.  Type "make testit" to get
38 a small slow shell for testing.
39
40 An earlier version was distributed with Byron's rc.  Principal
41 changes over that version include:
42         Faster.
43         Is eight-bit clean (thanks to brendan@cs.widener.edu)
44         Written in K&R C, but ANSI compliant (gcc all warnings)
45         Propagates EOF properly; rc trip test now passes
46         Doesn't need or use or provide memmove.
47         More robust
48         Calling sequence changed to be compatible with readline.
49         Test program, new manpage, better configuration
50         More system-independent; includes Unix and OS-9 support.
51
52 This contains some changes since the posting to comp.sources.misc:
53         Bugfix for completion on absolute pathnames.
54         Better handling of M-n versus showing raw 8bit chars.
55         Better signal handling.
56         Now supports termios/termio/sgttyb ioctl's.
57         Add M-m command to toggle how 8bit data is displayed.
58
59 There is one known bug:
60         History-searching redraws the line wrong if the text
61         retrieved is shorter then the prompt.
62
63 Enjoy,
64         Rich $alz
65         <rsalz@osf.org>
66
67  Copyright 1992,1993 Simmule Turner and Rich Salz.  All rights reserved.
68
69  This software is not subject to any license of the American Telephone
70  and Telegraph Company or of the Regents of the University of California.
71
72  Permission is granted to anyone to use this software for any purpose on
73  any computer system, and to alter it and redistribute it freely, subject
74  to the following restrictions:
75  1. The authors are not responsible for the consequences of use of this
76     software, no matter how awful, even if they arise from flaws in it.
77  2. The origin of this software must not be misrepresented, either by
78     explicit claim or by omission.  Since few users ever read sources,
79     credits must appear in the documentation.
80  3. Altered versions must be plainly marked as such, and must not be
81     misrepresented as being the original software.  Since few users
82     ever read sources, credits must appear in the documentation.
83  4. This notice may not be removed or altered.