/[linedit]/doc/README
ViewVC logotype

Contents of /doc/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.6 - (show annotations)
Sun Sep 28 11:40:20 2003 UTC (10 years, 6 months ago) by nsiivola
Branch: MAIN
CVS Tags: HEAD
Changes since 1.5: +24 -165 lines
*** empty log message ***
1 -*- Text -*-
2
3 LINEDIT
4
5 Linedit is a readline-style library written in Common Lisp that
6 provides customizable line-editing for Common Lisp programs.
7
8 Version 0.11 uses UFFI for foreign bindings, and is hence
9 theoretically portable. The development and testing has so far been
10 carried out on SBCL, however. Patches are welcome.
11
12 The current input handling is only empirically correct -- which is a
13 gentile way of saying "works on my box, dunno about yours". Once
14 again: patches are welcome.
15
16 For more information, and the latest version of Linedit visit
17 the Linedit homepage:
18
19 http://common-lisp.net/project/linedit/
20
21 Questions, feature requests, and bug-reports to
22
23 linedit-devel@common-lisp.net.
24
25
26 USAGE
27 -----
28
29 > (asdf:oos 'asdf:load-op :uffi)
30
31 > (asdf:oos 'asdf:load-op :linedit)
32
33 > (linedit:linedit :prompt "-> ")
34
35 > (linedit:formedit :prompt1 "=> " :prompt2 "| ")
36
37
38 USING FORMEDIT IN SBCL REPL
39 ---------------------------
40
41 Call (LINEDIT:INSTALL-REPL :WRAP-CURRENT T) in your .sbclrc. If you
42 don't want to preserve your current input handler you can omit the
43 WRAP-CURRENT keyword.
44
45 This should be simple to port to other systems that provide similar
46 hooks.
47
48
49 INTERFACE
50 ---------
51
52 The exported interface used to be documented here, but was cleared
53 out for a while -- until things stabilize a bit more. 1.0 at latest
54 will se it back.
55
56 For the duration you should read the sources.

  ViewVC Help
Powered by ViewVC 1.1.5