--- embedaddon/readline/doc/readline.html 2014/07/30 08:16:46 1.1 +++ embedaddon/readline/doc/readline.html 2021/03/17 01:01:01 1.1.1.2 @@ -1,6 +1,6 @@ - +
beginning-of-line (C-a)
-end-of-line (C-e)
-forward-char (C-f)
-backward-char (C-b)
-forward-word (M-f)
-backward-word (M-b)
-previous-screen-line ()
+next-screen-line ()
+clear-display (M-C-l)
+clear-screen (C-l)
-redraw-current-line ()
-@@ -1385,9 +1528,9 @@ Refresh the current line. By default, this is unbound
accept-line (Newline or Return)
-previous-history (C-p)
-next-history (C-n)
-beginning-of-history (M-<)
-end-of-history (M->)
-reverse-search-history (C-r)
-forward-search-history (C-s)
-non-incremental-reverse-search-history (M-p)
-non-incremental-forward-search-history (M-n)
-history-search-forward ()
-history-search-backward ()
-history-substr-search-forward ()
-history-substring-search-forward ()
+history-substr-search-backward ()
-history-substring-search-backward ()
+yank-nth-arg (M-C-y)
-yank-last-arg (M-. or M-_)
-yank-nth-arg
.
@@ -1520,6 +1667,17 @@ The history expansion facilities are used to extract t
as if the `!$' history expansion had been specified.
operate-and-get-next (C-o)
++
@@ -1543,60 +1701,77 @@ as if the `!$' history expansion had been
end-of-file (usually C-d)
-stty
. If this character is read when there are no characters
on the line, and point is at the beginning of the line, Readline
interprets it as the end of input and returns EOF.
delete-char (C-d)
-backward-delete-char (Rubout)
-forward-backward-delete-char ()
-quoted-insert (C-q or C-v)
-tab-insert (M-TAB)
-self-insert (a, b, A, 1, !, ...)
-bracketed-paste-begin ()
+self-insert
instead of
+executing any editing commands.
++ +Bracketed paste sets the region (the characters between point and the mark) +to the inserted text. It uses the concept of an active mark: when the +mark is active, Readline redisplay uses the terminal's standout mode to +denote the region. +
transpose-chars (C-t)
-transpose-words (M-t)
-upcase-word (M-u)
-downcase-word (M-l)
-capitalize-word (M-c)
-overwrite-mode ()
-kill-line (C-k)
-backward-kill-line (C-x Rubout)
-unix-line-discard (C-u)
-kill-whole-line ()
-kill-word (M-d)
-forward-word
.
backward-kill-word (M-DEL)
-backward-word
.
shell-transpose-words (M-C-t)
+shell-forward-word
and
+shell-backward-word
.
+unix-word-rubout (C-w)
-unix-filename-rubout ()
-delete-horizontal-space ()
-kill-region ()
-copy-region-as-kill ()
-copy-backward-word ()
-backward-word
.
By default, this command is unbound.
copy-forward-word ()
-forward-word
.
By default, this command is unbound.
yank (C-y)
-yank-pop (M-y)
-yank
or yank-pop
.
yank
or yank-p
-
+
digit-argument (M-0, M-1, ... M--)
--
+
-
Add this digit to the argument already accumulating, or start a new
argument. M-- starts a negative argument.
universal-argument ()
--
+
-
This is another way to specify an argument.
If this command is followed by one or more digits, optionally with a
leading minus sign, those digits define the argument.
If the command is followed by digits, executing
universal-argument
again ends the numeric argument, but is otherwise ignored.
As a special case, if this command is immediately followed by a
-character that is neither a digit or minus sign, the argument count
+character that is neither a digit nor minus sign, the argument count
for the next command is multiplied by four.
The argument count is initially one, so executing this function the
first time makes the argument count four, a second time makes the
@@ -1844,33 +2034,33 @@ By default, this is not bound to a key.
-
+
complete (TAB)
--
+
-
Attempt to perform completion on the text before point.
The actual completion performed is application-specific.
The default is filename completion.
possible-completions (M-?)
--
+
-
List the possible completions of the text before point.
When displaying completions, Readline sets the number of columns used
for display to the value of
completion-display-width
, the value of
the environment variable COLUMNS
, or the screen width, in that order.
insert-completions (M-*)
--
+
-
Insert all completions of the text before point that would have
been generated by
possible-completions
.
menu-complete ()
--
+
-
Similar to
complete
, but replaces the word to be completed
with a single match from the list of possible completions.
Repeated execution of menu-complete
steps through the list
@@ -1885,17 +2075,17 @@ This command is intended to be bound to TAB
by default.
menu-complete-backward ()
--
+
-
Identical to
menu-complete
, but moves backward through the list
of possible completions, as if menu-complete
had been given a
negative argument.
delete-char-or-list ()
--
+
-
Deletes the character under the cursor if not at the beginning or
end of the line (like
delete-char
).
If at the end of the line, behaves identically to
@@ -1924,29 +2114,29 @@ This command is unbound by default.
-
+
start-kbd-macro (C-x ()
--
+
-
Begin saving the characters typed into the current keyboard macro.
end-kbd-macro (C-x ))
--
+
-
Stop saving the characters typed into the current keyboard macro
and save the definition.
call-last-kbd-macro (C-x e)
--
+
-
Re-execute the last keyboard macro defined, by making the characters
in the macro appear as if typed at the keyboard.
print-last-kbd-macro ()
--
+
-
Print the last keboard macro defined in a format suitable for the
inputrc file.
@@ -1972,87 +2162,88 @@ Print the last keboard macro defined in a format suita
-
+
re-read-init-file (C-x C-r)
--
+
-
Read in the contents of the inputrc file, and incorporate
any bindings or variable assignments found there.
abort (C-g)
--
+
-
Abort the current editing command and
ring the terminal's bell (subject to the setting of
bell-style
).
do-uppercase-version (M-a, M-b, M-x, ...)
--
-If the metafied character x is lowercase, run the command
-that is bound to the corresponding uppercase character.
+
+
do-lowercase-version (M-A, M-B, M-x, ...)
+-
+If the metafied character x is upper case, run the command
+that is bound to the corresponding metafied lower case character.
+The behavior is undefined if x is already lower case.
prefix-meta (ESC)
--
+
-
Metafy the next character typed. This is for keyboards
without a meta key. Typing `ESC f' is equivalent to typing
M-f.
undo (C-_ or C-x C-u)
--
+
-
Incremental undo, separately remembered for each line.
revert-line (M-r)
--
+
-
Undo all changes made to this line. This is like executing the
undo
command enough times to get back to the beginning.
tilde-expand (M-~)
--
+
-
Perform tilde expansion on the current word.
set-mark (C-@)
--
+
-
Set the mark to the point. If a
numeric argument is supplied, the mark is set to that position.
exchange-point-and-mark (C-x C-x)
--
+
-
Swap the point with the mark. The current cursor position is set to
the saved position, and the old cursor position is saved as the mark.
character-search (C-])
--
+
-
A character is read and point is moved to the next occurrence of that
character. A negative count searches for previous occurrences.
character-search-backward (M-C-])
--
+
-
A character is read and point is moved to the previous occurrence
of that character. A negative count searches for subsequent
occurrences.
skip-csi-sequence ()
--
+
-
Read enough characters to consume a multi-key sequence such as those
defined for keys like Home and End. Such sequences begin with a
Control Sequence Indicator (CSI), usually ESC-[. If this sequence is
@@ -2062,9 +2253,9 @@ stray characters into the editing buffer. This is unb
but usually bound to ESC-[.
insert-comment (M-#)
--
+
-
Without a numeric argument, the value of the
comment-begin
variable is inserted at the beginning of the current line.
If a numeric argument is supplied, this command acts as a toggle: if
@@ -2075,43 +2266,43 @@ the line.
In either case, the line is accepted as if a newline had been typed.
dump-functions ()
--
+
-
Print all of the functions and their key bindings to the
Readline output stream. If a numeric argument is supplied,
the output is formatted in such a way that it can be made part
of an inputrc file. This command is unbound by default.
dump-variables ()
--
+
-
Print all of the settable variables and their values to the
Readline output stream. If a numeric argument is supplied,
the output is formatted in such a way that it can be made part
of an inputrc file. This command is unbound by default.
dump-macros ()
--
+
-
Print all of the Readline key sequences bound to macros and the
strings they output. If a numeric argument is supplied,
the output is formatted in such a way that it can be made part
of an inputrc file. This command is unbound by default.
emacs-editing-mode (C-e)
--
+
-
When in
vi
command mode, this causes a switch to emacs
editing mode.
vi-editing-mode (M-C-j)
--
+
-
When in
emacs
editing mode, this causes a switch to vi
editing mode.
@@ -2162,7 +2353,7 @@ in the consistency of user interface across discrete p
to provide a command line interface.
-Copyright (C) 1988--2014 Free Software Foundation, Inc.
+Copyright (C) 1988--2020 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of
@@ -2246,8 +2437,8 @@ the simplest way possible, perhaps to replace calls in
gets()
or fgets()
.
The function readline()
prints a prompt prompt
@@ -2273,6 +2464,13 @@ line is empty at that point, then (char *)NULL
Otherwise, the line is ended just as if a newline had been typed.
+Readline performs some expansion on the prompt before it is
+displayed on the screen. See the description of rl_expand_prompt
+(see section 2.4.6 Redisplay) for additional details, especially if prompt
+will contain characters that do not consume physical screen space when
+displayed.
+
+
If you want the user to be able to get at the line later, (with
C-p for example), you must call add_history()
to save the
line away in a history list of such lines.
@@ -2537,7 +2735,7 @@ negative argument.
A command function should return 0 if its action completes successfully,
-and a non-zero value if some error occurs.
+and a value greater than zero if some error occurs.
This is the convention obeyed by all of the builtin Readline bindable
command functions.
@@ -2563,7 +2761,7 @@ command functions.
These variables are available to function writers.
- Variable: char * rl_line_buffer
- This is the line gathered so far. You are welcome to modify the
@@ -2573,7 +2771,7 @@ the memory allocated to
rl_line_buffer
.
- Variable: int rl_point
- The offset of the current cursor position in
rl_line_buffer
@@ -2581,7 +2779,7 @@ the memory allocated to rl_line_buffer
.
- Variable: int rl_end
- The number of characters present in
rl_line_buffer
. When
@@ -2590,7 +2788,7 @@ the memory allocated to rl_line_buffer
.
- Variable: int rl_mark
- The mark (saved position) in the current line. If set, the mark
@@ -2598,7 +2796,7 @@ and point define a region.
- Variable: int rl_done
- Setting this to a non-zero value causes Readline to return the current
@@ -2606,7 +2804,7 @@ line immediately.
- Variable: int rl_num_chars_to_read
- Setting this to a positive value before calling
readline()
causes
@@ -2615,7 +2813,7 @@ than reading up to a character bound to accept-l
- Variable: int rl_pending_input
- Setting this to a value makes it the next keystroke read. This is a
@@ -2623,7 +2821,7 @@ way to stuff a single character into the input stream.
- Variable: int rl_dispatching
- Set to a non-zero value if a function is being called from a key binding;
@@ -2632,7 +2830,7 @@ they were called directly or by Readline's dispatching
- Variable: int rl_erase_empty_line
- Setting this to a non-zero value causes Readline to completely erase
@@ -2642,7 +2840,7 @@ the beginning of the newly-blank line.
- Variable: char * rl_prompt
- The prompt Readline uses. This is set from the argument to
@@ -2652,7 +2850,7 @@ be used to modify the prompt string after calling
- Variable: char * rl_display_prompt
- The string displayed as the prompt. This is usually identical to
@@ -2661,7 +2859,7 @@ use the prompt string as a message area, such as incre
- Variable: int rl_already_prompted
- If an application wishes to display the prompt itself, rather than have
@@ -2674,14 +2872,14 @@ never sets it.
- Variable: const char * rl_library_version
- The version number of this revision of the library.
- Variable: int rl_readline_version
- An integer encoding the current version of the library. The encoding is
@@ -2692,7 +2890,7 @@ value 0x0402.
- Variable: int rl_gnu_readline_p
- Always set to 1, denoting that this is GNU readline rather than some
@@ -2700,7 +2898,7 @@ emulation.
- Variable: const char * rl_terminal_name
- The terminal type, used for initialization. If not set by the application,
@@ -2709,7 +2907,7 @@ the first time it is called.
- Variable: const char * rl_readline_name
- This variable is set to a unique name by each application using Readline.
@@ -2718,7 +2916,7 @@ The value allows conditional parsing of the inputrc fi
- Variable: FILE * rl_instream
- The stdio stream from which Readline reads input.
@@ -2726,7 +2924,7 @@ If
NULL
, Readline defaults to stdin<
- Variable: FILE * rl_outstream
- The stdio stream to which Readline performs output.
@@ -2734,7 +2932,7 @@ If
NULL
, Readline defaults to stdout
- Variable: int rl_prefer_env_winsize
- If non-zero, Readline gives values found in the
LINES
and
@@ -2743,7 +2941,7 @@ from the kernel when computing the screen dimensions.
- Variable: rl_command_func_t * rl_last_func
- The address of the last command function Readline executed. May be used to
@@ -2752,7 +2950,7 @@ example.
- Variable: rl_hook_func_t * rl_startup_hook
- If non-zero, this is the address of a function to call just
@@ -2760,7 +2958,7 @@ before
readline
prints the first prompt.
- Variable: rl_hook_func_t * rl_pre_input_hook
- If non-zero, this is the address of a function to call after
@@ -2769,7 +2967,7 @@ starts reading input characters.
- Variable: rl_hook_func_t * rl_event_hook
- If non-zero, this is the address of a function to call periodically
@@ -2779,7 +2977,7 @@ is no keyboard input.
- Variable: rl_getc_func_t * rl_getc_function
- If non-zero, Readline will call indirectly through this pointer
@@ -2791,7 +2989,7 @@ setting rl_input_available_hook as well.
- Variable: rl_hook_func_t * rl_signal_event_hook
- If non-zero, this is the address of a function to call if a read system
@@ -2799,7 +2997,7 @@ call is interrupted when Readline is reading terminal
- Variable: rl_hook_func_t * rl_input_available_hook
- If non-zero, Readline will use this function's return value when it needs
@@ -2824,7 +3022,7 @@ setting rl_input_available_hook as well.
- Variable: rl_voidfunc_t * rl_redisplay_function
- If non-zero, Readline will call indirectly through this pointer
@@ -2834,7 +3032,7 @@ redisplay function (see section
+
- Variable: rl_vintfunc_t * rl_prep_term_function
- If non-zero, Readline will call indirectly through this pointer
@@ -2845,7 +3043,7 @@ By default, this is set to
rl_prep_terminal
- Variable: rl_voidfunc_t * rl_deprep_term_function
- If non-zero, Readline will call indirectly through this pointer
@@ -2856,7 +3054,7 @@ By default, this is set to
rl_deprep_terminal
- Variable: Keymap rl_executing_keymap
- This variable is set to the keymap (see section 2.4.2 Selecting a Keymap) in which the
@@ -2864,7 +3062,7 @@ currently executing readline function was found.
- Variable: Keymap rl_binding_keymap
- This variable is set to the keymap (see section 2.4.2 Selecting a Keymap) in which the
@@ -2872,21 +3070,21 @@ last key binding occurred.
- Variable: char * rl_executing_macro
- This variable is set to the text of any currently-executing macro.
- Variable: int rl_executing_key
- The key that caused the dispatch to the currently-executing Readline function.
- Variable: char * rl_executing_keyseq
- The full key sequence that caused the dispatch to the currently-executing
@@ -2894,14 +3092,14 @@ Readline function.
- Variable: int rl_key_sequence_length
- The number of characters in rl_executing_keyseq.
- Variable: int rl_readline_state
- A variable with bit values that encapsulate the current Readline state.
@@ -2971,7 +3169,7 @@ and is about to return the line to the caller.
- Variable: int rl_explicit_arg
- Set to a non-zero value if an explicit numeric argument was specified by
@@ -2979,7 +3177,7 @@ the user. Only valid in a bindable command function.
- Variable: int rl_numeric_arg
- Set to the value of any numeric argument explicitly specified by the user
@@ -2988,7 +3186,7 @@ command function.
- Variable: int rl_editing_mode
- Set to a value denoting Readline's current editing mode. A value of
@@ -3067,7 +3265,7 @@ programmer, should bind the functions you write to des
well. Readline provides a function for doing that:
- Function: int rl_add_defun (const char *name, rl_command_func_t *function, int key)
- Add name to the list of named functions. Make function be
@@ -3107,7 +3305,7 @@ get run. You can make your own keymaps, copy existing
Readline which keymap to use.
- Function: Keymap rl_make_bare_keymap (void)
- Returns a new, empty keymap. The space for the keymap is allocated with
@@ -3116,14 +3314,14 @@ Readline which keymap to use.
- Function: Keymap rl_copy_keymap (Keymap map)
- Return a new keymap which is a copy of map.
- Function: Keymap rl_make_keymap (void)
- Return a new keymap with the printing characters bound to rl_insert,
@@ -3132,7 +3330,7 @@ the Meta digits bound to produce numeric arguments.
- Function: void rl_discard_keymap (Keymap keymap)
- Free the storage associated with the data in keymap.
@@ -3140,7 +3338,7 @@ The caller should free keymap.
- Function: void rl_free_keymap (Keymap keymap)
- Free all storage associated with keymap. This calls
@@ -3148,25 +3346,33 @@ The caller should free keymap.
+- Function: int rl_empty_keymap (Keymap keymap)
+
- Return non-zero if there are no keys bound to functions in keymap;
+zero if there are any keys bound.
+
+
+
Readline has several internal keymaps. These functions allow you to
change which keymap is active.
- Function: Keymap rl_get_keymap (void)
- Returns the currently active keymap.
- Function: void rl_set_keymap (Keymap keymap)
- Makes keymap the currently active keymap.
- Function: Keymap rl_get_keymap_by_name (const char *name)
- Return the keymap matching name. name is one which would
@@ -3174,7 +3380,7 @@ be supplied in a
set keymap
inputrc line
- Function: char * rl_get_keymap_name (Keymap keymap)
- Return the name matching keymap. name is one which would
@@ -3182,6 +3388,27 @@ be supplied in a
set keymap
inputrc line
+- Function: int rl_set_keymap_name (const char *name, Keymap keymap)
+
- Set the name of keymap. This name will then be "registered" and
+available for use in a
set keymap
inputrc directive
+see section 1.3 Readline Init File).
+The name may not be one of Readline's builtin keymap names;
+you may not add a different name for one of Readline's builtin keymaps.
+You may replace the name associated with a given keymap by calling this
+function more than once with the same keymap argument.
+You may associate a registered name with a new keymap by calling this
+function more than once with the same name argument.
+There is no way to remove a named keymap once the name has been
+registered.
+Readline will make a copy of name.
+The return value is greater than zero unless name is one of
+Readline's builtin keymap names or keymap is one of Readline's
+builtin keymaps.
+
+
@@ -3219,7 +3446,7 @@ initialization function assigned to the rl_start
These functions manage key bindings.
- Function: int rl_bind_key (int key, rl_command_func_t *function)
- Binds key to function in the currently active keymap.
@@ -3227,7 +3454,7 @@ Returns non-zero in the case of an invalid key
- Function: int rl_bind_key_in_map (int key, rl_command_func_t *function, Keymap map)
- Bind key to function in map.
@@ -3235,7 +3462,7 @@ Returns non-zero in the case of an invalid key
- Function: int rl_bind_key_if_unbound (int key, rl_command_func_t *function)
- Binds key to function if it is not already bound in the
@@ -3245,7 +3472,7 @@ already bound.
- Function: int rl_bind_key_if_unbound_in_map (int key, rl_command_func_t *function, Keymap map)
- Binds key to function if it is not already bound in map.
@@ -3254,7 +3481,7 @@ already bound.
- Function: int rl_unbind_key (int key)
- Bind key to the null function in the currently active keymap.
@@ -3262,7 +3489,7 @@ Returns non-zero in case of error.
- Function: int rl_unbind_key_in_map (int key, Keymap map)
- Bind key to the null function in map.
@@ -3270,21 +3497,21 @@ Returns non-zero in case of error.
- Function: int rl_unbind_function_in_map (rl_command_func_t *function, Keymap map)
- Unbind all keys that execute function in map.
- Function: int rl_unbind_command_in_map (const char *command, Keymap map)
- Unbind all keys that are bound to command in map.
- Function: int rl_bind_keyseq (const char *keyseq, rl_command_func_t *function)
- Bind the key sequence represented by the string keyseq to the function
@@ -3294,7 +3521,7 @@ The return value is non-zero if keyseq is i
- Function: int rl_bind_keyseq_in_map (const char *keyseq, rl_command_func_t *function, Keymap map)
- Bind the key sequence represented by the string keyseq to the function
@@ -3304,14 +3531,14 @@ The return value is non-zero if keyseq is i
- Function: int rl_set_key (const char *keyseq, rl_command_func_t *function, Keymap map)
- Equivalent to
rl_bind_keyseq_in_map
.
- Function: int rl_bind_keyseq_if_unbound (const char *keyseq, rl_command_func_t *function)
- Binds keyseq to function if it is not already bound in the
@@ -3321,7 +3548,7 @@ already bound.
- Function: int rl_bind_keyseq_if_unbound_in_map (const char *keyseq, rl_command_func_t *function, Keymap map)
- Binds keyseq to function if it is not already bound in map.
@@ -3330,7 +3557,7 @@ already bound.
- Function: int rl_generic_bind (int type, const char *keyseq, char *data, Keymap map)
- Bind the key sequence represented by the string keyseq to the arbitrary
@@ -3341,7 +3568,7 @@ necessary. The initial keymap in which to do bindings
- Function: int rl_parse_and_bind (char *line)
- Parse line as if it had been read from the
inputrc
file and
@@ -3350,7 +3577,7 @@ perform any key bindings and variable assignments foun
- Function: int rl_read_init_file (const char *filename)
- Read keybindings and variable assignments from filename
@@ -3381,32 +3608,45 @@ and the functions invoked by a particular key sequence
associate a new function name with an arbitrary function.
- Function: rl_command_func_t * rl_named_function (const char *name)
- Return the function with name name.
- Function: rl_command_func_t * rl_function_of_keyseq (const char *keyseq, Keymap map, int *type)
- Return the function invoked by keyseq in keymap map.
If map is
NULL
, the current keymap is used. If type is
not NULL
, the type of the object is returned in the int
variable
it points to (one of ISFUNC
, ISKMAP
, or ISMACR
).
+It takes a "translated" key sequence and should not be used if the key sequence
+can include NUL.
+- Function: rl_command_func_t * rl_function_of_keyseq_len (const char *keyseq, size_t len, Keymap map, int *type)
+
- Return the function invoked by keyseq of length len
+in keymap map. Equivalent to
rl_function_of_keyseq
with the
+addition of the len parameter.
+It takes a "translated" key sequence and should be used if the key sequence
+can include NUL.
+
+
- Function: char ** rl_invoking_keyseqs (rl_command_func_t *function)
- Return an array of strings representing the key sequences used to
invoke function in the current keymap.
- Function: char ** rl_invoking_keyseqs_in_map (rl_command_func_t *function, Keymap map)
- Return an array of strings representing the key sequences used to
@@ -3414,7 +3654,7 @@ invoke function in the keymap map
- Function: void rl_function_dumper (int readable)
- Print the readline function names and the key sequences currently
@@ -3424,14 +3664,14 @@ the list is formatted in such a way that it can be mad
- Function: void rl_list_funmap_names (void)
- Print the names of all bindable Readline functions to
rl_outstream
.
- Function: const char ** rl_funmap_names (void)
- Return a NULL terminated array of known function names. The array is
@@ -3441,7 +3681,7 @@ should free the array, but not the pointers, using
- Function: int rl_add_funmap_entry (const char *name, rl_command_func_t *function)
- Add name to the list of bindable Readline command names, and make
@@ -3496,7 +3736,7 @@ tells what to undo, not how to undo it.
UNDO_BE
rl_end_undo_group()
.
- Function: int rl_begin_undo_group (void)
- Begins saving undo information in a group construct. The undo
@@ -3506,7 +3746,7 @@ information usually comes from calls to
rl_inser
- Function: int rl_end_undo_group (void)
- Closes the current undo group started with
rl_begin_undo_group
@@ -3515,7 +3755,7 @@ for each call to rl_begin_undo_group()
.
- Function: void rl_add_undo (enum undo_code what, int start, int end, char *text)
- Remember how to undo an event (according to what). The affected
@@ -3523,14 +3763,14 @@ text runs from start to end, and
- Function: void rl_free_undo_list (void)
- Free the existing undo list.
- Function: int rl_do_undo (void)
- Undo the first thing on the undo list. Returns
0
if there was
@@ -3544,7 +3784,7 @@ once, just before you modify the text. You must suppl
the text range that you are going to modify.
- Function: int rl_modifying (int start, int end)
- Tell Readline to save the text between start and end as a
@@ -3571,7 +3811,7 @@ that text.
- Function: void rl_redisplay (void)
- Change what's displayed on the screen to reflect the current contents
@@ -3579,7 +3819,7 @@ of
rl_line_buffer
.
- Function: int rl_forced_update_display (void)
- Force the line to be updated and redisplayed, whether or not
@@ -3587,7 +3827,7 @@ Readline thinks the screen display is correct.
- Function: int rl_on_new_line (void)
- Tell the update functions that we have moved onto a new (empty) line,
@@ -3595,7 +3835,7 @@ usually after outputting a newline.
- Function: int rl_on_new_line_with_prompt (void)
- Tell the update functions that we have moved onto a new line, with
@@ -3607,22 +3847,29 @@ It should be used after setting rl_already_prompt
+- Function: int rl_clear_visible_line (void)
+
- Clear the screen lines corresponding to the current line's contents.
+
+
- Function: int rl_reset_line_state (void)
- Reset the display state to a clean state and redisplay the current line
starting on a new line.
- Function: int rl_crlf (void)
- Move the cursor to the start of the next screen line.
- Function: int rl_show_char (int c)
- Display character c on
rl_outstream
.
@@ -3633,7 +3880,7 @@ redisplay.
- Function: int rl_message (const char *, ...)
- The arguments are a format string as would be supplied to
printf
,
@@ -3646,7 +3893,7 @@ before calling this function.
- Function: int rl_clear_message (void)
- Clear the message in the echo area. If the prompt was saved with a call to
@@ -3655,7 +3902,7 @@ call
rl_restore_prompt
before calling thi
- Function: void rl_save_prompt (void)
- Save the local Readline prompt display state in preparation for
@@ -3663,7 +3910,7 @@ displaying a new message in the message area with
- Function: void rl_restore_prompt (void)
- Restore the local Readline prompt display state saved by the most
@@ -3674,7 +3921,7 @@ corresponding call to
rl_clear_message
.
- Function: int rl_expand_prompt (char *prompt)
- Expand any special character sequences in prompt and set up the
@@ -3687,12 +3934,12 @@ It returns the number of visible characters on the las
Applications may indicate that the prompt contains characters that take
up no physical screen space when displayed by bracketing a sequence of
such characters with the special markers
RL_PROMPT_START_IGNORE
-and RL_PROMPT_END_IGNORE
(declared in `readline.h'. This may
+and RL_PROMPT_END_IGNORE
(declared in `readline.h'). This may
be used to embed terminal-specific escape sequences in prompts.
- Function: int rl_set_prompt (const char *prompt)
- Make Readline use prompt for subsequent redisplay. This calls
@@ -3719,7 +3966,7 @@ to the result.
- Function: int rl_insert_text (const char *text)
- Insert text into the line at the current cursor position.
@@ -3727,7 +3974,7 @@ Returns the number of characters inserted.
- Function: int rl_delete_text (int start, int end)
- Delete the text between start and end in the current line.
@@ -3735,7 +3982,7 @@ Returns the number of characters deleted.
- Function: char * rl_copy_text (int start, int end)
- Return a copy of the text between start and end in
@@ -3743,7 +3990,7 @@ the current line.
- Function: int rl_kill_text (int start, int end)
- Copy the text between start and end in the current line
@@ -3755,7 +4002,7 @@ not a kill, a new kill ring slot is used.
- Function: int rl_push_macro_input (char *macro)
- Cause macro to be inserted into the line, as if it had been invoked
@@ -3782,7 +4029,7 @@ by a key bound to a macro. Not especially useful; use
- Function: int rl_read_key (void)
- Return the next character available from Readline's current input stream.
@@ -3794,7 +4041,7 @@ the
rl_event_hook
variable.
- Function: int rl_getc (FILE *stream)
- Return the next character available from stream, which is assumed to
@@ -3802,7 +4049,7 @@ be the keyboard.
- Function: int rl_stuff_char (int c)
- Insert c into the Readline input stream. It will be "read"
@@ -3813,7 +4060,7 @@ before Readline attempts to read characters from the t
- Function: int rl_execute_next (int c)
- Make c be the next command to be executed when
rl_read_key()
@@ -3821,7 +4068,7 @@ is called. This sets rl_pending_input.
- Function: int rl_clear_pending_input (void)
- Unset rl_pending_input, effectively negating the effect of any
@@ -3830,7 +4077,7 @@ pending input has not already been read with
rl_
- Function: int rl_set_keyboard_input_timeout (int u)
- While waiting for keyboard input in
rl_read_key()
, Readline will
@@ -3860,7 +4107,7 @@ Returns the old timeout value.
- Function: void rl_prep_terminal (int meta_flag)
- Modify the terminal settings for Readline's use, so
readline()
@@ -3870,7 +4117,7 @@ read eight-bit input.
- Function: void rl_deprep_terminal (void)
- Undo the effects of
rl_prep_terminal()
, leaving the terminal in
@@ -3879,7 +4126,7 @@ the state in which it was before the most recent call
- Function: void rl_tty_set_default_bindings (Keymap kmap)
- Read the operating system's terminal editing characters (as would be
@@ -3888,7 +4135,7 @@ The bindings are performed in kmap.
- Function: void rl_tty_unset_default_bindings (Keymap kmap)
- Reset the bindings manipulated by
rl_tty_set_default_bindings
so
@@ -3897,8 +4144,19 @@ The bindings are performed in kmap.
+- Function: int rl_tty_set_echoing (int value)
+
- Set Readline's idea of whether or not it is echoing output to its output
+stream (rl_outstream). If value is 0, Readline does not display
+output to rl_outstream; any other value enables output. The initial
+value is set when Readline initializes the terminal settings.
+This function returns the previous value.
+
+
- Function: int rl_reset_terminal (const char *terminal_name)
- Reinitialize Readline's idea of the terminal settings using
terminal_name as the terminal type (e.g.,
vt100
).
@@ -3925,7 +4183,7 @@ environment variable is used.
- Function: int rl_save_state (struct readline_state *sp)
- Save a snapshot of Readline's internal state to sp.
@@ -3935,7 +4193,7 @@ The caller is responsible for allocating the structure
- Function: int rl_restore_state (struct readline_state *sp)
- Restore Readline's internal state to that stored in sp, which must
@@ -3946,7 +4204,7 @@ The caller is responsible for freeing the structure.
- Function: void rl_free (void *mem)
- Deallocate the memory pointed to by mem. mem must have been
@@ -3954,7 +4212,7 @@ allocated by
malloc
.
- Function: void rl_replace_line (const char *text, int clear_undo)
- Replace the contents of
rl_line_buffer
with text.
@@ -3964,7 +4222,7 @@ current line is cleared.
- Function: void rl_extend_line_buffer (int len)
- Ensure that
rl_line_buffer
has enough space to hold len
@@ -3972,7 +4230,7 @@ characters, possibly reallocating it if necessary.
- Function: int rl_initialize (void)
- Initialize or re-initialize Readline's internal state.
@@ -3981,21 +4239,21 @@ reading any input.
- Function: int rl_ding (void)
- Ring the terminal bell, obeying the setting of
bell-style
.
- Function: int rl_alphabetic (int c)
- Return 1 if c is an alphabetic character.
- Function: void rl_display_match_list (char **matches, int len, int max)
- A convenience function for displaying a list of strings in
@@ -4015,28 +4273,28 @@ The following are implemented as macros, defined in
- Function: int _rl_uppercase_p (int c)
- Return 1 if c is an uppercase alphabetic character.
- Function: int _rl_lowercase_p (int c)
- Return 1 if c is a lowercase alphabetic character.
- Function: int _rl_digit_p (int c)
- Return 1 if c is a numeric character.
- Function: int _rl_to_upper (int c)
- If c is a lowercase alphabetic character, return the corresponding
@@ -4044,7 +4302,7 @@ uppercase character.
- Function: int _rl_to_lower (int c)
- If c is an uppercase alphabetic character, return the corresponding
@@ -4052,7 +4310,7 @@ lowercase character.
- Function: int _rl_digit_value (int c)
- If c is a number, return the value it represents.
@@ -4077,7 +4335,7 @@ lowercase character.
- Function: int rl_macro_bind (const char *keyseq, const char *macro, Keymap map)
- Bind the key sequence keyseq to invoke the macro macro.
@@ -4087,7 +4345,7 @@ use
rl_generic_bind()
instead.
- Function: void rl_macro_dumper (int readable)
- Print the key sequences bound to macros and their values, using
@@ -4097,7 +4355,7 @@ that it can be made part of an
inputrc
fi
- Function: int rl_variable_bind (const char *variable, const char *value)
- Make the Readline variable variable have value.
@@ -4107,7 +4365,7 @@ file (see section 1.3.1
- Function: char * rl_variable_value (const char *variable)
- Return a string representing the value of the Readline variable variable.
@@ -4115,7 +4373,7 @@ For boolean variables, this string is either `on
- Function: void rl_variable_dumper (int readable)
- Print the readline variable names and their current values
@@ -4125,7 +4383,7 @@ that it can be made part of an
inputrc
fi
- Function: int rl_set_paren_blink_timeout (int u)
- Set the time interval (in microseconds) that Readline waits when showing
@@ -4133,7 +4391,7 @@ a balancing character when
blink-matching-paren<
- Function: char * rl_get_termcap (const char *cap)
- Retrieve the string value of the termcap capability cap.
@@ -4145,7 +4403,7 @@ values for only those capabilities Readline uses.
- Function: void rl_clear_history (void)
- Clear the history list by deleting all of the entries, in the same manner
@@ -4155,6 +4413,41 @@ Readline saves in the history list.
+- Function: void rl_activate_mark (void)
+
- Enable an active mark.
+When this is enabled, the text between point and mark (the region) is
+displayed in the terminal's standout mode (a face).
+This is called by various readline functions that set the mark and insert
+text, and is available for applications to call.
+
+
+- Function: void rl_deactivate_mark (void)
+
- Turn off the active mark.
+
+
+- Function: void rl_keep_mark_active (void)
+
- 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.
+
+
+- Function: int rl_mark_active_p (void)
+
- Return a non-zero value if the mark is currently active; zero otherwise.
+
+
@@ -4181,7 +4474,7 @@ also be invoked as a `callback' function from an event
are functions available to make this easy.
- Function: void rl_callback_handler_install (const char *prompt, rl_vcpfunc_t *lhandler)
- Set up the terminal for readline I/O and display the initial
@@ -4189,10 +4482,12 @@ expanded value of prompt. Save the value o
use as a handler function to call when a complete line of input has been
entered.
The handler function receives the text of the line as an argument.
+As with
readline()
, the handler function should free
the
+line when it it finished with it.
- Function: void rl_callback_read_char (void)
- Whenever an application determines that keyboard input is available, it
@@ -4212,11 +4507,22 @@ the terminal settings are modified for Readline's use
+- Function: void rl_callback_sigcleanup (void)
+
- Clean up any internal state the callback interface uses to maintain state
+between calls to rl_callback_read_char (e.g., the state of any active
+incremental searches). This is intended to be used by applications that
+wish to perform their own signal handling; Readline's internal signal handler
+calls this when appropriate.
+
+
- Function: void rl_callback_handler_remove (void)
- Restore the terminal to its initial state and remove the line handler.
-This may be called from within a callback as well as independently.
+You may call this function from within a callback as well as independently.
If the lhandler installed by
rl_callback_handler_install
does not exit the program, either this function or the function referred
to by the value of rl_deprep_term_function
should be called before
@@ -4332,12 +4638,16 @@ It understands the EOF character or "exit" to exit the
Jump to: _
@@ -7165,7 +7599,7 @@ to permit their use in free software.
[ ? ]
About this document
-This document was generated by Chet Ramey on February, 11 2014
+This document was generated by Chet Ramey on October, 30 2020
using texi2html
@@ -7327,7 +7761,7 @@ the following structure:
This document was generated
-by Chet Ramey on February, 11 2014
+by Chet Ramey on October, 30 2020
using texi2html