source: project/wiki/readline @ 7959

Last change on this file since 7959 was 7959, checked in by azul, 12 years ago

Changes applied for azul (193.142.125.1) through svnwiki:

Tweaks.

File size: 4.9 KB
Line 
1[[tags: egg]]
2[[toc:]]
3
4== readline
5
6A binding for the GNU readline library.
7
8== Interface
9
10 [procedure] (gnu-readline PROMPT)
11Reads a line using the GNU readline() function and returns a string. PROMPT should also be a string.
12 [procedure] (gnu-readline-clear-history)
13Clears the history buffer.
14 [procedure] (gnu-readline-read-history FILENAME)
15Reads the history buffer from the file FILENAME (or ~/.history if FILENAME is #f). Returns 0 on success.
16 [procedure] (gnu-readline-write-history FILENAME)
17Writes the history buffer to the file FILENAME (or ~/.history if FILENAME is #f). Returns 0 on success.
18 [procedure] (gnu-readline-truncate-history FILENAME NUMLINES)
19Truncates the history file FILENAME (or ~/.history if FILENAME is #f) to NUMLINES lines. Returns 0 on success.
20 [procedure] (gnu-history-install-file-manager FILENAME [NUMLINES])
21If you also want to make the command history span sessions, add the following:
22
23{{(gnu-history-install-file-manager (string-append (or (getenv "HOME") ".") "/.csi.history"))}}
24
25By default this will save 1000 lines of history between sessions (it will prune the history file to 1000 lines at startup). For a different history size, pass the desired number of lines as the (optional) second argument to gnu-history-install-file-manager. If #f is passed in, no history-file-pruning will take place.
26 [procedure] (make-gnu-readline-port [PROMPT] [PROMPT2])
27Returns an input-port that uses the GNU readline facility. If PROMPT is not given, the value returned by (repl-prompt) is used for generating the current prompt (see the Chicken manual for more details about repl-prompt). PROMPT2 is used when there are still unclosed parenthesis; if not given, an appropriate default is generated.
28 [procedure] (gnu-readline-set-bounce-ms TIME)
29Changes the time that the cursor spends bouncing on the matching parenthesis - the default 500ms. To turn bouncing off completely, set to zero.
30 [procedure] (gnu-readline-parse-and-bind CONFIG)
31Passes string CONFIG straight to the readline library for parsing (see the readline manual page for details).
32This extension supports static linking.
33
34== Examples
35
36 % csi -quiet
37 >>> (require 'readline)
38 >>> (current-input-port (make-gnu-readline-port "csi> "))
39 csi>
40
41To get csi to keep a history use the following (in your ~/.csirc file):
42 (require 'readline 'regex)
43 (current-input-port (make-gnu-readline-port))
44 (gnu-history-install-file-manager (string-append (or (getenv "HOME") ".") "/.csi.history"))
45
46To set readline to behave somewhat like vi:
47 (gnu-readline-parse-and-bind "set editing-mode vi")
48
49== Installation problems
50
51This extension requires GNU readline.  You will receive errors if you don't have the C header files for your readline installation or if you use some versions of the BSD readline alternative, libedit.
52
53=== MacOS X
54
55In particular, Mac OS X versions prior to 10.5 Leopard ship with {{/usr/lib/libreadline.dylib}} linked to an older libedit, causing the following error when you install this egg:
56
57 /usr/bin/ld: Undefined symbols:
58 _history_truncate_file
59
60To fix this, install a copy of GNU readline in {{/usr/local/lib}} or, if you're using MacPorts, symlink it:
61
62 ln -s /opt/local/lib/libreadline.dylib /usr/local/lib
63
64Do ''not'' modify the readline link in {{/usr/lib}}.
65
66=== Debian GNU/Linux and derivatives (such as Ubuntu)
67
68In the case of Debian, you should probably install the package {{libreadline-dev}}, which is not installed by default.
69== About this egg
70
71=== Author
72
73Tony Garnock-Jones
74
75=== Version history
76
77; 1.91 : Added support for static linking [felix]
78; 1.9 : Ignores duplicate history entries [Thanks to Toby Butzon]
79; 1.8 : Empty lines are not added to history [Thanks to Dan Muresan]
80; 1.7 : Added parenthesis bouncing, a new auto-complete [Heath Johns]
81; 1.6 : Export *completion-entry-function* to support autocomplete [Alejandro Forero Cuervo]
82; 1.5 : prompt argument to make-gnu-readline-port is optional [felix]
83; 1.4 : Replaced use of (end-of-file) with #!eof
84; 1.3 : Checks more possible libraries to link with at build time [Thanks to Peter Bex]
85; 1.2 : Adapted to new setup scheme.
86; 1.1 : More features, changed license to GPL, links with either libtermcap or libncurses.
87; 1.0 : Initial release
88
89=== License
90
91 Copyright (c) 2002 Tony Garnock-Jones
92 Copyright (c) 2006 Heath Johns (paren bouncing and auto-completion code)
93 
94 This program is free software; you can redistribute it and/or modify
95 it under the terms of the GNU General Public License as published by
96 the Free Software Foundation; either version 2 of the License, or
97 (at your option) any later version.
98 
99 This program is distributed in the hope that it will be useful,
100 but WITHOUT ANY WARRANTY; without even the implied warranty of
101 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
102 GNU General Public License for more details.
103 
104 You should have received a copy of the GNU General Public License
105 along with this program; if not, write to the Free Software
106 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
107
Note: See TracBrowser for help on using the repository browser.