diff options
Diffstat (limited to 'doc/rltech.texi')
| -rw-r--r-- | doc/rltech.texi | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/rltech.texi b/doc/rltech.texi index fe64a42..a93f77d 100644 --- a/doc/rltech.texi +++ b/doc/rltech.texi @@ -393,7 +393,7 @@ value 0x0402. @end deftypevar @deftypevar {int} rl_gnu_readline_p -Always set to 1, denoting that this is @sc{gnu} readline rather than some +Always set to 1, denoting that this is @sc{gnu} Readline rather than some emulation. @end deftypevar @@ -515,7 +515,7 @@ By default, this is set to @code{rl_deprep_terminal} @deftypevar {Keymap} rl_executing_keymap This variable is set to the keymap (@pxref{Keymaps}) in which the -currently executing readline function was found. +currently executing Readline function was found. @end deftypevar @deftypevar {Keymap} rl_binding_keymap @@ -916,7 +916,7 @@ 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 +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. @@ -1184,7 +1184,7 @@ Returns the old timeout value. @deftypefun int rl_set_timeout (unsigned int secs, unsigned int usecs) Set a timeout for subsequent calls to @code{readline()}. If Readline does not read a complete line, or the number of characters specified by -@code{rl_num_chars_to_read}, before the duration specfied by @var{secs} +@code{rl_num_chars_to_read}, before the duration specified by @var{secs} (in seconds) and @var{usecs} (microseconds), it returns and sets @code{RL_STATE_TIMEOUT} in @code{rl_readline_state}. Passing 0 for @code{secs} and @code{usecs} cancels any previously set @@ -1358,7 +1358,7 @@ that it can be made part of an @code{inputrc} file and re-read. @deftypefun int rl_variable_bind (const char *variable, const char *value) Make the Readline variable @var{variable} have @var{value}. -This behaves as if the readline command +This behaves as if the Readline command @samp{set @var{variable} @var{value}} had been executed in an @code{inputrc} file (@pxref{Readline Init File Syntax}). @end deftypefun @@ -1369,7 +1369,7 @@ For boolean variables, this string is either @samp{on} or @samp{off}. @end deftypefun @deftypefun void rl_variable_dumper (int readable) -Print the readline variable names and their current values +Print the Readline variable names and their current values 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. @@ -1400,7 +1400,7 @@ Readline saves in the history list. Enable an @emph{active} mark. When this is enabled, the text between point and mark (the @var{region}) is displayed in the terminal's standout mode (a @var{face}). -This is called by various readline functions that set the mark and insert +This is called by various Readline functions that set the mark and insert text, and is available for applications to call. @end deftypefun @@ -1409,10 +1409,10 @@ Turn off the active mark. @end deftypefun @deftypefun {void} rl_keep_mark_active (void) -Indicate that the mark should remain active when the current readline function -completes and after redisplay occurs. +Indicate that the mark should remain active when the current Readline +function completes and after redisplay occurs. In most cases, the mark remains active for only the duration of a single -bindable readline function. +bindable Readline function. @end deftypefun @deftypefun {int} rl_mark_active_p (void) @@ -1425,12 +1425,12 @@ Return a non-zero value if the mark is currently active; zero otherwise. An alternate interface is available to plain @code{readline()}. Some applications need to interleave keyboard I/O with file, device, or window system I/O, typically by using a main loop to @code{select()} -on various file descriptors. To accommodate this need, readline can +on various file descriptors. To accommodate this need, Readline can also be invoked as a `callback' function from an event loop. There are functions available to make this easy. @deftypefun void rl_callback_handler_install (const char *prompt, rl_vcpfunc_t *lhandler) -Set up the terminal for readline I/O and display the initial +Set up the terminal for Readline I/O and display the initial expanded value of @var{prompt}. Save the value of @var{lhandler} to use as a handler function to call when a complete line of input has been entered. @@ -1815,7 +1815,7 @@ a @code{SIGWINCH}. @deftypefun void rl_echo_signal_char (int sig) If an application wishes to install its own signal handlers, but still -have readline display characters that generate signals, calling this +have Readline display characters that generate signals, calling this function with @var{sig} set to @code{SIGINT}, @code{SIGQUIT}, or @code{SIGTSTP} will display the character generating that signal. @end deftypefun @@ -2213,7 +2213,7 @@ shell variables and hostnames. @deftypevar int rl_completion_query_items Up to this many items will be displayed in response to a -possible-completions call. After that, readline asks the user for +possible-completions call. After that, Readline asks the user for confirmation before displaying them. The default value is 100. A negative value indicates that Readline should never ask for confirmation. |