aboutsummaryrefslogtreecommitdiff
path: root/gnu/lib/libreadline/doc
diff options
context:
space:
mode:
authorAndrey A. Chernov <ache@FreeBSD.org>1995-03-17 01:40:52 +0000
committerAndrey A. Chernov <ache@FreeBSD.org>1995-03-17 01:40:52 +0000
commit0efbb29eece0b878ebded0cace8ea104cd40cab2 (patch)
treed8921ff252a86e1d6b307b6a0637cc1be1c8d7d6 /gnu/lib/libreadline/doc
parentc5b0a90902b451c79a30731bbabbdc725c6d02b2 (diff)
Notes
Diffstat (limited to 'gnu/lib/libreadline/doc')
-rw-r--r--gnu/lib/libreadline/doc/rltech.texinfo62
1 files changed, 56 insertions, 6 deletions
diff --git a/gnu/lib/libreadline/doc/rltech.texinfo b/gnu/lib/libreadline/doc/rltech.texinfo
index 80e14440aed4..636c92396a98 100644
--- a/gnu/lib/libreadline/doc/rltech.texinfo
+++ b/gnu/lib/libreadline/doc/rltech.texinfo
@@ -44,6 +44,8 @@ in your own programs, this section is for you.
@menu
* Basic Behavior:: Using the default behavior of Readline.
* Custom Functions:: Adding your own functions to Readline.
+* Readline Variables:: Variables accessible to custom
+ functions.
* Readline Convenience Functions:: Functions which Readline supplies to
aid in writing your own
* Custom Completers:: Supplanting or supplementing Readline's
@@ -230,6 +232,11 @@ to do something useful with both negative and positive arguments.
At the very least, it should be aware that it can be passed a
negative argument.
+@node Readline Variables
+@section Readline Variables
+
+These variables are available to function writers.
+
@deftypevar {char *} rl_line_buffer
This is the line gathered so far. You are welcome to modify the
contents of the line, but see @ref{Allowing Undoing}.
@@ -289,6 +296,11 @@ If non-zero, this is the address of a function to call just
before @code{readline} prints the first prompt.
@end deftypevar
+@deftypevar {Function *} rl_event_hook
+If non-zero, this is the address of a function to call periodically
+when readline is waiting for terminal input.
+@end deftypevar
+
@node Readline Convenience Functions
@section Readline Convenience Functions
@@ -422,6 +434,11 @@ perform any key bindings and variable assignments found
(@pxref{Readline Init File}).
@end deftypefun
+@deftypefun int rl_read_init_file (char *filename)
+Read keybindings and variable assignments from @var{filename}
+(@pxref{Readline Init File}).
+@end deftypefun
+
@node Associating Function Names and Bindings
@subsection Associating Function Names and Bindings
@@ -449,6 +466,17 @@ Return an array of strings representing the key sequences used to
invoke @var{function} in the keymap @var{map}.
@end deftypefun
+@deftypefun void rl_function_dumper (int readable)
+Print the readline function names and the key sequences currently
+bound to them to @code{rl_outstream}. If @var{readable} is non-zero,
+the list is formatted in such a way that it can be made part of an
+@code{inputrc} file and re-read.
+@end deftypefun
+
+@deftypefun void rl_list_funmap_names ()
+Print the names of all bindable Readline functions to @code{rl_outstream}.
+@end deftypefun
+
@node Allowing Undoing
@subsection Allowing Undoing
@@ -577,6 +605,22 @@ not a kill, a new kill ring slot is used.
@node Utility Functions
@subsection Utility Functions
+@deftypefun int rl_read_key ()
+Return the next character available. This handles input inserted into
+the input stream via @var{pending input} (@pxref{Readline Variables})
+and @code{rl_stuff_char ()}, macros, and characters read from the keyboard.
+@end deftypefun
+
+@deftypefun int rl_stuff_char (int c)
+Insert @var{c} into the Readline input stream. It will be "read"
+before Readline attempts to read characters from the terminal with
+@code{rl_read_key ()}.
+@end deftypefun
+
+@deftypefun int rl_initialize ()
+Initialize or re-initialize Readline's internal state.
+@end deftypefun
+
@deftypefun int rl_reset_terminal (char *terminal_name)
Reinitialize Readline's idea of the terminal settings using
@var{terminal_name} as the terminal type (e.g., @code{vt100}).
@@ -869,6 +913,13 @@ The list of characters that signal a break between words for
@code{rl_basic_word_break_characters}.
@end deftypevar
+@deftypevar {char *} rl_completer_quote_characters
+List of characters which can be used to quote a substring of the line.
+Completion occurs on the entire substring, and within the substring
+@code{rl_completer_word_break_characters} are treated as any other character,
+unless they also appear within this list.
+@end deftypevar
+
@deftypevar {char *} rl_special_prefixes
The list of characters that are word break characters, but should be
left in @var{text} when it is passed to the completion function.
@@ -909,14 +960,13 @@ re-arrange the list of matches as required, but each element deleted
from the array must be freed.
@end deftypevar
-@deftypevar {char *} rl_completer_quote_characters
-List of characters which can be used to quote a substring of the line.
-Completion occurs on the entire substring, and within the substring
-@code{rl_completer_word_break_characters} are treated as any other character,
-unless they also appear within this list.
+@deftypevar {Function *} rl_directory_completion_hook
+This function, if defined, is allowed to modify the directory portion
+of filenames Readline completes. It is called with the address of a
+string (the current directory name) as an argument. It could be used
+to expand symbolic links or shell variables in pathnames.
@end deftypevar
-
@node A Short Completion Example
@subsection A Short Completion Example