summaryrefslogtreecommitdiff
path: root/doc/ref/repl-modules.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ref/repl-modules.texi')
-rw-r--r--doc/ref/repl-modules.texi36
1 files changed, 15 insertions, 21 deletions
diff --git a/doc/ref/repl-modules.texi b/doc/ref/repl-modules.texi
index 78c7eee1e..700867272 100644
--- a/doc/ref/repl-modules.texi
+++ b/doc/ref/repl-modules.texi
@@ -1,6 +1,6 @@
@c -*-texinfo-*-
@c This is part of the GNU Guile Reference Manual.
-@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2010
+@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2010, 2011
@c Free Software Foundation, Inc.
@c See the file guile.texi for copying conditions.
@@ -84,18 +84,21 @@ $endif
@node Readline Options
@subsection Readline Options
-@c FIXME::martin: Review me!
-
@cindex readline options
-The readline interface module can be configured in several ways to
-better suit the user's needs. Configuration is done via the readline
-module's options interface, in a similar way to the evaluator and
-debugging options (@pxref{Runtime Options}).
-
-@findex readline-options
-@findex readline-enable
-@findex readline-disable
-@findex readline-set!
+The readline interface module can be tweaked in a few ways to better
+suit the user's needs. Configuration is done via the readline module's
+options interface, in a similar way to the evaluator and debugging
+options (@pxref{Runtime Options}).
+
+@deffn {Scheme Procedure} readline-options
+@deffnx {Scheme Procedure} readline-enable option-name
+@deffnx {Scheme Procedure} readline-disable option-name
+@deffnx {Scheme Syntax} readline-set! option-name value
+Accessors for the readline options. Note that unlike the enable/disable
+procedures, @code{readline-set!} is syntax, which expects an unquoted
+option name.
+@end deffn
+
Here is the list of readline options generated by typing
@code{(readline-options 'help)} in Guile. You can also see the
default values.
@@ -107,15 +110,6 @@ bounce-parens 500 Time (ms) to show matching opening parenthesis
(0 = off).
@end smalllisp
-The history length specifies how many input lines will be remembered.
-If the history contains that many lines and additional lines are
-entered, the oldest lines will be lost. You can switch on/off the
-usage of the history file using the following call.
-
-@lisp
-(readline-disable 'history)
-@end lisp
-
The readline options interface can only be used @emph{after} loading
the readline module, because it is defined in that module.