From: Chet Ramey Date: Sat, 27 Jan 2024 21:29:47 +0000 (-0500) Subject: fix leaks on signals for non-incremental searches; fix leaks in new readstr interface X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=66bddcf3f94a2fc3dd76cd024d6227d6e71e22cf;p=thirdparty%2Freadline.git fix leaks on signals for non-incremental searches; fix leaks in new readstr interface --- diff --git a/callback.c b/callback.c index d78a7ca..d376f94 100644 --- a/callback.c +++ b/callback.c @@ -363,7 +363,7 @@ rl_callback_sigcleanup (void) if (RL_ISSTATE (RL_STATE_ISEARCH)) _rl_isearch_cleanup (_rl_iscxt, 0); else if (RL_ISSTATE (RL_STATE_NSEARCH)) - _rl_nsearch_cleanup (_rl_nscxt, 0); + _rl_nsearch_sigcleanup (_rl_nscxt, 0); else if (RL_ISSTATE (RL_STATE_VIMOTION)) RL_UNSETSTATE (RL_STATE_VIMOTION); else if (RL_ISSTATE (RL_STATE_NUMERICARG)) @@ -373,6 +373,9 @@ rl_callback_sigcleanup (void) } else if (RL_ISSTATE (RL_STATE_MULTIKEY)) RL_UNSETSTATE (RL_STATE_MULTIKEY); + else if (RL_ISSTATE (RL_STATE_READSTR)) + _rl_readstr_sigcleanup (_rl_rscxt, 0); + if (RL_ISSTATE (RL_STATE_CHARSEARCH)) RL_UNSETSTATE (RL_STATE_CHARSEARCH); diff --git a/complete.c b/complete.c index 79e37cc..d0165cc 100644 --- a/complete.c +++ b/complete.c @@ -1355,6 +1355,7 @@ compute_lcd_of_matches (char **match_list, int matches, const char *text) int low; /* Count of max-matched characters. */ int lx; char *dtext; /* dequoted TEXT, if needed */ + size_t len1, len2; #if defined (HANDLE_MULTIBYTE) int v; size_t v1, v2; @@ -1381,6 +1382,9 @@ compute_lcd_of_matches (char **match_list, int matches, const char *text) memset (&ps2, 0, sizeof (mbstate_t)); } #endif + len1 = strlen (match_list[i]); + len2 = strlen (match_list[i + 1]); + for (si = 0; (c1 = match_list[i][si]) && (c2 = match_list[i + 1][si]); si++) { if (_rl_completion_case_fold) @@ -1391,8 +1395,8 @@ compute_lcd_of_matches (char **match_list, int matches, const char *text) #if defined (HANDLE_MULTIBYTE) if (MB_CUR_MAX > 1 && rl_byte_oriented == 0) { - v1 = MBRTOWC (&wc1, match_list[i]+si, strlen (match_list[i]+si), &ps1); - v2 = MBRTOWC (&wc2, match_list[i+1]+si, strlen (match_list[i+1]+si), &ps2); + v1 = MBRTOWC (&wc1, match_list[i]+si, len1 - si, &ps1); + v2 = MBRTOWC (&wc2, match_list[i+1]+si, len2 - si, &ps2); if (MB_INVALIDCH (v1) || MB_INVALIDCH (v2)) { if (c1 != c2) /* do byte comparison */ diff --git a/doc/Makefile.in b/doc/Makefile.in index 20a3618..a6640cb 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -73,7 +73,7 @@ HISTSRC = $(srcdir)/history.texi $(srcdir)/hsuser.texi \ $(srcdir)/hstech.texi $(srcdir)/version.texi $(srcdir)/fdl.texi # This should be a program that converts troff to an ascii-readable format -NROFF = groff -Tascii +NROFF = groff -Tascii -P -c # This should be a program that converts troff to postscript GROFF = groff diff --git a/doc/history.0 b/doc/history.0 index 2bf3b1a..f5eb44f 100644 --- a/doc/history.0 +++ b/doc/history.0 @@ -2,22 +2,22 @@ HISTORY(3) Library Functions Manual HISTORY(3) -NAME +NNAAMMEE history - GNU History Library -COPYRIGHT - The GNU History Library is Copyright (C) 1989-2020 by the Free Software +CCOOPPYYRRIIGGHHTT + The GNU History Library is Copyright (C) 1989-2024 by the Free Software Foundation, Inc. -DESCRIPTION +DDEESSCCRRIIPPTTIIOONN Many programs read input from the user a line at a time. The GNU His- tory library is able to keep track of those lines, associate arbitrary data with each line, and utilize information from previous lines in composing new ones. -HISTORY EXPANSION +HHIISSTTOORRYY EEXXPPAANNSSIIOONN The history library supports a history expansion feature that is iden- - tical to the history expansion in bash. This section describes what + tical to the history expansion in bbaasshh.. This section describes what syntax features are available. History expansions introduce words from the history list into the input @@ -29,112 +29,122 @@ HISTORY(3) Library Functions Manual HISTORY(3) line is read. It takes place in two parts. The first is to determine which line from the history list to use during substitution. The sec- ond is to select portions of that line for inclusion into the current - one. The line selected from the history is the event, and the portions - of that line that are acted upon are words. Various modifiers are + one. The line selected from the history is the _e_v_e_n_t, and the portions + of that line that are acted upon are _w_o_r_d_s. Various _m_o_d_i_f_i_e_r_s are available to manipulate the selected words. The line is broken into - words in the same fashion as bash does when reading input, so that sev- + words in the same fashion as bbaasshh does when reading input, so that sev- eral words that would otherwise be separated are considered one word - when surrounded by quotes (see the description of history_tokenize() - below). History expansions are introduced by the appearance of the - history expansion character, which is ! by default. Only backslash (\) - and single quotes can quote the history expansion character. - - Event Designators + when surrounded by quotes (see the description of hhiissttoorryy__ttookkeenniizzee(()) + below). + + History expansions are introduced by the appearance of the history ex- + pansion character, which is !! by default. Only backslash (\\) and sin- + gle quotes can quote the history expansion character. + + There is a special abbreviation for substitution, active when the _q_u_i_c_k + _s_u_b_s_t_i_t_u_t_i_o_n character (default ^^) is the first character on the line. + It selects the previous history list entry, using an event designator + equivalent to !!!!, and substitutes one string for another in that line. + It is described below under EEvveenntt DDeessiiggnnaattoorrss. This is the only his- + tory expansion that does not begin with the history expansion charac- + ter. + + EEvveenntt DDeessiiggnnaattoorrss An event designator is a reference to a command line entry in the his- tory list. Unless the reference is absolute, events are relative to the current position in the history list. - ! Start a history substitution, except when followed by a blank, + !! Start a history substitution, except when followed by a bbllaannkk, newline, = or (. - !n Refer to command line n. - !-n Refer to the current command minus n. - !! Refer to the previous command. This is a synonym for `!-1'. - !string + !!_n Refer to command line _n. + !!--_n Refer to the current command minus _n. + !!!! Refer to the previous command. This is a synonym for `!-1'. + !!_s_t_r_i_n_g Refer to the most recent command preceding the current position - in the history list starting with string. - !?string[?] + in the history list starting with _s_t_r_i_n_g. + !!??_s_t_r_i_n_g[[??]] Refer to the most recent command preceding the current position - in the history list containing string. The trailing ? may be - omitted if string is followed immediately by a newline. If - string is missing, the string from the most recent search is + in the history list containing _s_t_r_i_n_g. The trailing ?? may be + omitted if _s_t_r_i_n_g is followed immediately by a newline. If + _s_t_r_i_n_g is missing, the string from the most recent search is used; it is an error if there is no previous search string. - ^string1^string2^ - Quick substitution. Repeat the last command, replacing string1 - with string2. Equivalent to ``!!:s^string1^string2^'' (see Mod- - ifiers below). - !# The entire command line typed so far. - - Word Designators - Word designators are used to select desired words from the event. A : + ^^_s_t_r_i_n_g_1^^_s_t_r_i_n_g_2^^ + Quick substitution. Repeat the last command, replacing _s_t_r_i_n_g_1 + with _s_t_r_i_n_g_2. Equivalent to "!!:s^_s_t_r_i_n_g_1^_s_t_r_i_n_g_2^" (see MMooddii-- + ffiieerrss below). + !!## The entire command line typed so far. + + WWoorrdd DDeessiiggnnaattoorrss + Word designators are used to select desired words from the event. A :: separates the event specification from the word designator. It may be - omitted if the word designator begins with a ^, $, *, -, or %. Words + omitted if the word designator begins with a ^^, $$, **, --, or %%. Words are numbered from the beginning of the line, with the first word being denoted by 0 (zero). Words are inserted into the current line sepa- rated by single spaces. - 0 (zero) + 00 ((zzeerroo)) The zeroth word. For the shell, this is the command word. - n The nth word. - ^ The first argument. That is, word 1. - $ The last word. This is usually the last argument, but will ex- + _n The _nth word. + ^^ The first argument. That is, word 1. + $$ The last word. This is usually the last argument, but will ex- pand to the zeroth word if there is only one word in the line. - % The first word matched by the most recent `?string?' search, if + %% The first word matched by the most recent `?_s_t_r_i_n_g?' search, if the search string begins with a character that is part of a word. - x-y A range of words; `-y' abbreviates `0-y'. - * All of the words but the zeroth. This is a synonym for `1-$'. - It is not an error to use * if there is just one word in the + _x--_y A range of words; `-_y' abbreviates `0-_y'. + ** All of the words but the zeroth. This is a synonym for `_1_-_$'. + It is not an error to use ** if there is just one word in the event; the empty string is returned in that case. - x* Abbreviates x-$. - x- Abbreviates x-$ like x*, but omits the last word. If x is miss- + xx** Abbreviates _x_-_$. + xx-- Abbreviates _x_-_$ like xx**, but omits the last word. If xx is miss- ing, it defaults to 0. If a word designator is supplied without an event specification, the previous command is used as the event. - Modifiers + MMooddiiffiieerrss After the optional word designator, there may appear a sequence of one or more of the following modifiers, each preceded by a `:'. These mod- ify, or edit, the word or words selected from the history event. - h Remove a trailing file name component, leaving only the head. - t Remove all leading file name components, leaving the tail. - r Remove a trailing suffix of the form .xxx, leaving the basename. - e Remove all but the trailing suffix. - p Print the new command but do not execute it. - q Quote the substituted words, escaping further substitutions. - x Quote the substituted words as with q, but break into words at - blanks and newlines. The q and x modifiers are mutually exclu- + hh Remove a trailing file name component, leaving only the head. + tt Remove all leading file name components, leaving the tail. + rr Remove a trailing suffix of the form _._x_x_x, leaving the basename. + ee Remove all but the trailing suffix. + pp Print the new command but do not execute it. + qq Quote the substituted words, escaping further substitutions. + xx Quote the substituted words as with qq, but break into words at + bbllaannkkss and newlines. The qq and xx modifiers are mutually exclu- sive; the last one supplied is used. - s/old/new/ - Substitute new for the first occurrence of old in the event + ss//_o_l_d//_n_e_w// + Substitute _n_e_w for the first occurrence of _o_l_d in the event line. Any character may be used as the delimiter in place of /. The final delimiter is optional if it is the last character of - the event line. The delimiter may be quoted in old and new with - a single backslash. If & appears in new, it is replaced by old. - A single backslash will quote the &. If old is null, it is set - to the last old substituted, or, if no previous history substi- - tutions took place, the last string in a !?string[?] search. - If new is null, each matching old is deleted. - & Repeat the previous substitution. - g Cause changes to be applied over the entire event line. This is - used in conjunction with `:s' (e.g., `:gs/old/new/') or `:&'. - If used with `:s', any delimiter can be used in place of /, and + the event line. The delimiter may be quoted in _o_l_d and _n_e_w with + a single backslash. If & appears in _n_e_w, it is replaced by _o_l_d. + A single backslash will quote the &. If _o_l_d is null, it is set + to the last _o_l_d substituted, or, if no previous history substi- + tutions took place, the last _s_t_r_i_n_g in a !!??_s_t_r_i_n_g[[??]] search. + If _n_e_w is null, each matching _o_l_d is deleted. + && Repeat the previous substitution. + gg Cause changes to be applied over the entire event line. This is + used in conjunction with `::ss' (e.g., `::ggss//_o_l_d//_n_e_w//') or `::&&'. + If used with `::ss', any delimiter can be used in place of /, and the final delimiter is optional if it is the last character of - the event line. An a may be used as a synonym for g. - G Apply the following `s' or `&' modifier once to each word in the + the event line. An aa may be used as a synonym for gg. + GG Apply the following `ss' or `&&' modifier once to each word in the event line. -PROGRAMMING WITH HISTORY FUNCTIONS +PPRROOGGRRAAMMMMIINNGG WWIITTHH HHIISSTTOORRYY FFUUNNCCTTIIOONNSS This section describes how to use the History library in other pro- grams. - Introduction to History + IInnttrroodduuccttiioonn ttoo HHiissttoorryy A programmer using the History library has available functions for re- membering lines on a history list, associating arbitrary data with a line, removing lines from the list, searching through the list for a line containing an arbitrary text string, and referencing any line in - the list directly. In addition, a history expansion function is avail- + the list directly. In addition, a history _e_x_p_a_n_s_i_o_n function is avail- able which provides for a consistent user interface across different programs. @@ -142,7 +152,7 @@ HISTORY(3) Library Functions Manual HISTORY(3) fit of a consistent user interface with a set of well-known commands for manipulating the text of previous lines and using that text in new commands. The basic history manipulation commands are identical to the - history substitution provided by bash. + history substitution provided by bbaasshh. The programmer can also use the readline library, which includes some history manipulation by default, and has the added advantage of command @@ -150,16 +160,16 @@ HISTORY(3) Library Functions Manual HISTORY(3) Before declaring any functions using any functionality the History li- brary provides in other code, an application writer should include the - file  in any file that uses the History library's + file _<_r_e_a_d_l_i_n_e_/_h_i_s_t_o_r_y_._h_> in any file that uses the History library's features. It supplies extern declarations for all of the library's public functions and variables, and declares all of the public data structures. - History Storage + HHiissttoorryy SSttoorraaggee The history list is an array of history entries. A history entry is declared as follows: - typedef void * histdata_t; + _t_y_p_e_d_e_f _v_o_i_d _* hhiissttddaattaa__tt;; typedef struct _hist_entry { char *line; @@ -169,7 +179,7 @@ HISTORY(3) Library Functions Manual HISTORY(3) The history list itself might therefore be declared as - HIST_ENTRY ** the_history_list; + _H_I_S_T___E_N_T_R_Y _*_* tthhee__hhiissttoorryy__lliisstt;; The state of the History library is encapsulated into a single struc- ture: @@ -185,197 +195,197 @@ HISTORY(3) Library Functions Manual HISTORY(3) int flags; } HISTORY_STATE; - If the flags member includes HS_STIFLED, the history has been stifled. + If the flags member includes HHSS__SSTTIIFFLLEEDD, the history has been stifled. -History Functions +HHiissttoorryy FFuunnccttiioonnss This section describes the calling sequence for the various functions exported by the GNU History library. - Initializing History and State Management + IInniittiiaalliizziinngg HHiissttoorryy aanndd SSttaattee MMaannaaggeemmeenntt This section describes functions used to initialize and manage the state of the History library when you want to use the history functions in your program. - void using_history (void) + _v_o_i_d uussiinngg__hhiissttoorryy (_v_o_i_d) Begin a session in which the history functions might be used. This initializes the interactive variables. - HISTORY_STATE * history_get_history_state (void) + _H_I_S_T_O_R_Y___S_T_A_T_E _* hhiissttoorryy__ggeett__hhiissttoorryy__ssttaattee (_v_o_i_d) Return a structure describing the current state of the input history. - void history_set_history_state (HISTORY_STATE *state) - Set the state of the history list according to state. + _v_o_i_d hhiissttoorryy__sseett__hhiissttoorryy__ssttaattee (_H_I_S_T_O_R_Y___S_T_A_T_E _*_s_t_a_t_e) + Set the state of the history list according to _s_t_a_t_e. - History List Management + HHiissttoorryy LLiisstt MMaannaaggeemmeenntt These functions manage individual entries on the history list, or set parameters managing the list itself. - void add_history (const char *string) - Place string at the end of the history list. The associated data field - (if any) is set to NULL. If the maximum number of history entries has - been set using stifle_history(), and the new number of history entries + _v_o_i_d aadddd__hhiissttoorryy (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g) + Place _s_t_r_i_n_g at the end of the history list. The associated data field + (if any) is set to NNUULLLL. If the maximum number of history entries has + been set using ssttiiffllee__hhiissttoorryy(()), and the new number of history entries would exceed that maximum, the oldest history entry is removed. - void add_history_time (const char *string) + _v_o_i_d aadddd__hhiissttoorryy__ttiimmee (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g) Change the time stamp associated with the most recent history entry to - string. + _s_t_r_i_n_g. - HIST_ENTRY * remove_history (int which) - Remove history entry at offset which from the history. The removed el- + _H_I_S_T___E_N_T_R_Y _* rreemmoovvee__hhiissttoorryy (_i_n_t _w_h_i_c_h) + Remove history entry at offset _w_h_i_c_h from the history. The removed el- ement is returned so you can free the line, data, and containing struc- ture. - histdata_t free_history_entry (HIST_ENTRY *histent) - Free the history entry histent and any history library private data as- + _h_i_s_t_d_a_t_a___t ffrreeee__hhiissttoorryy__eennttrryy (_H_I_S_T___E_N_T_R_Y _*_h_i_s_t_e_n_t) + Free the history entry _h_i_s_t_e_n_t and any history library private data as- sociated with it. Returns the application-specific data so the caller can dispose of it. - HIST_ENTRY * replace_history_entry (int which, const char *line, hist- - data_t data) - Make the history entry at offset which have line and data. This re- + _H_I_S_T___E_N_T_R_Y _* rreeppllaaccee__hhiissttoorryy__eennttrryy (_i_n_t _w_h_i_c_h_, _c_o_n_s_t _c_h_a_r _*_l_i_n_e_, _h_i_s_t_- + _d_a_t_a___t _d_a_t_a) + Make the history entry at offset _w_h_i_c_h have _l_i_n_e and _d_a_t_a. This re- turns the old entry so the caller can dispose of any application-spe- - cific data. In the case of an invalid which, a NULL pointer is re- + cific data. In the case of an invalid _w_h_i_c_h, a NNUULLLL pointer is re- turned. - void clear_history (void) + _v_o_i_d cclleeaarr__hhiissttoorryy (_v_o_i_d) Clear the history list by deleting all the entries. - void stifle_history (int max) - Stifle the history list, remembering only the last max entries. The - history list will contain only max entries at a time. + _v_o_i_d ssttiiffllee__hhiissttoorryy (_i_n_t _m_a_x) + Stifle the history list, remembering only the last _m_a_x entries. The + history list will contain only _m_a_x entries at a time. - int unstifle_history (void) + _i_n_t uunnssttiiffllee__hhiissttoorryy (_v_o_i_d) Stop stifling the history. This returns the previously-set maximum - number of history entries (as set by stifle_history()). history was + number of history entries (as set by ssttiiffllee__hhiissttoorryy(())). history was stifled. The value is positive if the history was stifled, negative if it wasn't. - int history_is_stifled (void) + _i_n_t hhiissttoorryy__iiss__ssttiifflleedd (_v_o_i_d) Returns non-zero if the history is stifled, zero if it is not. - Information About the History List + IInnffoorrmmaattiioonn AAbboouutt tthhee HHiissttoorryy LLiisstt These functions return information about the entire history list or in- dividual list entries. - HIST_ENTRY ** history_list (void) - Return a NULL terminated array of HIST_ENTRY * which is the current in- + _H_I_S_T___E_N_T_R_Y _*_* hhiissttoorryy__lliisstt (_v_o_i_d) + Return a NNUULLLL terminated array of _H_I_S_T___E_N_T_R_Y _* which is the current in- put history. Element 0 of this list is the beginning of time. If - there is no history, return NULL. + there is no history, return NNUULLLL. - int where_history (void) + _i_n_t wwhheerree__hhiissttoorryy (_v_o_i_d) Returns the offset of the current history element. - HIST_ENTRY * current_history (void) + _H_I_S_T___E_N_T_R_Y _* ccuurrrreenntt__hhiissttoorryy (_v_o_i_d) Return the history entry at the current position, as determined by - where_history(). If there is no entry there, return a NULL pointer. + wwhheerree__hhiissttoorryy(()). If there is no entry there, return a NNUULLLL pointer. - HIST_ENTRY * history_get (int offset) - Return the history entry at position offset. The range of valid values - of offset starts at history_base and ends at history_length - 1. If - there is no entry there, or if offset is outside the valid range, re- - turn a NULL pointer. + _H_I_S_T___E_N_T_R_Y _* hhiissttoorryy__ggeett (_i_n_t _o_f_f_s_e_t) + Return the history entry at position _o_f_f_s_e_t. The range of valid values + of _o_f_f_s_e_t starts at hhiissttoorryy__bbaassee and ends at hhiissttoorryy__lleennggtthh - 1. If + there is no entry there, or if _o_f_f_s_e_t is outside the valid range, re- + turn a NNUULLLL pointer. - time_t history_get_time (HIST_ENTRY *) + _t_i_m_e___t hhiissttoorryy__ggeett__ttiimmee (_H_I_S_T___E_N_T_R_Y _*) Return the time stamp associated with the history entry passed as the argument. - int history_total_bytes (void) + _i_n_t hhiissttoorryy__ttoottaall__bbyytteess (_v_o_i_d) Return the number of bytes that the primary history entries are using. This function returns the sum of the lengths of all the lines in the history. - Moving Around the History List + MMoovviinngg AArroouunndd tthhee HHiissttoorryy LLiisstt These functions allow the current index into the history list to be set or changed. - int history_set_pos (int pos) - Set the current history offset to pos, an absolute index into the list. - Returns 1 on success, 0 if pos is less than zero or greater than the + _i_n_t hhiissttoorryy__sseett__ppooss (_i_n_t _p_o_s) + Set the current history offset to _p_o_s, an absolute index into the list. + Returns 1 on success, 0 if _p_o_s is less than zero or greater than the number of history entries. - HIST_ENTRY * previous_history (void) + _H_I_S_T___E_N_T_R_Y _* pprreevviioouuss__hhiissttoorryy (_v_o_i_d) Back up the current history offset to the previous history entry, and return a pointer to that entry. If there is no previous entry, return - a NULL pointer. + a NNUULLLL pointer. - HIST_ENTRY * next_history (void) + _H_I_S_T___E_N_T_R_Y _* nneexxtt__hhiissttoorryy (_v_o_i_d) If the current history offset refers to a valid history entry, incre- ment the current history offset. If the possibly-incremented history offset refers to a valid history entry, return a pointer to that entry; - otherwise, return a NULL pointer. + otherwise, return a NNUULLLL pointer. - Searching the History List + SSeeaarrcchhiinngg tthhee HHiissttoorryy LLiisstt These functions allow searching of the history list for entries con- taining a specific string. Searching may be performed both forward and - backward from the current history position. The search may be an- - chored, meaning that the string must match at the beginning of the his- + backward from the current history position. The search may be _a_n_- + _c_h_o_r_e_d, meaning that the string must match at the beginning of the his- tory entry. - int history_search (const char *string, int direction) - Search the history for string, starting at the current history offset. - If direction is less than 0, then the search is through previous en- - tries, otherwise through subsequent entries. If string is found, then + _i_n_t hhiissttoorryy__sseeaarrcchh (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g_, _i_n_t _d_i_r_e_c_t_i_o_n) + Search the history for _s_t_r_i_n_g, starting at the current history offset. + If _d_i_r_e_c_t_i_o_n is less than 0, then the search is through previous en- + tries, otherwise through subsequent entries. If _s_t_r_i_n_g is found, then the current history index is set to that history entry, and the value - returned is the offset in the line of the entry where string was found. + returned is the offset in the line of the entry where _s_t_r_i_n_g was found. Otherwise, nothing is changed, and a -1 is returned. - int history_search_prefix (const char *string, int direction) - Search the history for string, starting at the current history offset. - The search is anchored: matching lines must begin with string. If di- - rection is less than 0, then the search is through previous entries, - otherwise through subsequent entries. If string is found, then the + _i_n_t hhiissttoorryy__sseeaarrcchh__pprreeffiixx (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g_, _i_n_t _d_i_r_e_c_t_i_o_n) + Search the history for _s_t_r_i_n_g, starting at the current history offset. + The search is anchored: matching lines must begin with _s_t_r_i_n_g. If _d_i_- + _r_e_c_t_i_o_n is less than 0, then the search is through previous entries, + otherwise through subsequent entries. If _s_t_r_i_n_g is found, then the current history index is set to that entry, and the return value is 0. Otherwise, nothing is changed, and a -1 is returned. - int history_search_pos (const char *string, int direction, int pos) - Search for string in the history list, starting at pos, an absolute in- - dex into the list. If direction is negative, the search proceeds back- - ward from pos, otherwise forward. Returns the absolute index of the - history element where string was found, or -1 otherwise. + _i_n_t hhiissttoorryy__sseeaarrcchh__ppooss (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g_, _i_n_t _d_i_r_e_c_t_i_o_n_, _i_n_t _p_o_s) + Search for _s_t_r_i_n_g in the history list, starting at _p_o_s, an absolute in- + dex into the list. If _d_i_r_e_c_t_i_o_n is negative, the search proceeds back- + ward from _p_o_s, otherwise forward. Returns the absolute index of the + history element where _s_t_r_i_n_g was found, or -1 otherwise. - Managing the History File + MMaannaaggiinngg tthhee HHiissttoorryy FFiillee The History library can read the history from and write it to a file. This section documents the functions for managing a history file. - int read_history (const char *filename) - Add the contents of filename to the history list, a line at a time. If - filename is NULL, then read from ~/.history. Returns 0 if successful, - or errno if not. + _i_n_t rreeaadd__hhiissttoorryy (_c_o_n_s_t _c_h_a_r _*_f_i_l_e_n_a_m_e) + Add the contents of _f_i_l_e_n_a_m_e to the history list, a line at a time. If + _f_i_l_e_n_a_m_e is NNUULLLL, then read from _~_/_._h_i_s_t_o_r_y. Returns 0 if successful, + or eerrrrnnoo if not. - int read_history_range (const char *filename, int from, int to) - Read a range of lines from filename, adding them to the history list. - Start reading at line from and end at to. If from is zero, start at - the beginning. If to is less than from, then read until the end of the - file. If filename is NULL, then read from ~/.history. Returns 0 if - successful, or errno if not. + _i_n_t rreeaadd__hhiissttoorryy__rraannggee (_c_o_n_s_t _c_h_a_r _*_f_i_l_e_n_a_m_e_, _i_n_t _f_r_o_m_, _i_n_t _t_o) + Read a range of lines from _f_i_l_e_n_a_m_e, adding them to the history list. + Start reading at line _f_r_o_m and end at _t_o. If _f_r_o_m is zero, start at + the beginning. If _t_o is less than _f_r_o_m, then read until the end of the + file. If _f_i_l_e_n_a_m_e is NNUULLLL, then read from _~_/_._h_i_s_t_o_r_y. Returns 0 if + successful, or eerrrrnnoo if not. - int write_history (const char *filename) - Write the current history to filename, overwriting filename if neces- - sary. If filename is NULL, then write the history list to ~/.history. - Returns 0 on success, or errno on a read or write error. + _i_n_t wwrriittee__hhiissttoorryy (_c_o_n_s_t _c_h_a_r _*_f_i_l_e_n_a_m_e) + Write the current history to _f_i_l_e_n_a_m_e, overwriting _f_i_l_e_n_a_m_e if neces- + sary. If _f_i_l_e_n_a_m_e is NNUULLLL, then write the history list to _~_/_._h_i_s_t_o_r_y. + Returns 0 on success, or eerrrrnnoo on a read or write error. - int append_history (int nelements, const char *filename) - Append the last nelements of the history list to filename. If filename - is NULL, then append to ~/.history. Returns 0 on success, or errno on + _i_n_t aappppeenndd__hhiissttoorryy (_i_n_t _n_e_l_e_m_e_n_t_s_, _c_o_n_s_t _c_h_a_r _*_f_i_l_e_n_a_m_e) + Append the last _n_e_l_e_m_e_n_t_s of the history list to _f_i_l_e_n_a_m_e. If _f_i_l_e_n_a_m_e + is NNUULLLL, then append to _~_/_._h_i_s_t_o_r_y. Returns 0 on success, or eerrrrnnoo on a read or write error. - int history_truncate_file (const char *filename, int nlines) - Truncate the history file filename, leaving only the last nlines lines. - If filename is NULL, then ~/.history is truncated. Returns 0 on suc- - cess, or errno on failure. + _i_n_t hhiissttoorryy__ttrruunnccaattee__ffiillee (_c_o_n_s_t _c_h_a_r _*_f_i_l_e_n_a_m_e_, _i_n_t _n_l_i_n_e_s) + Truncate the history file _f_i_l_e_n_a_m_e, leaving only the last _n_l_i_n_e_s lines. + If _f_i_l_e_n_a_m_e is NNUULLLL, then _~_/_._h_i_s_t_o_r_y is truncated. Returns 0 on suc- + cess, or eerrrrnnoo on failure. - History Expansion + HHiissttoorryy EExxppaannssiioonn These functions implement history expansion. - int history_expand (char *string, char **output) - Expand string, placing the result into output, a pointer to a string. + _i_n_t hhiissttoorryy__eexxppaanndd (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g_, _c_h_a_r _*_*_o_u_t_p_u_t) + Expand _s_t_r_i_n_g, placing the result into _o_u_t_p_u_t, a pointer to a string. Returns: 0 If no expansions took place (or, if the only change in the text was the removal of escape characters preceding @@ -383,123 +393,123 @@ HISTORY(3) Library Functions Manual HISTORY(3) 1 if expansions did take place; -1 if there was an error in expansion; 2 if the returned line should be displayed, but not exe- - cuted, as with the :p modifier. - If an error occurred in expansion, then output contains a descriptive + cuted, as with the ::pp modifier. + If an error occurred in expansion, then _o_u_t_p_u_t contains a descriptive error message. - char * get_history_event (const char *string, int *cindex, int qchar) - Returns the text of the history event beginning at string + *cindex. - *cindex is modified to point to after the event specifier. At function - entry, cindex points to the index into string where the history event - specification begins. qchar is a character that is allowed to end the + _c_h_a_r _* ggeett__hhiissttoorryy__eevveenntt (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g_, _i_n_t _*_c_i_n_d_e_x_, _i_n_t _q_c_h_a_r) + Returns the text of the history event beginning at _s_t_r_i_n_g + _*_c_i_n_d_e_x. + _*_c_i_n_d_e_x is modified to point to after the event specifier. At function + entry, _c_i_n_d_e_x points to the index into _s_t_r_i_n_g where the history event + specification begins. _q_c_h_a_r is a character that is allowed to end the event specification in addition to the ``normal'' terminating charac- ters. - char ** history_tokenize (const char *string) - Return an array of tokens parsed out of string, much as the shell - might. The tokens are split on the characters in the history_word_de- - limiters variable, and shell quoting conventions are obeyed. + _c_h_a_r _*_* hhiissttoorryy__ttookkeenniizzee (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g) + Return an array of tokens parsed out of _s_t_r_i_n_g, much as the shell + might. The tokens are split on the characters in the hhiissttoorryy__wwoorrdd__ddee-- + lliimmiitteerrss variable, and shell quoting conventions are obeyed. - char * history_arg_extract (int first, int last, const char *string) - Extract a string segment consisting of the first through last arguments - present in string. Arguments are split using history_tokenize(). + _c_h_a_r _* hhiissttoorryy__aarrgg__eexxttrraacctt (_i_n_t _f_i_r_s_t_, _i_n_t _l_a_s_t_, _c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g) + Extract a string segment consisting of the _f_i_r_s_t through _l_a_s_t arguments + present in _s_t_r_i_n_g. Arguments are split using hhiissttoorryy__ttookkeenniizzee(()). - History Variables + HHiissttoorryy VVaarriiaabblleess This section describes the externally-visible variables exported by the GNU History Library. - int history_base + _i_n_t hhiissttoorryy__bbaassee The logical offset of the first entry in the history list. - int history_length + _i_n_t hhiissttoorryy__lleennggtthh The number of entries currently stored in the history list. - int history_max_entries - The maximum number of history entries. This must be changed using sti- - fle_history(). + _i_n_t hhiissttoorryy__mmaaxx__eennttrriieess + The maximum number of history entries. This must be changed using ssttii-- + ffllee__hhiissttoorryy(()). - int history_write_timestamps + _i_n_t hhiissttoorryy__wwrriittee__ttiimmeessttaammppss If non-zero, timestamps are written to the history file, so they can be preserved between sessions. The default value is 0, meaning that time- stamps are not saved. The current timestamp format uses the value of - history_comment_char to delimit timestamp entries in the history file. + _h_i_s_t_o_r_y___c_o_m_m_e_n_t___c_h_a_r to delimit timestamp entries in the history file. If that variable does not have a value (the default), timestamps will not be written. - char history_expansion_char - The character that introduces a history event. The default is !. Set- + _c_h_a_r hhiissttoorryy__eexxppaannssiioonn__cchhaarr + The character that introduces a history event. The default is !!. Set- ting this to 0 inhibits history expansion. - char history_subst_char + _c_h_a_r hhiissttoorryy__ssuubbsstt__cchhaarr The character that invokes word substitution if found at the start of a - line. The default is ^. + line. The default is ^^. - char history_comment_char + _c_h_a_r hhiissttoorryy__ccoommmmeenntt__cchhaarr During tokenization, if this character is seen as the first character of a word, then it and all subsequent characters up to a newline are ignored, suppressing history expansion for the remainder of the line. This is disabled by default. - char * history_word_delimiters - The characters that separate tokens for history_tokenize(). The de- - fault value is " \t\n()<>;&|". + _c_h_a_r _* hhiissttoorryy__wwoorrdd__ddeelliimmiitteerrss + The characters that separate tokens for hhiissttoorryy__ttookkeenniizzee(()). The de- + fault value is "" \\tt\\nn(())<<>>;;&&||"". - char * history_no_expand_chars + _c_h_a_r _* hhiissttoorryy__nnoo__eexxppaanndd__cchhaarrss The list of characters which inhibit history expansion if found immedi- - ately following history_expansion_char. The default is space, tab, - newline, \r, and =. + ately following hhiissttoorryy__eexxppaannssiioonn__cchhaarr. The default is space, tab, + newline, \\rr, and ==. - char * history_search_delimiter_chars + _c_h_a_r _* hhiissttoorryy__sseeaarrcchh__ddeelliimmiitteerr__cchhaarrss The list of additional characters which can delimit a history search - string, in addition to space, tab, : and ? in the case of a substring + string, in addition to space, tab, _: and _? in the case of a substring search. The default is empty. - int history_quotes_inhibit_expansion + _i_n_t hhiissttoorryy__qquuootteess__iinnhhiibbiitt__eexxppaannssiioonn If non-zero, double-quoted words are not scanned for the history expan- sion character or the history comment character. The default value is 0. - rl_linebuf_func_t * history_inhibit_expansion_function + _r_l___l_i_n_e_b_u_f___f_u_n_c___t _* hhiissttoorryy__iinnhhiibbiitt__eexxppaannssiioonn__ffuunnccttiioonn This should be set to the address of a function that takes two argu- - ments: a char * (string) and an int index into that string (i). It + ments: a cchhaarr ** (_s_t_r_i_n_g) and an iinntt index into that string (_i). It should return a non-zero value if the history expansion starting at - string[i] should not be performed; zero if the expansion should be - done. It is intended for use by applications like bash that use the + _s_t_r_i_n_g_[_i_] should not be performed; zero if the expansion should be + done. It is intended for use by applications like bbaasshh that use the history expansion character for additional purposes. By default, this - variable is set to NULL. + variable is set to NNUULLLL. -FILES - ~/.history +FFIILLEESS + _~_/_._h_i_s_t_o_r_y Default filename for reading and writing saved history -SEE ALSO - The Gnu Readline Library, Brian Fox and Chet Ramey - The Gnu History Library, Brian Fox and Chet Ramey - bash(1) - readline(3) +SSEEEE AALLSSOO + _T_h_e _G_n_u _R_e_a_d_l_i_n_e _L_i_b_r_a_r_y, Brian Fox and Chet Ramey + _T_h_e _G_n_u _H_i_s_t_o_r_y _L_i_b_r_a_r_y, Brian Fox and Chet Ramey + _b_a_s_h(1) + _r_e_a_d_l_i_n_e(3) -AUTHORS +AAUUTTHHOORRSS Brian Fox, Free Software Foundation bfox@gnu.org Chet Ramey, Case Western Reserve University chet.ramey@case.edu -BUG REPORTS - If you find a bug in the history library, you should report it. But +BBUUGG RREEPPOORRTTSS + If you find a bug in the hhiissttoorryy library, you should report it. But first, you should make sure that it really is a bug, and that it ap- - pears in the latest version of the history library that you have. + pears in the latest version of the hhiissttoorryy library that you have. Once you have determined that a bug actually exists, mail a bug report - to bug-readline@gnu.org. If you have a fix, you are welcome to mail + to _b_u_g_-_r_e_a_d_l_i_n_e@_g_n_u_._o_r_g. If you have a fix, you are welcome to mail that as well! Suggestions and `philosophical' bug reports may be - mailed to bug-readline@gnu.org or posted to the Usenet newsgroup - gnu.bash.bug. + mailed to _b_u_g_-_r_e_a_d_l_i_n_e@_g_n_u_._o_r_g or posted to the Usenet newsgroup + ggnnuu..bbaasshh..bbuugg. Comments and bug reports concerning this manual page should be directed - to chet.ramey@case.edu. + to _c_h_e_t_._r_a_m_e_y_@_c_a_s_e_._e_d_u. -GNU History 8.1 2020 July 17 HISTORY(3) +GNU History 8.3 2023 January 18 HISTORY(3) diff --git a/doc/history.3 b/doc/history.3 index 76e1025..0ecbe1b 100644 --- a/doc/history.3 +++ b/doc/history.3 @@ -6,15 +6,22 @@ .\" Case Western Reserve University .\" chet.ramey@case.edu .\" -.\" Last Change: Thu Dec 14 15:42:44 EST 2023 +.\" Last Change: Fri Jan 19 11:53:57 EST 2024 .\" -.TH HISTORY 3 "2023 December 14" "GNU History 8.3" +.TH HISTORY 3 "2024 January 19" "GNU History 8.3" .\" .\" File Name macro. This used to be `.PN', for Path Name, .\" but Sun doesn't seem to like that very much. .\" .de FN -\fI\|\\$1\|\fP +\%\fI\|\\$1\|\fP +.. +.de Q +.ie \n(.g \(lq\\$1\(rq\\$2 +.el \{ +. if t ``\\$1''\\$2 +. if n "\\$1"\\$2 +.\} .. .ds lp \fR\|(\fP .ds rp \fR\|)\fP @@ -40,8 +47,8 @@ .SH NAME history \- GNU History Library .SH COPYRIGHT -.if t The GNU History Library is Copyright \(co 1989-2023 by the Free Software Foundation, Inc. -.if n The GNU History Library is Copyright (C) 1989-2023 by the Free Software Foundation, Inc. +.if t The GNU History Library is Copyright \(co 1989-2024 by the Free Software Foundation, Inc. +.if n The GNU History Library is Copyright (C) 1989-2024 by the Free Software Foundation, Inc. .SH DESCRIPTION Many programs read input from the user a line at a time. The GNU History library is able to keep track of those lines, associate arbitrary @@ -136,7 +143,7 @@ Quick substitution. Repeat the last command, replacing with .IR string2 . Equivalent to -``!!:s\d\s+2\(ha\s-2\u\fIstring1\fP\d\s+2\(ha\s-2\u\fIstring2\fP\d\s+2\(ha\s-2\u'' +.Q !!:s\d\s+2\(ha\s-2\u\fIstring1\fP\d\s+2\(ha\s-2\u\fIstring2\fP\d\s+2\(ha\s-2\u (see \fBModifiers\fP below). .TP .B !# @@ -638,8 +645,23 @@ string, in addition to space, tab, \fI:\fP and \fI?\fP in the case of a substring search. The default is empty. .Vb int history_quotes_inhibit_expansion -If non-zero, double-quoted words are not scanned for the history expansion -character or the history comment character. The default value is 0. +If non-zero, the history expansion code implements shell-like quoting: +single-quoted words are not scanned for the history expansion +character or the history comment character, and double-quoted words may +have history expansion performed, since single quotes are not special +within double quotes. +The default value is 0. + +.Vb int history_quoting_state +An application may set this variable to indicate that the current line +being expanded is subject to existing quoting. If set to \fI\(aq\fP, the +history expansion function will assume that the line is single-quoted and +inhibit expansion until it reads an unquoted closing single quote; if set +to \fI\(dq\fP, history expansion will assume the line is double quoted until +it reads an unquoted closing double quote. If set to zero, the default, +the history expansion function will assume the line is not quoted and +treat quote characters within the line as described above. +This is only effective if \fBhistory_quotes_inhibit_expansion\fP is set. .Vb "rl_linebuf_func_t *" history_inhibit_expansion_function This should be set to the address of a function that takes two arguments: diff --git a/doc/hsuser.texi b/doc/hsuser.texi index dab64a0..4c5dc84 100644 --- a/doc/hsuser.texi +++ b/doc/hsuser.texi @@ -193,7 +193,7 @@ With no options, display the history list with line numbers. Lines prefixed with a @samp{*} have been modified. An argument of @var{n} lists only the last @var{n} lines. If the shell variable @env{HISTTIMEFORMAT} is set and not null, -it is used as a format string for @var{strftime} to display +it is used as a format string for @code{strftime}(3) to display the time stamp associated with each displayed history entry. No intervening blank is printed between the formatted time stamp and the history line. diff --git a/doc/readline.0 b/doc/readline.0 index b7c45a7..3998a82 100644 --- a/doc/readline.0 +++ b/doc/readline.0 @@ -2,74 +2,77 @@ READLINE(3) Library Functions Manual READLINE(3) -NAME +NNAAMMEE readline - get a line from a user with editing -SYNOPSIS - #include  - #include  - #include  +SSYYNNOOPPSSIISS + ##iinncclluuddee <> + ##iinncclluuddee <> + ##iinncclluuddee <> - char * - readline (const char *prompt); + _c_h_a_r _* + rreeaaddlliinnee (_c_o_n_s_t _c_h_a_r _*_p_r_o_m_p_t); -COPYRIGHT - Readline is Copyright (C) 1989-2020 Free Software Foundation, Inc. +CCOOPPYYRRIIGGHHTT + Readline is Copyright (C) 1989-2024 Free Software Foundation, Inc. -DESCRIPTION - readline will read a line from the terminal and return it, using prompt - as a prompt. If prompt is NULL or the empty string, no prompt is is- - sued. The line returned is allocated with malloc(3); the caller must +DDEESSCCRRIIPPTTIIOONN + rreeaaddlliinnee will read a line from the terminal and return it, using pprroommpptt + as a prompt. If pprroommpptt is NNUULLLL or the empty string, no prompt is is- + sued. The line returned is allocated with _m_a_l_l_o_c(3); the caller must free it when finished. The line returned has the final newline re- - moved, so only the text of the line remains. + moved, so only the text of the line remains. Since it's possible to + enter characters into the line while quoting them to disable any rreeaadd-- + lliinnee editing function they might normally have, this line may include + embedded newlines and other special characters. - readline offers editing capabilities while the user is entering the - line. By default, the line editing commands are similar to those of + rreeaaddlliinnee offers editing capabilities while the user is entering the + line. By default, the line editing commands are similar to those of emacs. A vi-style line editing interface is also available. - This manual page describes only the most basic use of readline. Much - more functionality is available; see The GNU Readline Library and The - GNU History Library for additional information. + This manual page describes only the most basic use of rreeaaddlliinnee. Much + more functionality is available; see _T_h_e _G_N_U _R_e_a_d_l_i_n_e _L_i_b_r_a_r_y and _T_h_e + _G_N_U _H_i_s_t_o_r_y _L_i_b_r_a_r_y for additional information. -RETURN VALUE - readline returns the text of the line read. A blank line returns the - empty string. If EOF is encountered while reading a line, and the line - is empty, NULL is returned. If an EOF is read with a non-empty line, +RREETTUURRNN VVAALLUUEE + rreeaaddlliinnee returns the text of the line read. A blank line returns the + empty string. If EEOOFF is encountered while reading a line, and the line + is empty, NNUULLLL is returned. If an EEOOFF is read with a non-empty line, it is treated as a newline. -NOTATION +NNOOTTAATTIIOONN An Emacs-style notation is used to denote keystrokes. Control keys are - denoted by C-key, e.g., C-n means Control-N. Similarly, meta keys are - denoted by M-key, so M-x means Meta-X. (On keyboards without a meta - key, M-x means ESC x, i.e., press the Escape key then the x key. This - makes ESC the meta prefix. The combination M-C-x means ESC-Control-x, - or press the Escape key then hold the Control key while pressing the x + denoted by C-_k_e_y, e.g., C-n means Control-N. Similarly, _m_e_t_a keys are + denoted by M-_k_e_y, so M-x means Meta-X. (On keyboards without a _m_e_t_a + key, M-_x means ESC _x, i.e., press the Escape key then the _x key. This + makes ESC the _m_e_t_a _p_r_e_f_i_x. The combination M-C-_x means ESC-Control-_x, + or press the Escape key then hold the Control key while pressing the _x key.) - Readline commands may be given numeric arguments, which normally act as - a repeat count. Sometimes, however, it is the sign of the argument - that is significant. Passing a negative argument to a command that - acts in the forward direction (e.g., kill-line) causes that command to - act in a backward direction. Commands whose behavior with arguments + Readline commands may be given numeric _a_r_g_u_m_e_n_t_s, which normally act as + a repeat count. Sometimes, however, it is the sign of the argument + that is significant. Passing a negative argument to a command that + acts in the forward direction (e.g., kkiillll--lliinnee) causes that command to + act in a backward direction. Commands whose behavior with arguments deviates from this are noted below. - When a command is described as killing text, the text deleted is saved - for possible future retrieval (yanking). The killed text is saved in a - kill ring. Consecutive kills cause the text to be accumulated into one + When a command is described as _k_i_l_l_i_n_g text, the text deleted is saved + for possible future retrieval (_y_a_n_k_i_n_g). The killed text is saved in a + _k_i_l_l _r_i_n_g. Consecutive kills cause the text to be accumulated into one unit, which can be yanked all at once. Commands which do not kill text separate the chunks of text on the kill ring. -INITIALIZATION FILE - Readline is customized by putting commands in an initialization file - (the inputrc file). The name of this file is taken from the value of - the INPUTRC environment variable. If that variable is unset, the de- - fault is ~/.inputrc. If that file does not exist or cannot be read, - the ultimate default is /etc/inputrc. When a program which uses the +IINNIITTIIAALLIIZZAATTIIOONN FFIILLEE + Readline is customized by putting commands in an initialization file + (the _i_n_p_u_t_r_c file). The name of this file is taken from the value of + the IINNPPUUTTRRCC environment variable. If that variable is unset, the de- + fault is _~_/_._i_n_p_u_t_r_c. If that file does not exist or cannot be read, + the ultimate default is _/_e_t_c_/_i_n_p_u_t_r_c. When a program which uses the readline library starts up, the init file is read, and the key bindings - and variables are set. There are only a few basic constructs allowed - in the readline init file. Blank lines are ignored. Lines beginning - with a # are comments. Lines beginning with a $ indicate conditional - constructs. Other lines denote key bindings and variable settings. + and variables are set. There are only a few basic constructs allowed + in the readline init file. Blank lines are ignored. Lines beginning + with a ## are comments. Lines beginning with a $$ indicate conditional + constructs. Other lines denote key bindings and variable settings. Each program using this library may add its own commands and bindings. For example, placing @@ -78,203 +81,206 @@ READLINE(3) Library Functions Manual READLINE(3) or C-Meta-u: universal-argument - into the inputrc would make M-C-u execute the readline command univer- - sal-argument. + into the _i_n_p_u_t_r_c would make M-C-u execute the readline command _u_n_i_v_e_r_- + _s_a_l_-_a_r_g_u_m_e_n_t. - The following symbolic character names are recognized while processing - key bindings: DEL, ESC, ESCAPE, LFD, NEWLINE, RET, RETURN, RUBOUT, - SPACE, SPC, and TAB. + The following symbolic character names are recognized while processing + key bindings: _D_E_L, _E_S_C, _E_S_C_A_P_E, _L_F_D, _N_E_W_L_I_N_E, _R_E_T, _R_E_T_U_R_N, _R_U_B_O_U_T, + _S_P_A_C_E, _S_P_C, and _T_A_B. - In addition to command names, readline allows keys to be bound to a - string that is inserted when the key is pressed (a macro). + In addition to command names, readline allows keys to be bound to a + string that is inserted when the key is pressed (a _m_a_c_r_o). - Key Bindings - The syntax for controlling key bindings in the inputrc file is simple. - All that is required is the name of the command or the text of a macro + KKeeyy BBiinnddiinnggss + The syntax for controlling key bindings in the _i_n_p_u_t_r_c file is simple. + All that is required is the name of the command or the text of a macro and a key sequence to which it should be bound. The name may be speci- - fied in one of two ways: as a symbolic key name, possibly with Meta- or - Control- prefixes, or as a key sequence. The name and key sequence are - separated by a colon. There can be no whitespace between the name and + fied in one of two ways: as a symbolic key name, possibly with _M_e_t_a_- or + _C_o_n_t_r_o_l_- prefixes, or as a key sequence. The name and key sequence are + separated by a colon. There can be no whitespace between the name and the colon. - When using the form keyname:function-name or macro, keyname is the name + When using the form kkeeyynnaammee:_f_u_n_c_t_i_o_n_-_n_a_m_e or _m_a_c_r_o, _k_e_y_n_a_m_e is the name of a key spelled out in English. For example: Control-u: universal-argument Meta-Rubout: backward-kill-word Control-o: "> output" - In the above example, C-u is bound to the function universal-argument, - M-DEL is bound to the function backward-kill-word, and C-o is bound to - run the macro expressed on the right hand side (that is, to insert the - text ``> output'' into the line). + In the above example, _C_-_u is bound to the function uunniivveerrssaall--aarrgguummeenntt, + _M_-_D_E_L is bound to the function bbaacckkwwaarrdd--kkiillll--wwoorrdd, and _C_-_o is bound to + run the macro expressed on the right hand side (that is, to insert the + text "> output" into the line). - In the second form, "keyseq":function-name or macro, keyseq differs - from keyname above in that strings denoting an entire key sequence may - be specified by placing the sequence within double quotes. Some GNU - Emacs style key escapes can be used, as in the following example, but + In the second form, ""kkeeyysseeqq"":_f_u_n_c_t_i_o_n_-_n_a_m_e or _m_a_c_r_o, kkeeyysseeqq differs + from kkeeyynnaammee above in that strings denoting an entire key sequence may + be specified by placing the sequence within double quotes. Some GNU + Emacs style key escapes can be used, as in the following example, but the symbolic character names are not recognized. "\C-u": universal-argument "\C-x\C-r": re-read-init-file "\e[11~": "Function Key 1" - In this example, C-u is again bound to the function universal-argument. - C-x C-r is bound to the function re-read-init-file, and ESC [ 1 1 ~ is - bound to insert the text ``Function Key 1''. + In this example, _C_-_u is again bound to the function uunniivveerrssaall--aarrgguummeenntt. + _C_-_x _C_-_r is bound to the function rree--rreeaadd--iinniitt--ffiillee, and _E_S_C _[ _1 _1 _~ is + bound to insert the text "Function Key 1". - The full set of GNU Emacs style escape sequences available when speci- + The full set of GNU Emacs style escape sequences available when speci- fying key sequences is - \C- control prefix - \M- meta prefix - \e an escape character - \\ backslash - \" literal ", a double quote - \' literal ', a single quote - - In addition to the GNU Emacs style escape sequences, a second set of + \\CC-- control prefix + \\MM-- meta prefix + \\ee an escape character + \\\\ backslash + \\"" literal ", a double quote + \\'' literal ', a single quote + + In addition to the GNU Emacs style escape sequences, a second set of backslash escapes is available: - \a alert (bell) - \b backspace - \d delete - \f form feed - \n newline - \r carriage return - \t horizontal tab - \v vertical tab - \nnn the eight-bit character whose value is the octal value - nnn (one to three digits) - \xHH the eight-bit character whose value is the hexadecimal - value HH (one or two hex digits) - - When entering the text of a macro, single or double quotes should be - used to indicate a macro definition. Unquoted text is assumed to be a - function name. In the macro body, the backslash escapes described - above are expanded. Backslash will quote any other character in the + \\aa alert (bell) + \\bb backspace + \\dd delete + \\ff form feed + \\nn newline + \\rr carriage return + \\tt horizontal tab + \\vv vertical tab + \\_n_n_n the eight-bit character whose value is the octal value + _n_n_n (one to three digits) + \\xx_H_H the eight-bit character whose value is the hexadecimal + value _H_H (one or two hex digits) + + When entering the text of a macro, single or double quotes should be + used to indicate a macro definition. Unquoted text is assumed to be a + function name. In the macro body, the backslash escapes described + above are expanded. Backslash will quote any other character in the macro text, including " and '. - Bash allows the current readline key bindings to be displayed or modi- - fied with the bind builtin command. The editing mode may be switched - during interactive use by using the -o option to the set builtin com- - mand. Other programs using this library provide similar mechanisms. - The inputrc file may be edited and re-read if a program does not pro- + BBaasshh allows the current readline key bindings to be displayed or modi- + fied with the bbiinndd builtin command. The editing mode may be switched + during interactive use by using the --oo option to the sseett builtin com- + mand. Other programs using this library provide similar mechanisms. + The _i_n_p_u_t_r_c file may be edited and re-read if a program does not pro- vide any other means to incorporate new bindings. - Variables + VVaarriiaabblleess Readline has variables that can be used to further customize its behav- - ior. A variable may be set in the inputrc file with a statement of the + ior. A variable may be set in the _i_n_p_u_t_r_c file with a statement of the form - set variable-name value + sseett _v_a_r_i_a_b_l_e_-_n_a_m_e _v_a_l_u_e - Except where noted, readline variables can take the values On or Off - (without regard to case). Unrecognized variable names are ignored. - When a variable value is read, empty or null values, "on" (case-insen- - sitive), and "1" are equivalent to On. All other values are equivalent - to Off. The variables and their default values are: + Except where noted, readline variables can take the values OOnn or OOffff + (without regard to case). Unrecognized variable names are ignored. + When a variable value is read, empty or null values, "on" (case-insen- + sitive), and "1" are equivalent to OOnn. All other values are equivalent + to OOffff. The variables and their default values are: - active-region-start-color - A string variable that controls the text color and background - when displaying the text in the active region (see the descrip- - tion of enable-active-region below). This string must not take + aaccttiivvee--rreeggiioonn--ssttaarrtt--ccoolloorr + A string variable that controls the text color and background + when displaying the text in the active region (see the descrip- + tion of eennaabbllee--aaccttiivvee--rreeggiioonn below). This string must not take up any physical character positions on the display, so it should - consist only of terminal escape sequences. It is output to the - terminal before displaying the text in the active region. This - variable is reset to the default value whenever the terminal - type changes. The default value is the string that puts the - terminal in standout mode, as obtained from the terminal's ter- + consist only of terminal escape sequences. It is output to the + terminal before displaying the text in the active region. This + variable is reset to the default value whenever the terminal + type changes. The default value is the string that puts the + terminal in standout mode, as obtained from the terminal's ter- minfo description. A sample value might be "\e[01;33m". - active-region-end-color - A string variable that "undoes" the effects of active-re- - gion-start-color and restores "normal" terminal display appear- - ance after displaying text in the active region. This string - must not take up any physical character positions on the dis- - play, so it should consist only of terminal escape sequences. - It is output to the terminal after displaying the text in the - active region. This variable is reset to the default value - whenever the terminal type changes. The default value is the - string that restores the terminal from standout mode, as ob- + aaccttiivvee--rreeggiioonn--eenndd--ccoolloorr + A string variable that "undoes" the effects of aaccttiivvee--rree-- + ggiioonn--ssttaarrtt--ccoolloorr and restores "normal" terminal display appear- + ance after displaying text in the active region. This string + must not take up any physical character positions on the dis- + play, so it should consist only of terminal escape sequences. + It is output to the terminal after displaying the text in the + active region. This variable is reset to the default value + whenever the terminal type changes. The default value is the + string that restores the terminal from standout mode, as ob- tained from the terminal's terminfo description. A sample value might be "\e[0m". - bell-style (audible) - Controls what happens when readline wants to ring the terminal - bell. If set to none, readline never rings the bell. If set to - visible, readline uses a visible bell if one is available. If - set to audible, readline attempts to ring the terminal's bell. - bind-tty-special-chars (On) - If set to On (the default), readline attempts to bind the con- - trol characters treated specially by the kernel's terminal - driver to their readline equivalents. - blink-matching-paren (Off) - If set to On, readline attempts to briefly move the cursor to an + bbeellll--ssttyyllee ((aauuddiibbllee)) + Controls what happens when readline wants to ring the terminal + bell. If set to nnoonnee, readline never rings the bell. If set to + vviissiibbllee, readline uses a visible bell if one is available. If + set to aauuddiibbllee, readline attempts to ring the terminal's bell. + bbiinndd--ttttyy--ssppeecciiaall--cchhaarrss ((OOnn)) + If set to OOnn (the default), readline attempts to bind the con- + trol characters that are treated specially by the kernel's ter- + minal driver to their readline equivalents. These override the + default readline bindings described here. Type "stty -a" at a + bbaasshh prompt to see your current terminal settings, including the + special control characters (usually cccchhaarrss). + bblliinnkk--mmaattcchhiinngg--ppaarreenn ((OOffff)) + If set to OOnn, readline attempts to briefly move the cursor to an opening parenthesis when a closing parenthesis is inserted. - colored-completion-prefix (Off) - If set to On, when listing completions, readline displays the + ccoolloorreedd--ccoommpplleettiioonn--pprreeffiixx ((OOffff)) + If set to OOnn, when listing completions, readline displays the common prefix of the set of possible completions using a differ- ent color. The color definitions are taken from the value of - the LS_COLORS environment variable. If there is a color defini- - tion in $LS_COLORS for the custom suffix "readline-colored-com- + the LLSS__CCOOLLOORRSS environment variable. If there is a color defini- + tion in $$LLSS__CCOOLLOORRSS for the custom suffix "readline-colored-com- pletion-prefix", readline uses this color for the common prefix instead of its default. - colored-stats (Off) - If set to On, readline displays possible completions using dif- + ccoolloorreedd--ssttaattss ((OOffff)) + If set to OOnn, readline displays possible completions using dif- ferent colors to indicate their file type. The color defini- - tions are taken from the value of the LS_COLORS environment + tions are taken from the value of the LLSS__CCOOLLOORRSS environment variable. - comment-begin (``#'') - The string that is inserted in vi mode when the insert-comment - command is executed. This command is bound to M-# in emacs mode - and to # in vi command mode. - completion-display-width (-1) + ccoommmmeenntt--bbeeggiinn ((````##'''')) + The string that is inserted in vvii mode when the iinnsseerrtt--ccoommmmeenntt + command is executed. This command is bound to MM--## in emacs mode + and to ## in vi command mode. + ccoommpplleettiioonn--ddiissppllaayy--wwiiddtthh ((--11)) The number of screen columns used to display possible matches when performing completion. The value is ignored if it is less than 0 or greater than the terminal screen width. A value of 0 will cause matches to be displayed one per line. The default value is -1. - completion-ignore-case (Off) - If set to On, readline performs filename matching and completion + ccoommpplleettiioonn--iiggnnoorree--ccaassee ((OOffff)) + If set to OOnn, readline performs filename matching and completion in a case-insensitive fashion. - completion-map-case (Off) - If set to On, and completion-ignore-case is enabled, readline - treats hyphens (-) and underscores (_) as equivalent when per- + ccoommpplleettiioonn--mmaapp--ccaassee ((OOffff)) + If set to OOnn, and ccoommpplleettiioonn--iiggnnoorree--ccaassee is enabled, readline + treats hyphens (_-) and underscores (__) as equivalent when per- forming case-insensitive filename matching and completion. - completion-prefix-display-length (0) + ccoommpplleettiioonn--pprreeffiixx--ddiissppllaayy--lleennggtthh ((00)) The length in characters of the common prefix of a list of pos- sible completions that is displayed without modification. When set to a value greater than zero, common prefixes longer than this value are replaced with an ellipsis when displaying possi- ble completions. - completion-query-items (100) + ccoommpplleettiioonn--qquueerryy--iitteemmss ((110000)) This determines when the user is queried about viewing the num- - ber of possible completions generated by the possible-comple- - tions command. It may be set to any integer value greater than + ber of possible completions generated by the ppoossssiibbllee--ccoommppllee-- + ttiioonnss command. It may be set to any integer value greater than or equal to zero. If the number of possible completions is greater than or equal to the value of this variable, readline will ask whether or not the user wishes to view them; otherwise they are simply listed on the terminal. A negative value causes readline to never ask. - convert-meta (On) - If set to On, readline will convert characters with the eighth + ccoonnvveerrtt--mmeettaa ((OOnn)) + If set to OOnn, readline will convert characters with the eighth bit set to an ASCII key sequence by stripping the eighth bit and prefixing it with an escape character (in effect, using escape - as the meta prefix). The default is On, but readline will set - it to Off if the locale contains eight-bit characters. This - variable is dependent on the LC_CTYPE locale category, and may + as the _m_e_t_a _p_r_e_f_i_x). The default is _O_n, but readline will set + it to _O_f_f if the locale contains eight-bit characters. This + variable is dependent on the LLCC__CCTTYYPPEE locale category, and may change if the locale is changed. - disable-completion (Off) - If set to On, readline will inhibit word completion. Completion + ddiissaabbllee--ccoommpplleettiioonn ((OOffff)) + If set to OOnn, readline will inhibit word completion. Completion characters will be inserted into the line as if they had been - mapped to self-insert. - echo-control-characters (On) - When set to On, on operating systems that indicate they support + mapped to sseellff--iinnsseerrtt. + eecchhoo--ccoonnttrrooll--cchhaarraacctteerrss ((OOnn)) + When set to OOnn, on operating systems that indicate they support it, readline echoes a character corresponding to a signal gener- ated from the keyboard. - editing-mode (emacs) + eeddiittiinngg--mmooddee ((eemmaaccss)) Controls whether readline begins with a set of key bindings sim- - ilar to Emacs or vi. editing-mode can be set to either emacs or - vi. - emacs-mode-string (@) - If the show-mode-in-prompt variable is enabled, this string is + ilar to _E_m_a_c_s or _v_i. eeddiittiinngg--mmooddee can be set to either eemmaaccss or + vvii. + eemmaaccss--mmooddee--ssttrriinngg ((@@)) + If the _s_h_o_w_-_m_o_d_e_-_i_n_-_p_r_o_m_p_t variable is enabled, this string is displayed immediately before the last line of the primary prompt when emacs editing mode is active. The value is expanded like a key binding, so the standard set of meta- and control prefixes @@ -282,667 +288,670 @@ READLINE(3) Library Functions Manual READLINE(3) escapes to begin and end sequences of non-printing characters, which can be used to embed a terminal control sequence into the mode string. - enable-active-region (On) - The point is the current cursor position, and mark refers to a + eennaabbllee--aaccttiivvee--rreeggiioonn ((OOnn)) + The _p_o_i_n_t is the current cursor position, and _m_a_r_k refers to a saved cursor position. The text between the point and mark is - referred to as the region. When this variable is set to On, - readline allows certain commands to designate the region as ac- - tive. When the region is active, readline highlights the text - in the region using the value of the active-region-start-color, + referred to as the _r_e_g_i_o_n. When this variable is set to _O_n, + readline allows certain commands to designate the region as _a_c_- + _t_i_v_e. When the region is active, readline highlights the text + in the region using the value of the aaccttiivvee--rreeggiioonn--ssttaarrtt--ccoolloorr, which defaults to the string that enables the terminal's stand- out mode. The active region shows the text inserted by brack- eted-paste and any matching text found by incremental and non- incremental history searches. - enable-bracketed-paste (On) - When set to On, readline configures the terminal to insert each + eennaabbllee--bbrraacckkeetteedd--ppaassttee ((OOnn)) + When set to OOnn, readline configures the terminal to insert each paste into the editing buffer as a single string of characters, instead of treating each character as if it had been read from the keyboard. This prevents readline from executing any editing commands bound to key sequences appearing in the pasted text. - enable-keypad (Off) - When set to On, readline will try to enable the application key- + eennaabbllee--kkeeyyppaadd ((OOffff)) + When set to OOnn, readline will try to enable the application key- pad when it is called. Some systems need this to enable the ar- row keys. - enable-meta-key (On) - When set to On, readline will try to enable any meta modifier + eennaabbllee--mmeettaa--kkeeyy ((OOnn)) + When set to OOnn, readline will try to enable any meta modifier key the terminal claims to support when it is called. On many terminals, the meta key is used to send eight-bit characters. - expand-tilde (Off) - If set to On, tilde expansion is performed when readline at- + eexxppaanndd--ttiillddee ((OOffff)) + If set to OOnn, tilde expansion is performed when readline at- tempts word completion. - history-preserve-point (Off) - If set to On, the history code attempts to place point at the - same location on each history line retrieved with previous-his- - tory or next-history. - history-size (unset) + hhiissttoorryy--pprreesseerrvvee--ppooiinntt ((OOffff)) + If set to OOnn, the history code attempts to place point at the + same location on each history line retrieved with pprreevviioouuss--hhiiss-- + ttoorryy or nneexxtt--hhiissttoorryy. + hhiissttoorryy--ssiizzee ((uunnsseett)) Set the maximum number of history entries saved in the history list. If set to zero, any existing history entries are deleted and no new entries are saved. If set to a value less than zero, the number of history entries is not limited. By default, the number of history entries is not limited. If an attempt is made - to set history-size to a non-numeric value, the maximum number + to set _h_i_s_t_o_r_y_-_s_i_z_e to a non-numeric value, the maximum number of history entries will be set to 500. - horizontal-scroll-mode (Off) - When set to On, makes readline use a single line for display, + hhoorriizzoonnttaall--ssccrroollll--mmooddee ((OOffff)) + When set to OOnn, makes readline use a single line for display, scrolling the input horizontally on a single screen line when it becomes longer than the screen width rather than wrapping to a new line. This setting is automatically enabled for terminals of height 1. - input-meta (Off) - If set to On, readline will enable eight-bit input (that is, it + iinnppuutt--mmeettaa ((OOffff)) + If set to OOnn, readline will enable eight-bit input (that is, it will not clear the eighth bit in the characters it reads), re- gardless of what the terminal claims it can support. The name - meta-flag is a synonym for this variable. The default is Off, - but readline will set it to On if the locale contains eight-bit - characters. This variable is dependent on the LC_CTYPE locale + mmeettaa--ffllaagg is a synonym for this variable. The default is _O_f_f, + but readline will set it to _O_n if the locale contains eight-bit + characters. This variable is dependent on the LLCC__CCTTYYPPEE locale category, and may change if the locale is changed. - isearch-terminators (``C-[ C-J'') + iisseeaarrcchh--tteerrmmiinnaattoorrss ((````CC--[[ CC--JJ'''')) The string of characters that should terminate an incremental search without subsequently executing the character as a com- mand. If this variable has not been given a value, the charac- - ters ESC and C-J will terminate an incremental search. - keymap (emacs) + ters _E_S_C and _C_-_J will terminate an incremental search. + kkeeyymmaapp ((eemmaaccss)) Set the current readline keymap. The set of legal keymap names - is emacs, emacs-standard, emacs-meta, emacs-ctlx, vi, vi-move, - vi-command, and vi-insert. vi is equivalent to vi-command; - emacs is equivalent to emacs-standard. The default value is - emacs. The value of editing-mode also affects the default + is _e_m_a_c_s_, _e_m_a_c_s_-_s_t_a_n_d_a_r_d_, _e_m_a_c_s_-_m_e_t_a_, _e_m_a_c_s_-_c_t_l_x_, _v_i_, _v_i_-_m_o_v_e_, + _v_i_-_c_o_m_m_a_n_d, and _v_i_-_i_n_s_e_r_t. _v_i is equivalent to _v_i_-_c_o_m_m_a_n_d; + _e_m_a_c_s is equivalent to _e_m_a_c_s_-_s_t_a_n_d_a_r_d. The default value is + _e_m_a_c_s. The value of eeddiittiinngg--mmooddee also affects the default keymap. - keyseq-timeout (500) - Specifies the duration readline will wait for a character when + kkeeyysseeqq--ttiimmeeoouutt ((550000)) + Specifies the duration _r_e_a_d_l_i_n_e will wait for a character when reading an ambiguous key sequence (one that can form a complete key sequence using the input read so far, or can take additional input to complete a longer key sequence). If no input is re- - ceived within the timeout, readline will use the shorter but + ceived within the timeout, _r_e_a_d_l_i_n_e will use the shorter but complete key sequence. The value is specified in milliseconds, - so a value of 1000 means that readline will wait one second for + so a value of 1000 means that _r_e_a_d_l_i_n_e will wait one second for additional input. If this variable is set to a value less than - or equal to zero, or to a non-numeric value, readline will wait + or equal to zero, or to a non-numeric value, _r_e_a_d_l_i_n_e will wait until another key is pressed to decide which key sequence to complete. - mark-directories (On) - If set to On, completed directory names have a slash appended. - mark-modified-lines (Off) - If set to On, history lines that have been modified are dis- - played with a preceding asterisk (*). - mark-symlinked-directories (Off) - If set to On, completed names which are symbolic links to direc- - tories have a slash appended (subject to the value of mark-di- - rectories). - match-hidden-files (On) - This variable, when set to On, causes readline to match files + mmaarrkk--ddiirreeccttoorriieess ((OOnn)) + If set to OOnn, completed directory names have a slash appended. + mmaarrkk--mmooddiiffiieedd--lliinneess ((OOffff)) + If set to OOnn, history lines that have been modified are dis- + played with a preceding asterisk (**). + mmaarrkk--ssyymmlliinnkkeedd--ddiirreeccttoorriieess ((OOffff)) + If set to OOnn, completed names which are symbolic links to direc- + tories have a slash appended (subject to the value of mmaarrkk--ddii-- + rreeccttoorriieess). + mmaattcchh--hhiiddddeenn--ffiilleess ((OOnn)) + This variable, when set to OOnn, causes readline to match files whose names begin with a `.' (hidden files) when performing - filename completion. If set to Off, the leading `.' must be + filename completion. If set to OOffff, the leading `.' must be supplied by the user in the filename to be completed. - menu-complete-display-prefix (Off) - If set to On, menu completion displays the common prefix of the + mmeennuu--ccoommpplleettee--ddiissppllaayy--pprreeffiixx ((OOffff)) + If set to OOnn, menu completion displays the common prefix of the list of possible completions (which may be empty) before cycling through the list. - output-meta (Off) - If set to On, readline will display characters with the eighth + oouuttppuutt--mmeettaa ((OOffff)) + If set to OOnn, readline will display characters with the eighth bit set directly rather than as a meta-prefixed escape sequence. - The default is Off, but readline will set it to On if the locale + The default is _O_f_f, but readline will set it to _O_n if the locale contains eight-bit characters. This variable is dependent on - the LC_CTYPE locale category, and may change if the locale is + the LLCC__CCTTYYPPEE locale category, and may change if the locale is changed. - page-completions (On) - If set to On, readline uses an internal more-like pager to dis- + ppaaggee--ccoommpplleettiioonnss ((OOnn)) + If set to OOnn, readline uses an internal _m_o_r_e-like pager to dis- play a screenful of possible completions at a time. - print-completions-horizontally (Off) - If set to On, readline will display completions with matches + pprriinntt--ccoommpplleettiioonnss--hhoorriizzoonnttaallllyy ((OOffff)) + If set to OOnn, readline will display completions with matches sorted horizontally in alphabetical order, rather than down the screen. - revert-all-at-newline (Off) - If set to On, readline will undo all changes to history lines - before returning when accept-line is executed. By default, his- + rreevveerrtt--aallll--aatt--nneewwlliinnee ((OOffff)) + If set to OOnn, readline will undo all changes to history lines + before returning when aacccceepptt--lliinnee is executed. By default, his- tory lines may be modified and retain individual undo lists - across calls to readline. - show-all-if-ambiguous (Off) - This alters the default behavior of the completion functions. - If set to On, words which have more than one possible completion - cause the matches to be listed immediately instead of ringing + across calls to rreeaaddlliinnee. + sseeaarrcchh--iiggnnoorree--ccaassee ((OOffff)) + If set to OOnn, readline performs incremental and non-incremental + history list searches in a case-insensitive fashion. + sshhooww--aallll--iiff--aammbbiigguuoouuss ((OOffff)) + This alters the default behavior of the completion functions. + If set to OOnn, words which have more than one possible completion + cause the matches to be listed immediately instead of ringing the bell. - show-all-if-unmodified (Off) - This alters the default behavior of the completion functions in - a fashion similar to show-all-if-ambiguous. If set to On, words - which have more than one possible completion without any possi- - ble partial completion (the possible completions don't share a - common prefix) cause the matches to be listed immediately in- + sshhooww--aallll--iiff--uunnmmooddiiffiieedd ((OOffff)) + This alters the default behavior of the completion functions in + a fashion similar to sshhooww--aallll--iiff--aammbbiigguuoouuss. If set to OOnn, words + which have more than one possible completion without any possi- + ble partial completion (the possible completions don't share a + common prefix) cause the matches to be listed immediately in- stead of ringing the bell. - show-mode-in-prompt (Off) - If set to On, add a string to the beginning of the prompt indi- - cating the editing mode: emacs, vi command, or vi insertion. - The mode strings are user-settable (e.g., emacs-mode-string). - skip-completed-text (Off) - If set to On, this alters the default completion behavior when - inserting a single match into the line. It's only active when - performing completion in the middle of a word. If enabled, - readline does not insert characters from the completion that - match characters after point in the word being completed, so + sshhooww--mmooddee--iinn--pprroommpptt ((OOffff)) + If set to OOnn, add a string to the beginning of the prompt indi- + cating the editing mode: emacs, vi command, or vi insertion. + The mode strings are user-settable (e.g., _e_m_a_c_s_-_m_o_d_e_-_s_t_r_i_n_g). + sskkiipp--ccoommpplleetteedd--tteexxtt ((OOffff)) + If set to OOnn, this alters the default completion behavior when + inserting a single match into the line. It's only active when + performing completion in the middle of a word. If enabled, + readline does not insert characters from the completion that + match characters after point in the word being completed, so portions of the word following the cursor are not duplicated. - vi-cmd-mode-string ((cmd)) - If the show-mode-in-prompt variable is enabled, this string is + vvii--ccmmdd--mmooddee--ssttrriinngg ((((ccmmdd)))) + If the _s_h_o_w_-_m_o_d_e_-_i_n_-_p_r_o_m_p_t variable is enabled, this string is displayed immediately before the last line of the primary prompt - when vi editing mode is active and in command mode. The value + when vi editing mode is active and in command mode. The value is expanded like a key binding, so the standard set of meta- and - control prefixes and backslash escape sequences is available. - Use the \1 and \2 escapes to begin and end sequences of non- - printing characters, which can be used to embed a terminal con- + control prefixes and backslash escape sequences is available. + Use the \1 and \2 escapes to begin and end sequences of non- + printing characters, which can be used to embed a terminal con- trol sequence into the mode string. - vi-ins-mode-string ((ins)) - If the show-mode-in-prompt variable is enabled, this string is + vvii--iinnss--mmooddee--ssttrriinngg ((((iinnss)))) + If the _s_h_o_w_-_m_o_d_e_-_i_n_-_p_r_o_m_p_t variable is enabled, this string is displayed immediately before the last line of the primary prompt when vi editing mode is active and in insertion mode. The value is expanded like a key binding, so the standard set of meta- and - control prefixes and backslash escape sequences is available. - Use the \1 and \2 escapes to begin and end sequences of non- - printing characters, which can be used to embed a terminal con- + control prefixes and backslash escape sequences is available. + Use the \1 and \2 escapes to begin and end sequences of non- + printing characters, which can be used to embed a terminal con- trol sequence into the mode string. - visible-stats (Off) - If set to On, a character denoting a file's type as reported by - stat(2) is appended to the filename when listing possible com- + vviissiibbllee--ssttaattss ((OOffff)) + If set to OOnn, a character denoting a file's type as reported by + _s_t_a_t(2) is appended to the filename when listing possible com- pletions. - Conditional Constructs - Readline implements a facility similar in spirit to the conditional - compilation features of the C preprocessor which allows key bindings - and variable settings to be performed as the result of tests. There + CCoonnddiittiioonnaall CCoonnssttrruuccttss + Readline implements a facility similar in spirit to the conditional + compilation features of the C preprocessor which allows key bindings + and variable settings to be performed as the result of tests. There are four parser directives used. - $if The $if construct allows bindings to be made based on the edit- - ing mode, the terminal being used, or the application using - readline. The text of the test, after any comparison operator, + $$iiff The $$iiff construct allows bindings to be made based on the edit- + ing mode, the terminal being used, or the application using + readline. The text of the test, after any comparison operator, extends to the end of the line; unless otherwise noted, no char- acters are required to isolate it. - mode The mode= form of the $if directive is used to test - whether readline is in emacs or vi mode. This may be - used in conjunction with the set keymap command, for in- - stance, to set bindings in the emacs-standard and emacs- - ctlx keymaps only if readline is starting out in emacs + mmooddee The mmooddee== form of the $$iiff directive is used to test + whether readline is in emacs or vi mode. This may be + used in conjunction with the sseett kkeeyymmaapp command, for in- + stance, to set bindings in the _e_m_a_c_s_-_s_t_a_n_d_a_r_d and _e_m_a_c_s_- + _c_t_l_x keymaps only if readline is starting out in emacs mode. - term The term= form may be used to include terminal-specific + tteerrmm The tteerrmm== form may be used to include terminal-specific key bindings, perhaps to bind the key sequences output by the terminal's function keys. The word on the right side - of the = is tested against the full name of the terminal - and the portion of the terminal name before the first -. - This allows sun to match both sun and sun-cmd, for in- + of the == is tested against the full name of the terminal + and the portion of the terminal name before the first --. + This allows _s_u_n to match both _s_u_n and _s_u_n_-_c_m_d, for in- stance. - version - The version test may be used to perform comparisons - against specific readline versions. The version expands - to the current readline version. The set of comparison - operators includes =, (and ==), !=, <=, >=, <, and >. - The version number supplied on the right side of the op- - erator consists of a major version number, an optional - decimal point, and an optional minor version (e.g., 7.1). - If the minor version is omitted, it is assumed to be 0. - The operator may be separated from the string version and + vveerrssiioonn + The vveerrssiioonn test may be used to perform comparisons + against specific readline versions. The vveerrssiioonn expands + to the current readline version. The set of comparison + operators includes ==, (and ====), !!==, <<==, >>==, <<, and >>. + The version number supplied on the right side of the op- + erator consists of a major version number, an optional + decimal point, and an optional minor version (e.g., 77..11). + If the minor version is omitted, it is assumed to be 00. + The operator may be separated from the string vveerrssiioonn and from the version number argument by whitespace. - application - The application construct is used to include application- - specific settings. Each program using the readline li- - brary sets the application name, and an initialization + aapppplliiccaattiioonn + The aapppplliiccaattiioonn construct is used to include application- + specific settings. Each program using the readline li- + brary sets the _a_p_p_l_i_c_a_t_i_o_n _n_a_m_e, and an initialization file can test for a particular value. This could be used - to bind key sequences to functions useful for a specific - program. For instance, the following command adds a key - sequence that quotes the current or previous word in - bash: + to bind key sequences to functions useful for a specific + program. For instance, the following command adds a key + sequence that quotes the current or previous word in + bbaasshh: - $if Bash + $$iiff Bash # Quote the current or previous word "\C-xq": "\eb\"\ef\"" - $endif + $$eennddiiff - variable - The variable construct provides simple equality tests for - readline variables and values. The permitted comparison - operators are =, ==, and !=. The variable name must be + _v_a_r_i_a_b_l_e + The _v_a_r_i_a_b_l_e construct provides simple equality tests for + readline variables and values. The permitted comparison + operators are _=, _=_=, and _!_=. The variable name must be separated from the comparison operator by whitespace; the - operator may be separated from the value on the right - hand side by whitespace. Both string and boolean vari- - ables may be tested. Boolean variables must be tested - against the values on and off. + operator may be separated from the value on the right + hand side by whitespace. Both string and boolean vari- + ables may be tested. Boolean variables must be tested + against the values _o_n and _o_f_f. - $endif This command, as seen in the previous example, terminates an $if + $$eennddiiff This command, as seen in the previous example, terminates an $$iiff command. - $else Commands in this branch of the $if directive are executed if the + $$eellssee Commands in this branch of the $$iiff directive are executed if the test fails. - $include - This directive takes a single filename as an argument and reads - commands and bindings from that file. For example, the follow- - ing directive would read /etc/inputrc: + $$iinncclluuddee + This directive takes a single filename as an argument and reads + commands and bindings from that file. For example, the follow- + ing directive would read _/_e_t_c_/_i_n_p_u_t_r_c: - $include /etc/inputrc + $$iinncclluuddee _/_e_t_c_/_i_n_p_u_t_r_c -SEARCHING - Readline provides commands for searching through the command history - for lines containing a specified string. There are two search modes: - incremental and non-incremental. +SSEEAARRCCHHIINNGG + Readline provides commands for searching through the command history + for lines containing a specified string. There are two search modes: + _i_n_c_r_e_m_e_n_t_a_l and _n_o_n_-_i_n_c_r_e_m_e_n_t_a_l. - Incremental searches begin before the user has finished typing the - search string. As each character of the search string is typed, read- + Incremental searches begin before the user has finished typing the + search string. As each character of the search string is typed, read- line displays the next entry from the history matching the string typed - so far. An incremental search requires only as many characters as - needed to find the desired history entry. To search backward in the - history for a particular string, type C-r. Typing C-s searches forward - through the history. The characters present in the value of the - isearch-terminators variable are used to terminate an incremental - search. If that variable has not been assigned a value the Escape and - C-J characters will terminate an incremental search. C-G will abort an - incremental search and restore the original line. When the search is - terminated, the history entry containing the search string becomes the + so far. An incremental search requires only as many characters as + needed to find the desired history entry. To search backward in the + history for a particular string, type CC--rr. Typing CC--ss searches forward + through the history. The characters present in the value of the + iisseeaarrcchh--tteerrmmiinnaattoorrss variable are used to terminate an incremental + search. If that variable has not been assigned a value the _E_s_c_a_p_e and + CC--JJ characters will terminate an incremental search. CC--GG will abort an + incremental search and restore the original line. When the search is + terminated, the history entry containing the search string becomes the current line. - To find other matching entries in the history list, type C-s or C-r as - appropriate. This will search backward or forward in the history for - the next line matching the search string typed so far. Any other key + To find other matching entries in the history list, type CC--ss or CC--rr as + appropriate. This will search backward or forward in the history for + the next line matching the search string typed so far. Any other key sequence bound to a readline command will terminate the search and exe- - cute that command. For instance, a newline will terminate the search - and accept the line, thereby executing the command from the history + cute that command. For instance, a newline will terminate the search + and accept the line, thereby executing the command from the history list. A movement command will terminate the search, make the last line found the current line, and begin editing. - Non-incremental searches read the entire search string before starting - to search for matching history lines. The search string may be typed + Non-incremental searches read the entire search string before starting + to search for matching history lines. The search string may be typed by the user or be part of the contents of the current line. -EDITING COMMANDS - The following is a list of the names of the commands and the default +EEDDIITTIINNGG CCOOMMMMAANNDDSS + The following is a list of the names of the commands and the default key sequences to which they are bound. Command names without an accom- panying key sequence are unbound by default. - In the following descriptions, point refers to the current cursor posi- - tion, and mark refers to a cursor position saved by the set-mark com- - mand. The text between the point and mark is referred to as the re- - gion. + In the following descriptions, _p_o_i_n_t refers to the current cursor posi- + tion, and _m_a_r_k refers to a cursor position saved by the sseett--mmaarrkk com- + mand. The text between the point and mark is referred to as the _r_e_- + _g_i_o_n. - Commands for Moving - beginning-of-line (C-a) + CCoommmmaannddss ffoorr MMoovviinngg + bbeeggiinnnniinngg--ooff--lliinnee ((CC--aa)) Move to the start of the current line. - end-of-line (C-e) + eenndd--ooff--lliinnee ((CC--ee)) Move to the end of the line. - forward-char (C-f) + ffoorrwwaarrdd--cchhaarr ((CC--ff)) Move forward a character. - backward-char (C-b) + bbaacckkwwaarrdd--cchhaarr ((CC--bb)) Move back a character. - forward-word (M-f) + ffoorrwwaarrdd--wwoorrdd ((MM--ff)) Move forward to the end of the next word. Words are composed of alphanumeric characters (letters and digits). - backward-word (M-b) - Move back to the start of the current or previous word. Words + bbaacckkwwaarrdd--wwoorrdd ((MM--bb)) + Move back to the start of the current or previous word. Words are composed of alphanumeric characters (letters and digits). - previous-screen-line - Attempt to move point to the same physical screen column on the - previous physical screen line. This will not have the desired - effect if the current readline line does not take up more than - one physical line or if point is not greater than the length of + pprreevviioouuss--ssccrreeeenn--lliinnee + Attempt to move point to the same physical screen column on the + previous physical screen line. This will not have the desired + effect if the current readline line does not take up more than + one physical line or if point is not greater than the length of the prompt plus the screen width. - next-screen-line - Attempt to move point to the same physical screen column on the + nneexxtt--ssccrreeeenn--lliinnee + Attempt to move point to the same physical screen column on the next physical screen line. This will not have the desired effect - if the current readline line does not take up more than one - physical line or if the length of the current readline line is + if the current readline line does not take up more than one + physical line or if the length of the current readline line is not greater than the length of the prompt plus the screen width. - clear-display (M-C-l) - Clear the screen and, if possible, the terminal's scrollback - buffer, then redraw the current line, leaving the current line + cclleeaarr--ddiissppllaayy ((MM--CC--ll)) + Clear the screen and, if possible, the terminal's scrollback + buffer, then redraw the current line, leaving the current line at the top of the screen. - clear-screen (C-l) + cclleeaarr--ssccrreeeenn ((CC--ll)) Clear the screen, then redraw the current line, leaving the cur- - rent line at the top of the screen. With an argument, refresh + rent line at the top of the screen. With an argument, refresh the current line without clearing the screen. - redraw-current-line + rreeddrraaww--ccuurrrreenntt--lliinnee Refresh the current line. - Commands for Manipulating the History - accept-line (Newline, Return) + CCoommmmaannddss ffoorr MMaanniippuullaattiinngg tthhee HHiissttoorryy + aacccceepptt--lliinnee ((NNeewwlliinnee,, RReettuurrnn)) Accept the line regardless of where the cursor is. If this line is non-empty, it may be added to the history list for future re- - call with add_history(). If the line is a modified history + call with aadddd__hhiissttoorryy(()). If the line is a modified history line, the history line is restored to its original state. - previous-history (C-p) + pprreevviioouuss--hhiissttoorryy ((CC--pp)) Fetch the previous command from the history list, moving back in the list. - next-history (C-n) - Fetch the next command from the history list, moving forward in + nneexxtt--hhiissttoorryy ((CC--nn)) + Fetch the next command from the history list, moving forward in the list. - beginning-of-history (M-<) + bbeeggiinnnniinngg--ooff--hhiissttoorryy ((MM--<<)) Move to the first line in the history. - end-of-history (M->) - Move to the end of the input history, i.e., the line currently + eenndd--ooff--hhiissttoorryy ((MM-->>)) + Move to the end of the input history, i.e., the line currently being entered. - operate-and-get-next (C-o) + ooppeerraattee--aanndd--ggeett--nneexxtt ((CC--oo)) Accept the current line for return to the calling application as - if a newline had been entered, and fetch the next line relative + if a newline had been entered, and fetch the next line relative to the current line from the history for editing. A numeric ar- - gument, if supplied, specifies the history entry to use instead + gument, if supplied, specifies the history entry to use instead of the current line. - fetch-history - With a numeric argument, fetch that entry from the history list + ffeettcchh--hhiissttoorryy + With a numeric argument, fetch that entry from the history list and make it the current line. Without an argument, move back to the first entry in the history list. - reverse-search-history (C-r) - Search backward starting at the current line and moving `up' - through the history as necessary. This is an incremental + rreevveerrssee--sseeaarrcchh--hhiissttoorryy ((CC--rr)) + Search backward starting at the current line and moving `up' + through the history as necessary. This is an incremental search. - forward-search-history (C-s) - Search forward starting at the current line and moving `down' - through the history as necessary. This is an incremental + ffoorrwwaarrdd--sseeaarrcchh--hhiissttoorryy ((CC--ss)) + Search forward starting at the current line and moving `down' + through the history as necessary. This is an incremental search. - non-incremental-reverse-search-history (M-p) + nnoonn--iinnccrreemmeennttaall--rreevveerrssee--sseeaarrcchh--hhiissttoorryy ((MM--pp)) Search backward through the history starting at the current line - using a non-incremental search for a string supplied by the + using a non-incremental search for a string supplied by the user. - non-incremental-forward-search-history (M-n) - Search forward through the history using a non-incremental + nnoonn--iinnccrreemmeennttaall--ffoorrwwaarrdd--sseeaarrcchh--hhiissttoorryy ((MM--nn)) + Search forward through the history using a non-incremental search for a string supplied by the user. - history-search-backward + hhiissttoorryy--sseeaarrcchh--bbaacckkwwaarrdd Search backward through the history for the string of characters between the start of the current line and the current cursor po- - sition (the point). The search string must match at the begin- + sition (the _p_o_i_n_t). The search string must match at the begin- ning of a history line. This is a non-incremental search. - history-search-forward - Search forward through the history for the string of characters + hhiissttoorryy--sseeaarrcchh--ffoorrwwaarrdd + Search forward through the history for the string of characters between the start of the current line and the point. The search string must match at the beginning of a history line. This is a non-incremental search. - history-substring-search-backward + hhiissttoorryy--ssuubbssttrriinngg--sseeaarrcchh--bbaacckkwwaarrdd Search backward through the history for the string of characters between the start of the current line and the current cursor po- - sition (the point). The search string may match anywhere in a + sition (the _p_o_i_n_t). The search string may match anywhere in a history line. This is a non-incremental search. - history-substring-search-forward - Search forward through the history for the string of characters + hhiissttoorryy--ssuubbssttrriinngg--sseeaarrcchh--ffoorrwwaarrdd + Search forward through the history for the string of characters between the start of the current line and the point. The search - string may match anywhere in a history line. This is a non-in- + string may match anywhere in a history line. This is a non-in- cremental search. - yank-nth-arg (M-C-y) - Insert the first argument to the previous command (usually the - second word on the previous line) at point. With an argument n, - insert the nth word from the previous command (the words in the - previous command begin with word 0). A negative argument in- - serts the nth word from the end of the previous command. Once - the argument n is computed, the argument is extracted as if the - "!n" history expansion had been specified. - yank-last-arg (M-., M-_) - Insert the last argument to the previous command (the last word + yyaannkk--nntthh--aarrgg ((MM--CC--yy)) + Insert the first argument to the previous command (usually the + second word on the previous line) at point. With an argument _n, + insert the _nth word from the previous command (the words in the + previous command begin with word 0). A negative argument in- + serts the _nth word from the end of the previous command. Once + the argument _n is computed, the argument is extracted as if the + "!_n" history expansion had been specified. + yyaannkk--llaasstt--aarrgg ((MM--..,, MM--__)) + Insert the last argument to the previous command (the last word of the previous history entry). With a numeric argument, behave - exactly like yank-nth-arg. Successive calls to yank-last-arg - move back through the history list, inserting the last word (or - the word specified by the argument to the first call) of each + exactly like yyaannkk--nntthh--aarrgg. Successive calls to yyaannkk--llaasstt--aarrgg + move back through the history list, inserting the last word (or + the word specified by the argument to the first call) of each line in turn. Any numeric argument supplied to these successive - calls determines the direction to move through the history. A - negative argument switches the direction through the history + calls determines the direction to move through the history. A + negative argument switches the direction through the history (back or forward). The history expansion facilities are used to - extract the last argument, as if the "!$" history expansion had + extract the last argument, as if the "!$" history expansion had been specified. - Commands for Changing Text - end-of-file (usually C-d) - The character indicating end-of-file as set, for example, by - ``stty''. If this character is read when there are no charac- - ters 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) + CCoommmmaannddss ffoorr CChhaannggiinngg TTeexxtt + _e_n_d_-_o_f_-_f_i_l_e ((uussuuaallllyy CC--dd)) + The character indicating end-of-file as set, for example, by + _s_t_t_y(1). 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 EEOOFF. + ddeelleettee--cchhaarr ((CC--dd)) Delete the character at point. If this function is bound to the - same character as the tty EOF character, as C-d commonly is, see + same character as the tty EEOOFF character, as CC--dd commonly is, see above for the effects. - backward-delete-char (Rubout) - Delete the character behind the cursor. When given a numeric + bbaacckkwwaarrdd--ddeelleettee--cchhaarr ((RRuubboouutt)) + Delete the character behind the cursor. When given a numeric argument, save the deleted text on the kill ring. - forward-backward-delete-char - Delete the character under the cursor, unless the cursor is at + ffoorrwwaarrdd--bbaacckkwwaarrdd--ddeelleettee--cchhaarr + Delete the character under the cursor, unless the cursor is at the end of the line, in which case the character behind the cur- sor is deleted. - quoted-insert (C-q, C-v) + qquuootteedd--iinnsseerrtt ((CC--qq,, CC--vv)) Add the next character that you type to the line verbatim. This - is how to insert characters like C-q, for example. - tab-insert (M-TAB) + is how to insert characters like CC--qq, for example. + ttaabb--iinnsseerrtt ((MM--TTAABB)) Insert a tab character. - self-insert (a, b, A, 1, !, ...) + sseellff--iinnsseerrtt ((aa,, bb,, AA,, 11,, !!,, ......)) Insert the character typed. - transpose-chars (C-t) - Drag the character before point forward over the character at - point, moving point forward as well. If point is at the end of - the line, then this transposes the two characters before point. + ttrraannssppoossee--cchhaarrss ((CC--tt)) + Drag the character before point forward over the character at + point, moving point forward as well. If point is at the end of + the line, then this transposes the two characters before point. Negative arguments have no effect. - transpose-words (M-t) - Drag the word before point past the word after point, moving - point over that word as well. If point is at the end of the + ttrraannssppoossee--wwoorrddss ((MM--tt)) + Drag the word before point past the word after point, moving + point over that word as well. If point is at the end of the line, this transposes the last two words on the line. - upcase-word (M-u) - Uppercase the current (or following) word. With a negative ar- + uuppccaassee--wwoorrdd ((MM--uu)) + Uppercase the current (or following) word. With a negative ar- gument, uppercase the previous word, but do not move point. - downcase-word (M-l) - Lowercase the current (or following) word. With a negative ar- + ddoowwnnccaassee--wwoorrdd ((MM--ll)) + Lowercase the current (or following) word. With a negative ar- gument, lowercase the previous word, but do not move point. - capitalize-word (M-c) + ccaappiittaalliizzee--wwoorrdd ((MM--cc)) Capitalize the current (or following) word. With a negative ar- gument, capitalize the previous word, but do not move point. - overwrite-mode - Toggle overwrite mode. With an explicit positive numeric argu- + oovveerrwwrriittee--mmooddee + Toggle overwrite mode. With an explicit positive numeric argu- ment, switches to overwrite mode. With an explicit non-positive numeric argument, switches to insert mode. This command affects - only emacs mode; vi mode does overwrite differently. Each call - to readline() starts in insert mode. In overwrite mode, charac- - ters bound to self-insert replace the text at point rather than - pushing the text to the right. Characters bound to back- - ward-delete-char replace the character before point with a + only eemmaaccss mode; vvii mode does overwrite differently. Each call + to _r_e_a_d_l_i_n_e_(_) starts in insert mode. In overwrite mode, charac- + ters bound to sseellff--iinnsseerrtt replace the text at point rather than + pushing the text to the right. Characters bound to bbaacckk-- + wwaarrdd--ddeelleettee--cchhaarr replace the character before point with a space. By default, this command is unbound. - Killing and Yanking - kill-line (C-k) + KKiilllliinngg aanndd YYaannkkiinngg + kkiillll--lliinnee ((CC--kk)) Kill the text from point to the end of the line. - backward-kill-line (C-x Rubout) + bbaacckkwwaarrdd--kkiillll--lliinnee ((CC--xx RRuubboouutt)) Kill backward to the beginning of the line. - unix-line-discard (C-u) - Kill backward from point to the beginning of the line. The + uunniixx--lliinnee--ddiissccaarrdd ((CC--uu)) + Kill backward from point to the beginning of the line. The killed text is saved on the kill-ring. - kill-whole-line - Kill all characters on the current line, no matter where point + kkiillll--wwhhoollee--lliinnee + Kill all characters on the current line, no matter where point is. - kill-word (M-d) - Kill from point the end of the current word, or if between - words, to the end of the next word. Word boundaries are the - same as those used by forward-word. - backward-kill-word (M-Rubout) - Kill the word behind point. Word boundaries are the same as - those used by backward-word. - unix-word-rubout (C-w) - Kill the word behind point, using white space as a word bound- + kkiillll--wwoorrdd ((MM--dd)) + Kill from point the end of the current word, or if between + words, to the end of the next word. Word boundaries are the + same as those used by ffoorrwwaarrdd--wwoorrdd. + bbaacckkwwaarrdd--kkiillll--wwoorrdd ((MM--RRuubboouutt)) + Kill the word behind point. Word boundaries are the same as + those used by bbaacckkwwaarrdd--wwoorrdd. + uunniixx--wwoorrdd--rruubboouutt ((CC--ww)) + Kill the word behind point, using white space as a word bound- ary. The killed text is saved on the kill-ring. - unix-filename-rubout - Kill the word behind point, using white space and the slash - character as the word boundaries. The killed text is saved on + uunniixx--ffiilleennaammee--rruubboouutt + Kill the word behind point, using white space and the slash + character as the word boundaries. The killed text is saved on the kill-ring. - delete-horizontal-space (M-\) + ddeelleettee--hhoorriizzoonnttaall--ssppaaccee ((MM--\\)) Delete all spaces and tabs around point. - kill-region - Kill the text between the point and mark (saved cursor posi- - tion). This text is referred to as the region. - copy-region-as-kill + kkiillll--rreeggiioonn + Kill the text between the point and _m_a_r_k (saved cursor posi- + tion). This text is referred to as the _r_e_g_i_o_n. + ccooppyy--rreeggiioonn--aass--kkiillll Copy the text in the region to the kill buffer. - copy-backward-word - Copy the word before point to the kill buffer. The word bound- - aries are the same as backward-word. - copy-forward-word - Copy the word following point to the kill buffer. The word - boundaries are the same as forward-word. - yank (C-y) + ccooppyy--bbaacckkwwaarrdd--wwoorrdd + Copy the word before point to the kill buffer. The word bound- + aries are the same as bbaacckkwwaarrdd--wwoorrdd. + ccooppyy--ffoorrwwaarrdd--wwoorrdd + Copy the word following point to the kill buffer. The word + boundaries are the same as ffoorrwwaarrdd--wwoorrdd. + yyaannkk ((CC--yy)) Yank the top of the kill ring into the buffer at point. - yank-pop (M-y) - Rotate the kill ring, and yank the new top. Only works follow- - ing yank or yank-pop. + yyaannkk--ppoopp ((MM--yy)) + Rotate the kill ring, and yank the new top. Only works follow- + ing yyaannkk or yyaannkk--ppoopp. - Numeric Arguments - digit-argument (M-0, M-1, ..., M--) - Add this digit to the argument already accumulating, or start a + NNuummeerriicc AArrgguummeennttss + ddiiggiitt--aarrgguummeenntt ((MM--00,, MM--11,, ......,, MM----)) + 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 fol- - lowed by digits, executing universal-argument again ends the nu- + uunniivveerrssaall--aarrgguummeenntt + 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 fol- + lowed by digits, executing uunniivveerrssaall--aarrgguummeenntt again ends the nu- meric argument, but is otherwise ignored. As a special case, if this command is immediately followed by a character that is nei- ther a digit or minus sign, the argument count for the next com- - mand is multiplied by four. The argument count is initially - one, so executing this function the first time makes the argu- + mand is multiplied by four. The argument count is initially + one, so executing this function the first time makes the argu- ment count four, a second time makes the argument count sixteen, and so on. - Completing - complete (TAB) + CCoommpplleettiinngg + ccoommpplleettee ((TTAABB)) Attempt to perform completion on the text before point. The ac- - tual completion performed is application-specific. Bash, for - instance, attempts completion treating the text as a variable - (if the text begins with $), username (if the text begins with - ~), hostname (if the text begins with @), or command (including - aliases and functions) in turn. If none of these produces a - match, filename completion is attempted. Gdb, on the other - hand, allows completion of program functions and variables, and + tual completion performed is application-specific. BBaasshh, for + instance, attempts completion treating the text as a variable + (if the text begins with $$), username (if the text begins with + ~~), hostname (if the text begins with @@), or command (including + aliases and functions) in turn. If none of these produces a + match, filename completion is attempted. GGddbb, on the other + hand, allows completion of program functions and variables, and only attempts filename completion under certain circumstances. - possible-completions (M-?) - List the possible completions of the text before point. When + ppoossssiibbllee--ccoommpplleettiioonnss ((MM--??)) + 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 + for display to the value of ccoommpplleettiioonn--ddiissppllaayy--wwiiddtthh, the value + of the environment variable CCOOLLUUMMNNSS, 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 of possible - completions, inserting each match in turn. At the end of the + iinnsseerrtt--ccoommpplleettiioonnss ((MM--**)) + Insert all completions of the text before point that would have + been generated by ppoossssiibbllee--ccoommpplleettiioonnss. + mmeennuu--ccoommpplleettee + Similar to ccoommpplleettee, but replaces the word to be completed with + a single match from the list of possible completions. Repeated + execution of mmeennuu--ccoommpplleettee steps through the list of possible + completions, inserting each match in turn. At the end of the list of completions, the bell is rung (subject to the setting of - bell-style) and the original text is restored. An argument of n - moves n positions forward in the list of matches; a negative ar- + bbeellll--ssttyyllee) and the original text is restored. An argument of _n + moves _n positions forward in the list of matches; a negative ar- gument may be used to move backward through the list. This com- - mand is intended to be bound to TAB, but is unbound 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 + mand is intended to be bound to TTAABB, but is unbound by default. + mmeennuu--ccoommpplleettee--bbaacckkwwaarrdd + Identical to mmeennuu--ccoommpplleettee, but moves backward through the list + of possible completions, as if mmeennuu--ccoommpplleettee had been given a negative argument. This command is unbound by default. - 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 possible-completions. - - Keyboard Macros - start-kbd-macro (C-x () - Begin saving the characters typed into the current keyboard + ddeelleettee--cchhaarr--oorr--lliisstt + Deletes the character under the cursor if not at the beginning + or end of the line (like ddeelleettee--cchhaarr). If at the end of the + line, behaves identically to ppoossssiibbllee--ccoommpplleettiioonnss. + + KKeeyybbooaarrdd MMaaccrrooss + ssttaarrtt--kkbbdd--mmaaccrroo ((CC--xx (()) + Begin saving the characters typed into the current keyboard macro. - end-kbd-macro (C-x )) + eenndd--kkbbdd--mmaaccrroo ((CC--xx )))) Stop saving the characters typed into the current keyboard macro and store the definition. - call-last-kbd-macro (C-x e) - Re-execute the last keyboard macro defined, by making the char- + ccaallll--llaasstt--kkbbdd--mmaaccrroo ((CC--xx ee)) + Re-execute the last keyboard macro defined, by making the char- acters in the macro appear as if typed at the keyboard. - print-last-kbd-macro () - Print the last keyboard macro defined in a format suitable for - the inputrc file. + pprriinntt--llaasstt--kkbbdd--mmaaccrroo (()) + Print the last keyboard macro defined in a format suitable for + the _i_n_p_u_t_r_c file. - Miscellaneous - re-read-init-file (C-x C-r) - Read in the contents of the inputrc file, and incorporate any + MMiisscceellllaanneeoouuss + rree--rreeaadd--iinniitt--ffiillee ((CC--xx CC--rr)) + Read in the contents of the _i_n_p_u_t_r_c 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-lowercase-version (M-A, M-B, M-x, ...) - If the metafied character x is uppercase, run the command that + aabboorrtt ((CC--gg)) + Abort the current editing command and ring the terminal's bell + (subject to the setting of bbeellll--ssttyyllee). + ddoo--lloowweerrccaassee--vveerrssiioonn ((MM--AA,, MM--BB,, MM--_x,, ......)) + If the metafied character _x is uppercase, run the command that is bound to the corresponding metafied lowercase character. The - behavior is undefined if x is already lowercase. - prefix-meta (ESC) - Metafy the next character typed. ESC f is equivalent to Meta-f. - undo (C-_, C-x C-u) + behavior is undefined if _x is already lowercase. + pprreeffiixx--mmeettaa ((EESSCC)) + Metafy the next character typed. EESSCC ff is equivalent to MMeettaa--ff. + uunnddoo ((CC--__,, CC--xx CC--uu)) 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 return the line to its initial + rreevveerrtt--lliinnee ((MM--rr)) + Undo all changes made to this line. This is like executing the + uunnddoo command enough times to return the line to its initial state. - tilde-expand (M-&) + ttiillddee--eexxppaanndd ((MM--&&)) Perform tilde expansion on the current word. - set-mark (C-@, M-) - Set the mark to the point. If a numeric argument is supplied, + sseett--mmaarrkk ((CC--@@,, MM--<>)) + 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 + eexxcchhaannggee--ppooiinntt--aanndd--mmaarrkk ((CC--xx CC--xx)) + 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-]) + cchhaarraacctteerr--sseeaarrcchh ((CC--]])) A character is read and point is moved to the next occurrence of - that character. A negative argument searches for previous oc- + that character. A negative argument searches for previous oc- currences. - character-search-backward (M-C-]) - A character is read and point is moved to the previous occur- - rence of that character. A negative argument searches for sub- + cchhaarraacctteerr--sseeaarrcchh--bbaacckkwwaarrdd ((MM--CC--]])) + A character is read and point is moved to the previous occur- + rence of that character. A negative argument searches for sub- sequent 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 + sskkiipp--ccssii--sseeqquueennccee + 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 bound to "\[", keys producing such sequences will - have no effect unless explicitly bound to a readline command, - instead of inserting stray characters into the editing buffer. + sequence is bound to "\[", keys producing such sequences will + have no effect unless explicitly bound to a readline command, + instead of inserting stray characters into the editing buffer. This is unbound by default, but usually bound to ESC-[. - insert-comment (M-#) - Without a numeric argument, the value of the readline com- - ment-begin variable is inserted at the beginning of the current + iinnsseerrtt--ccoommmmeenntt ((MM--##)) + Without a numeric argument, the value of the readline ccoomm-- + mmeenntt--bbeeggiinn variable is inserted at the beginning of the current line. If a numeric argument is supplied, this command acts as a - toggle: if the characters at the beginning of the line do not - match the value of comment-begin, the value is inserted, other- - wise the characters in comment-begin are deleted from the begin- - ning of the line. In either case, the line is accepted as if a - newline had been typed. The default value of comment-begin - makes the current line a shell comment. If a numeric argument + toggle: if the characters at the beginning of the line do not + match the value of ccoommmmeenntt--bbeeggiinn, the value is inserted, other- + wise the characters in ccoommmmeenntt--bbeeggiinn are deleted from the begin- + ning of the line. In either case, the line is accepted as if a + newline had been typed. The default value of ccoommmmeenntt--bbeeggiinn + makes the current line a shell comment. If a numeric argument causes the comment character to be removed, the line will be ex- ecuted by the shell. - dump-functions - Print all of the functions and their key bindings to the read- + dduummpp--ffuunnccttiioonnss + Print all of the functions and their key bindings to the read- line output stream. If a numeric argument is supplied, the out- - put is formatted in such a way that it can be made part of an - inputrc file. - dump-variables - Print all of the settable variables and their values to the - readline output stream. If a numeric argument is supplied, the + put is formatted in such a way that it can be made part of an + _i_n_p_u_t_r_c file. + dduummpp--vvaarriiaabblleess + 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. - dump-macros - Print all of the readline key sequences bound to macros and the - strings they output. If a numeric argument is supplied, the + _i_n_p_u_t_r_c file. + dduummpp--mmaaccrrooss + 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. - emacs-editing-mode (C-e) - When in vi command mode, this causes a switch to emacs editing + _i_n_p_u_t_r_c file. + eemmaaccss--eeddiittiinngg--mmooddee ((CC--ee)) + When in vvii command mode, this causes a switch to eemmaaccss editing mode. - vi-editing-mode (M-C-j) - When in emacs editing mode, this causes a switch to vi editing + vvii--eeddiittiinngg--mmooddee ((MM--CC--jj)) + When in eemmaaccss editing mode, this causes a switch to vvii editing mode. -DEFAULT KEY BINDINGS - The following is a list of the default emacs and vi bindings. Charac- - ters with the eighth bit set are written as M-, and are re- - ferred to as metafied characters. The printable ASCII characters not - mentioned in the list of emacs standard bindings are bound to the - self-insert function, which just inserts the given character into the +DDEEFFAAUULLTT KKEEYY BBIINNDDIINNGGSS + The following is a list of the default emacs and vi bindings. Charac- + ters with the eighth bit set are written as M-, and are re- + ferred to as _m_e_t_a_f_i_e_d characters. The printable ASCII characters not + mentioned in the list of emacs standard bindings are bound to the + sseellff--iinnsseerrtt function, which just inserts the given character into the input line. In vi insertion mode, all characters not specifically men- - tioned are bound to self-insert. Characters assigned to signal genera- - tion by stty(1) or the terminal driver, such as C-Z or C-C, retain that - function. Upper and lower case metafied characters are bound to the - same function in the emacs mode meta keymap. The remaining characters - are unbound, which causes readline to ring the bell (subject to the - setting of the bell-style variable). - - Emacs Mode + tioned are bound to sseellff--iinnsseerrtt. Characters assigned to signal genera- + tion by _s_t_t_y(1) or the terminal driver, such as C-Z or C-C, retain that + function. Upper and lower case metafied characters are bound to the + same function in the emacs mode meta keymap. The remaining characters + are unbound, which causes readline to ring the bell (subject to the + setting of the bbeellll--ssttyyllee variable). + + EEmmaaccss MMooddee Emacs Standard bindings "C-@" set-mark @@ -1034,8 +1043,7 @@ READLINE(3) Library Functions Manual READLINE(3) "C-XE" call-last-kbd-macro "C-XC-?" backward-kill-line - - VI Mode bindings + VVII MMooddee bbiinnddiinnggss VI Insert Mode functions "C-D" vi-eof-maybe @@ -1043,15 +1051,17 @@ READLINE(3) Library Functions Manual READLINE(3) "C-I" complete "C-J" accept-line "C-M" accept-line + "C-N" menu-complete + "C-P" menu-complete-backward "C-R" reverse-search-history "C-S" forward-search-history "C-T" transpose-chars "C-U" unix-line-discard "C-V" quoted-insert - "C-W" unix-word-rubout + "C-W" vi-unix-word-rubout "C-Y" yank "C-[" vi-movement-mode - "C-_" undo + "C-_" vi-undo " " to "~" self-insert "C-?" backward-delete-char @@ -1073,7 +1083,7 @@ READLINE(3) Library Functions Manual READLINE(3) "C-T" transpose-chars "C-U" unix-line-discard "C-V" quoted-insert - "C-W" unix-word-rubout + "C-W" vi-unix-word-rubout "C-Y" yank "C-_" vi-undo " " forward-char @@ -1107,7 +1117,7 @@ READLINE(3) Library Functions Manual READLINE(3) "T" vi-char-search "U" revert-line "W" vi-next-word - "X" backward-delete-char + "X" vi-rubout "Y" vi-yank-to "\" vi-complete "^" vi-first-print @@ -1122,7 +1132,7 @@ READLINE(3) Library Functions Manual READLINE(3) "h" backward-char "i" vi-insertion-mode "j" next-history - "k" prev-history + "k" previous-history "l" forward-char "m" vi-set-mark "n" vi-search-again @@ -1137,39 +1147,39 @@ READLINE(3) Library Functions Manual READLINE(3) "|" vi-column "~" vi-change-case -SEE ALSO - The Gnu Readline Library, Brian Fox and Chet Ramey - The Gnu History Library, Brian Fox and Chet Ramey - bash(1) +SSEEEE AALLSSOO + _T_h_e _G_n_u _R_e_a_d_l_i_n_e _L_i_b_r_a_r_y, Brian Fox and Chet Ramey + _T_h_e _G_n_u _H_i_s_t_o_r_y _L_i_b_r_a_r_y, Brian Fox and Chet Ramey + _b_a_s_h(1) -FILES - ~/.inputrc - Individual readline initialization file +FFIILLEESS + _~_/_._i_n_p_u_t_r_c + Individual rreeaaddlliinnee initialization file -AUTHORS +AAUUTTHHOORRSS Brian Fox, Free Software Foundation bfox@gnu.org Chet Ramey, Case Western Reserve University chet.ramey@case.edu -BUG REPORTS - If you find a bug in readline, you should report it. But first, you - should make sure that it really is a bug, and that it appears in the - latest version of the readline library that you have. +BBUUGG RREEPPOORRTTSS + If you find a bug in rreeaaddlliinnee,, you should report it. But first, you + should make sure that it really is a bug, and that it appears in the + latest version of the rreeaaddlliinnee library that you have. - Once you have determined that a bug actually exists, mail a bug report - to bug-readline@gnu.org. If you have a fix, you are welcome to mail - that as well! Suggestions and `philosophical' bug reports may be - mailed to bug-readline@gnu.org or posted to the Usenet newsgroup - gnu.bash.bug. + Once you have determined that a bug actually exists, mail a bug report + to _b_u_g_-_r_e_a_d_l_i_n_e@_g_n_u_._o_r_g. If you have a fix, you are welcome to mail + that as well! Suggestions and `philosophical' bug reports may be + mailed to _b_u_g_-_r_e_a_d_l_i_n_e@_g_n_u_._o_r_g or posted to the Usenet newsgroup + ggnnuu..bbaasshh..bbuugg. Comments and bug reports concerning this manual page should be directed - to chet.ramey@case.edu. + to _c_h_e_t_._r_a_m_e_y_@_c_a_s_e_._e_d_u. -BUGS +BBUUGGSS It's too big and too slow. -GNU Readline 8.2 2022 September 19 READLINE(3) +GNU Readline 8.3 2024 January 18 READLINE(3) diff --git a/doc/readline.3 b/doc/readline.3 index 9af32f7..a6b0659 100644 --- a/doc/readline.3 +++ b/doc/readline.3 @@ -6,15 +6,22 @@ .\" Case Western Reserve University .\" chet.ramey@case.edu .\" -.\" Last Change: Fri Jan 5 11:02:00 EST 2024 +.\" Last Change: Thu Jan 18 11:05:44 EST 2024 .\" -.TH READLINE 3 "2024 January 5" "GNU Readline 8.3" +.TH READLINE 3 "2024 January 18" "GNU Readline 8.3" .\" .\" File Name macro. This used to be `.PN', for Path Name, .\" but Sun doesn't seem to like that very much. .\" .de FN -\fI\|\\$1\|\fP +\%\fI\|\\$1\|\fP +.. +.de Q +.ie \n(.g \(lq\\$1\(rq\\$2 +.el \{ +. if t ``\\$1''\\$2 +. if n "\\$1"\\$2 +.\} .. .SH NAME readline \- get a line from a user with editing @@ -141,7 +148,7 @@ or .RS C\-Meta\-u: universal\-argument .RE -.sp +.LP into the .I inputrc would make M\-C\-u execute the readline command @@ -179,7 +186,7 @@ whitespace between the name and the colon. When using the form \fBkeyname\fP:\^\fIfunction-name\fP or \fImacro\fP, .I keyname is the name of a key spelled out in English. For example: -.sp +.PP .RS Control\-u: universal\-argument .br @@ -199,8 +206,7 @@ and .I C\-o is bound to run the macro expressed on the right hand side (that is, to insert the text -.if t \f(CW> output\fP -.if n ``> output'' +.Q "> output" into the line). .PP In the second form, \fB"keyseq"\fP:\^\fIfunction\-name\fP or \fImacro\fP, @@ -212,7 +218,7 @@ an entire key sequence may be specified by placing the sequence within double quotes. Some GNU Emacs style key escapes can be used, as in the following example, but the symbolic character names are not recognized. -.sp +.PP .RS "\eC\-u": universal\-argument .br @@ -231,8 +237,7 @@ is bound to the function and .I "ESC [ 1 1 \(ti" is bound to insert the text -.if t \f(CWFunction Key 1\fP. -.if n ``Function Key 1''. +.Q "Function Key 1" . .PP The full set of GNU Emacs style escape sequences available when specifying key sequences is @@ -352,19 +357,24 @@ It is output to the terminal before displaying the text in the active region. This variable is reset to the default value whenever the terminal type changes. The default value is the string that puts the terminal in standout mode, as obtained from the terminal's terminfo description. -A sample value might be \f(CW"\ee[01;33m"\fP. +A sample value might be +.Q "\ee[01;33m" . .TP .B active\-region\-end\-color -A string variable that "undoes" the effects of \fBactive\-region\-start\-color\fP -and restores "normal" terminal display appearance after displaying text -in the active region. +A string variable that +.Q undoes +the effects of \fBactive\-region\-start\-color\fP +and restores +.Q normal +terminal display appearance after displaying text in the active region. This string must not take up any physical character positions on the display, so it should consist only of terminal escape sequences. It is output to the terminal after displaying the text in the active region. This variable is reset to the default value whenever the terminal type changes. The default value is the string that restores the terminal from standout mode, as obtained from the terminal's terminfo description. -A sample value might be \f(CW"\ee[0m\fP". +A sample value might be +.Q "\ee[0m" . .TP .B bell\-style (audible) Controls what happens when readline wants to ring the terminal bell. @@ -378,7 +388,9 @@ characters that are treated specially by the kernel's terminal driver to their readline equivalents. These override the default readline bindings described here. -Type \f(CWstty -a\fP at a bash prompt to see your current terminal settings, +Type +.Q "stty -a" +at a \fBbash\fP prompt to see your current terminal settings, including the special control characters (usually \fBcchars\fP). .TP .B blink\-matching\-paren (Off) @@ -391,7 +403,8 @@ common prefix of the set of possible completions using a different color. The color definitions are taken from the value of the \fBLS_COLORS\fP environment variable. If there is a color definition in \fB$LS_COLORS\fP for the custom suffix -"readline-colored-completion-prefix", readline uses this color for +.Q readline-colored-completion-prefix , +readline uses this color for the common prefix instead of its default. .TP .B colored\-stats (Off) @@ -752,7 +765,7 @@ file can test for a particular value. This could be used to bind key sequences to functions useful for a specific program. For instance, the following command adds a key sequence that quotes the current or previous word in \fBbash\fP: -.sp 1 +.PP .RS .nf \fB$if\fP Bash @@ -781,8 +794,8 @@ the test fails. This directive takes a single filename as an argument and reads commands and bindings from that file. For example, the following directive would read \fI/etc/inputrc\fP: -.sp 1 .RS +.PP .nf \fB$include\fP \^ \fI/etc/inputrc\fP .fi @@ -977,7 +990,9 @@ insert the \fIn\fPth word from the previous command (the words in the previous command begin with word 0). A negative argument inserts the \fIn\fPth word from the end of the previous command. Once the argument \fIn\fP is computed, the argument is extracted -as if the "!\fIn\fP" history expansion had been specified. +as if the +.Q !\fIn\fP +history expansion had been specified. .TP .B yank\-last\-arg (M\-.\^, M\-_\^) @@ -991,15 +1006,16 @@ Any numeric argument supplied to these successive calls determines the direction to move through the history. A negative argument switches the direction through the history (back or forward). The history expansion facilities are used to extract the last argument, -as if the "!$" history expansion had been specified. +as if the +.Q !$ +history expansion had been specified. .PD .SS Commands for Changing Text .PD 0 .TP .B \fIend\-of\-file\fP (usually C\-d) The character indicating end-of-file as set, for example, by -.if t \f(CWstty\fP. -.if n ``stty''. +.IR stty (1). 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 @@ -1280,7 +1296,9 @@ character. A negative argument searches for subsequent occurrences. 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 -bound to "\e[", keys producing such sequences will have no effect +bound to +.Q \e[ , +keys producing such sequences will have no effect unless explicitly bound to a readline command, instead of inserting stray characters into the editing buffer. This is unbound by default, but usually bound to ESC\-[. @@ -1363,7 +1381,7 @@ variable). .ta 2.5i .sp Emacs Standard bindings -.sp +.PP "C-@" set-mark "C-A" beginning-of-line "C-B" backward-char @@ -1395,7 +1413,7 @@ Emacs Standard bindings "C-?" backward-delete-char .PP Emacs Meta bindings -.sp +.PP "M-C-G" abort "M-C-H" backward-kill-word "M-C-I" tab-insert @@ -1443,7 +1461,7 @@ Emacs Meta bindings "M-_" yank-last-arg .PP Emacs Control-X bindings -.sp +.PP "C-XC-G" abort "C-XC-R" re-read-init-file "C-XC-U" undo @@ -1452,16 +1470,14 @@ Emacs Control-X bindings "C-X)" end-kbd-macro "C-XE" call-last-kbd-macro "C-XC-?" backward-kill-line -.sp .RE .SS VI Mode bindings .RS +.6i .nf .ta 2.5i -.sp .PP VI Insert Mode functions -.sp +.PP "C-D" vi-eof-maybe "C-H" backward-delete-char "C-I" complete @@ -1482,7 +1498,7 @@ VI Insert Mode functions "C-?" backward-delete-char .PP VI Command Mode functions -.sp +.PP "C-D" vi-eof-maybe "C-E" emacs-editing-mode "C-G" abort diff --git a/doc/rluser.texi b/doc/rluser.texi index 3793d81..aa64852 100644 --- a/doc/rluser.texi +++ b/doc/rluser.texi @@ -323,13 +323,14 @@ the line, thereby executing the command from the history list. A movement command will terminate the search, make the last line found the current line, and begin editing. -Readline remembers the last incremental search string. If two -@kbd{C-r}s are typed without any intervening characters defining a new -search string, any remembered search string is used. +Readline remembers the last incremental search string. +If two @kbd{C-r}s are typed without any intervening characters defining +a new search string, Readline uses any remembered search string. Non-incremental searches read the entire search string before starting -to search for matching history lines. The search string may be -typed by the user or be part of the contents of the current line. +to search for matching history lines. +The search string may be typed by the user or be part of the contents of +the current line. @node Readline Init File @section Readline Init File @@ -2502,9 +2503,11 @@ complete -o filenames -o nospace -o bashdefault -F _comp_cd cd @noindent Since we'd like Bash and Readline to take care of some of the other details for us, we use several other options to tell Bash -and Readline what to do. The @option{-o filenames} option tells Readline +and Readline what to do. +The @option{-o filenames} option tells Readline that the possible completions should be treated as filenames, and quoted -appropriately. That option will also cause Readline to append a slash to +appropriately. +That option will also cause Readline to append a slash to filenames it can determine are directories (which is why we might want to extend @code{_comp_cd} to append a slash if we're using directories found via @var{CDPATH}: Readline can't tell those completions are directories). @@ -2512,9 +2515,10 @@ The @option{-o nospace} option tells Readline to not append a space character to the directory name, in case we want to append to it. The @option{-o bashdefault} option brings in the rest of the "Bash default" completions -- possible completions that Bash adds to the default Readline -set. These include things like command name completion, variable completion -for words beginning with @samp{$} or @samp{$@{}, completions containing pathname -expansion patterns (@pxref{Filename Expansion}), and so on. +set. +These include things like command name completion, variable completion +for words beginning with @samp{$} or @samp{$@{}, completions containing +pathname expansion patterns (@pxref{Filename Expansion}), and so on. Once installed using @code{complete}, @code{_comp_cd} will be called every time we attempt word completion for a @code{cd} command. @@ -2523,8 +2527,8 @@ Many more examples -- an extensive collection of completions for most of the common GNU, Unix, and Linux commands -- are available as part of the bash_completion project. This is installed by default on many GNU/Linux distributions. Originally written by Ian Macdonald, the project now lives -at @url{https://github.com/scop/bash-completion/}. There are ports for -other systems such as Solaris and Mac OS X. +at @url{https://github.com/scop/bash-completion/}. +There are ports for other systems such as Solaris and Mac OS X. An older version of the bash_completion package is distributed with bash in the @file{examples/complete} subdirectory. diff --git a/doc/version.texi b/doc/version.texi index 2eed8b1..9c820a9 100644 --- a/doc/version.texi +++ b/doc/version.texi @@ -5,7 +5,7 @@ Copyright (C) 1988-2024 Free Software Foundation, Inc. @set EDITION 8.3 @set VERSION 8.3 -@set UPDATED 5 January 2024 +@set UPDATED 19 January 2024 @set UPDATED-MONTH January 2024 -@set LASTCHANGE Fri Jan 5 11:01:44 EST 2024 +@set LASTCHANGE Fri Jan 19 11:01:44 EST 2024 diff --git a/readline.h b/readline.h index f8c356e..3224706 100644 --- a/readline.h +++ b/readline.h @@ -914,37 +914,40 @@ extern int rl_persistent_signal_handlers; #define MULT_MATCH 2 /* Possible state values for rl_readline_state */ -#define RL_STATE_NONE 0x000000 /* no state; before first call */ - -#define RL_STATE_INITIALIZING 0x0000001 /* initializing */ -#define RL_STATE_INITIALIZED 0x0000002 /* initialization done */ -#define RL_STATE_TERMPREPPED 0x0000004 /* terminal is prepped */ -#define RL_STATE_READCMD 0x0000008 /* reading a command key */ -#define RL_STATE_METANEXT 0x0000010 /* reading input after ESC */ -#define RL_STATE_DISPATCHING 0x0000020 /* dispatching to a command */ -#define RL_STATE_MOREINPUT 0x0000040 /* reading more input in a command function */ -#define RL_STATE_ISEARCH 0x0000080 /* doing incremental search */ -#define RL_STATE_NSEARCH 0x0000100 /* doing non-inc search */ -#define RL_STATE_SEARCH 0x0000200 /* doing a history search */ -#define RL_STATE_NUMERICARG 0x0000400 /* reading numeric argument */ -#define RL_STATE_MACROINPUT 0x0000800 /* getting input from a macro */ -#define RL_STATE_MACRODEF 0x0001000 /* defining keyboard macro */ -#define RL_STATE_OVERWRITE 0x0002000 /* overwrite mode */ -#define RL_STATE_COMPLETING 0x0004000 /* doing completion */ -#define RL_STATE_SIGHANDLER 0x0008000 /* in readline sighandler */ -#define RL_STATE_UNDOING 0x0010000 /* doing an undo */ -#define RL_STATE_INPUTPENDING 0x0020000 /* rl_execute_next called */ -#define RL_STATE_TTYCSAVED 0x0040000 /* tty special chars saved */ -#define RL_STATE_CALLBACK 0x0080000 /* using the callback interface */ -#define RL_STATE_VIMOTION 0x0100000 /* reading vi motion arg */ -#define RL_STATE_MULTIKEY 0x0200000 /* reading multiple-key command */ -#define RL_STATE_VICMDONCE 0x0400000 /* entered vi command mode at least once */ -#define RL_STATE_CHARSEARCH 0x0800000 /* vi mode char search */ -#define RL_STATE_REDISPLAYING 0x1000000 /* updating terminal display */ - -#define RL_STATE_DONE 0x2000000 /* done; accepted line */ -#define RL_STATE_TIMEOUT 0x4000000 /* done; timed out */ -#define RL_STATE_EOF 0x8000000 /* done; got eof on read */ +#define RL_STATE_NONE 0x0000000 /* no state; before first call */ + +#define RL_STATE_INITIALIZING 0x00000001 /* initializing */ +#define RL_STATE_INITIALIZED 0x00000002 /* initialization done */ +#define RL_STATE_TERMPREPPED 0x00000004 /* terminal is prepped */ +#define RL_STATE_READCMD 0x00000008 /* reading a command key */ +#define RL_STATE_METANEXT 0x00000010 /* reading input after ESC */ +#define RL_STATE_DISPATCHING 0x00000020 /* dispatching to a command */ +#define RL_STATE_MOREINPUT 0x00000040 /* reading more input in a command function */ +#define RL_STATE_ISEARCH 0x00000080 /* doing incremental search */ +#define RL_STATE_NSEARCH 0x00000100 /* doing non-inc search */ +#define RL_STATE_SEARCH 0x00000200 /* doing a history search */ +#define RL_STATE_NUMERICARG 0x00000400 /* reading numeric argument */ +#define RL_STATE_MACROINPUT 0x00000800 /* getting input from a macro */ +#define RL_STATE_MACRODEF 0x00001000 /* defining keyboard macro */ +#define RL_STATE_OVERWRITE 0x00002000 /* overwrite mode */ +#define RL_STATE_COMPLETING 0x00004000 /* doing completion */ +#define RL_STATE_SIGHANDLER 0x00008000 /* in readline sighandler */ +#define RL_STATE_UNDOING 0x00010000 /* doing an undo */ +#define RL_STATE_INPUTPENDING 0x00020000 /* rl_execute_next called */ +#define RL_STATE_TTYCSAVED 0x00040000 /* tty special chars saved */ +#define RL_STATE_CALLBACK 0x00080000 /* using the callback interface */ +#define RL_STATE_VIMOTION 0x00100000 /* reading vi motion arg */ +#define RL_STATE_MULTIKEY 0x00200000 /* reading multiple-key command */ +#define RL_STATE_VICMDONCE 0x00400000 /* entered vi command mode at least once */ +#define RL_STATE_CHARSEARCH 0x00800000 /* vi mode char search */ +#define RL_STATE_REDISPLAYING 0x01000000 /* updating terminal display */ + +#define RL_STATE_DONE 0x02000000 /* done; accepted line */ +#define RL_STATE_TIMEOUT 0x04000000 /* done; timed out */ +#define RL_STATE_EOF 0x08000000 /* done; got eof on read */ + +/* Rearrange these for next major version */ +#define RL_STATE_READSTR 0x10000000 /* reading a string for M-x */ #define RL_SETSTATE(x) (rl_readline_state |= (x)) #define RL_UNSETSTATE(x) (rl_readline_state &= ~(x)) diff --git a/rlprivate.h b/rlprivate.h index 461617c..a2ab98b 100644 --- a/rlprivate.h +++ b/rlprivate.h @@ -67,6 +67,7 @@ #define SF_CHGKMAP 0x08 #define SF_PATTERN 0x10 #define SF_NOCASE 0x20 /* unused so far */ +#define SF_FREEPMT 0x40 /* saved prompt separately, need to free it */ typedef struct __rl_search_context { @@ -111,7 +112,8 @@ typedef struct __rl_search_context } _rl_search_cxt; /* readstr flags */ -#define RL_READSTR_NOSPACE 0x01 /* don't insert space, use for completion */ +#define READSTR_NOSPACE 0x01 /* don't insert space, use for completion */ +#define READSTR_FREEPMT 0x02 /* called rl_save_prompt, need to free it ourselves */ typedef struct __rl_readstr_context { @@ -432,6 +434,7 @@ extern int _rl_restore_tty_signals (void); /* search.c */ extern int _rl_nsearch_callback (_rl_search_cxt *); extern int _rl_nsearch_cleanup (_rl_search_cxt *, int); +extern int _rl_nsearch_sigcleanup (_rl_search_cxt *, int); extern void _rl_free_saved_search_line (void); @@ -443,6 +446,8 @@ extern void _rl_release_sigint (void); extern void _rl_block_sigwinch (void); extern void _rl_release_sigwinch (void); +extern void _rl_state_sigcleanup (void); + /* terminal.c */ extern void _rl_get_screen_size (int, int); extern void _rl_sigwinch_resize_terminal (void); @@ -488,6 +493,7 @@ extern void _rl_free_saved_readstr_line (void); extern void _rl_unsave_saved_readstr_line (void); extern _rl_readstr_cxt *_rl_readstr_init (int, int); extern int _rl_readstr_cleanup (_rl_readstr_cxt *, int); +extern int _rl_readstr_sigcleanup (_rl_readstr_cxt *, int); extern void _rl_readstr_restore (_rl_readstr_cxt *); extern int _rl_readstr_getchar (_rl_readstr_cxt *); extern int _rl_readstr_dispatch (_rl_readstr_cxt *, int); diff --git a/search.c b/search.c index 37db052..6b078d7 100644 --- a/search.c +++ b/search.c @@ -286,6 +286,7 @@ _rl_nsearch_init (int dir, int pchar) rl_end = rl_point = 0; p = _rl_make_prompt_for_search (pchar ? pchar : ':'); + cxt->sflags |= SF_FREEPMT; rl_message ("%s", p); xfree (p); @@ -313,13 +314,24 @@ _rl_nsearch_abort (_rl_search_cxt *cxt) _rl_unsave_saved_search_line (); rl_point = cxt->save_point; rl_mark = cxt->save_mark; - rl_restore_prompt (); + if (cxt->sflags & SF_FREEPMT) + rl_restore_prompt (); /* _rl_make_prompt_for_search saved it */ + cxt->sflags &= ~SF_FREEPMT; rl_clear_message (); _rl_fix_point (1); RL_UNSETSTATE (RL_STATE_NSEARCH); } +int +_rl_nsearch_sigcleanup (_rl_search_cxt *cxt, int r) +{ + if (cxt->sflags & SF_FREEPMT) + rl_restore_prompt (); /* _rl_make_prompt_for_search saved it */ + cxt->sflags &= ~SF_FREEPMT; + return (_rl_nsearch_cleanup (cxt, r)); +} + /* Process just-read character C according to search context CXT. Return -1 if the caller should abort the search, 0 if we should break out of the loop, and 1 if we should continue to read characters. */ @@ -427,7 +439,9 @@ _rl_nsearch_dosearch (_rl_search_cxt *cxt) { _rl_free_saved_search_line (); rl_ding (); - rl_restore_prompt (); + if (cxt->sflags & SF_FREEPMT) + rl_restore_prompt (); + cxt->sflags &= ~SF_FREEPMT; RL_UNSETSTATE (RL_STATE_NSEARCH); return -1; } @@ -452,7 +466,9 @@ _rl_nsearch_dosearch (_rl_search_cxt *cxt) #endif } - rl_restore_prompt (); + if (cxt->sflags & SF_FREEPMT) + rl_restore_prompt (); + cxt->sflags &= ~SF_FREEPMT; return (noninc_dosearch (noninc_search_string, cxt->direction, cxt->sflags&SF_PATTERN)); } diff --git a/signals.c b/signals.c index 51d7468..92dd2ff 100644 --- a/signals.c +++ b/signals.c @@ -585,6 +585,19 @@ rl_reset_after_signal (void) rl_set_signals (); } +/* Similar to rl_callback_sigcleanup, but cleans up operations that allocate + state even when not in callback mode. */ +void +_rl_state_sigcleanup (void) +{ + if (RL_ISSTATE (RL_STATE_ISEARCH)) /* incremental search */ + _rl_isearch_cleanup (_rl_iscxt, 0); + else if (RL_ISSTATE (RL_STATE_NSEARCH)) /* non-incremental search */ + _rl_nsearch_sigcleanup (_rl_nscxt, 0); + else if (RL_ISSTATE (RL_STATE_READSTR)) /* reading a string */ + _rl_readstr_sigcleanup (_rl_rscxt, 0); +} + /* Free up the readline variable line state for the current line (undo list, any partial history entry, any keyboard macros in progress, and any numeric arguments in process) after catching a signal, before calling @@ -594,6 +607,9 @@ rl_free_line_state (void) { register HIST_ENTRY *entry; + if (RL_ISSTATE (RL_STATE_CALLBACK) == 0) + _rl_state_sigcleanup (); + rl_free_undo_list (); entry = current_history (); diff --git a/text.c b/text.c index 25e8484..e8bf450 100644 --- a/text.c +++ b/text.c @@ -1971,10 +1971,13 @@ _rl_rscxt_dispose (_rl_readstr_cxt *cxt, int flags) xfree (cxt); } +/* This isn't used yet */ void _rl_free_saved_readstr_line () { if (_rl_saved_line_for_readstr) + /* This doesn't free any saved undo list, if it needs to, + rl_clear_history shows how to do it. */ _rl_free_saved_line (_rl_saved_line_for_readstr); _rl_saved_line_for_readstr = (HIST_ENTRY *)NULL; } @@ -1983,7 +1986,10 @@ void _rl_unsave_saved_readstr_line () { if (_rl_saved_line_for_readstr) - _rl_unsave_line (_rl_saved_line_for_readstr); + { + _rl_free_undo_list (rl_undo_list); + _rl_unsave_line (_rl_saved_line_for_readstr); /* restores rl_undo_list */ + } _rl_saved_line_for_readstr = (HIST_ENTRY *)NULL; } @@ -2004,9 +2010,12 @@ _rl_readstr_init (int pchar, int flags) rl_end = rl_point = 0; p = _rl_make_prompt_for_search (pchar ? pchar : '@'); + cxt->flags |= READSTR_FREEPMT; rl_message ("%s", p); xfree (p); + RL_SETSTATE (RL_STATE_READSTR); + _rl_rscxt = cxt; return cxt; @@ -2018,6 +2027,8 @@ _rl_readstr_cleanup (_rl_readstr_cxt *cxt, int r) _rl_rscxt_dispose (cxt, 0); _rl_rscxt = 0; + RL_UNSETSTATE (RL_STATE_READSTR); + return (r != 1); } @@ -2027,11 +2038,22 @@ _rl_readstr_restore (_rl_readstr_cxt *cxt) _rl_unsave_saved_readstr_line (); /* restores rl_undo_list */ rl_point = cxt->save_point; rl_mark = cxt->save_mark; - rl_restore_prompt (); /* _rl_make_prompt_for_search saved it */ + if (cxt->flags & READSTR_FREEPMT) + rl_restore_prompt (); /* _rl_make_prompt_for_search saved it */ + cxt->flags &= ~READSTR_FREEPMT; rl_clear_message (); _rl_fix_point (1); } +int +_rl_readstr_sigcleanup (_rl_readstr_cxt *cxt, int r) +{ + if (cxt->flags & READSTR_FREEPMT) + rl_restore_prompt (); /* _rl_make_prompt_for_search saved it */ + cxt->flags &= ~READSTR_FREEPMT; + return (_rl_readstr_cleanup (cxt, r)); +} + int _rl_readstr_getchar (_rl_readstr_cxt *cxt) { @@ -2130,7 +2152,7 @@ _rl_readstr_dispatch (_rl_readstr_cxt *cxt, int c) break; case ' ': - if ((cxt->flags & RL_READSTR_NOSPACE) == 0) + if ((cxt->flags & READSTR_NOSPACE) == 0) { _rl_insert_char (1, c); break; @@ -2273,7 +2295,7 @@ _rl_read_command_name () char *ret; int c, r; - cxt = _rl_readstr_init ('!', RL_READSTR_NOSPACE); + cxt = _rl_readstr_init ('!', READSTR_NOSPACE); cxt->compfunc = _rl_readcmd_complete; /* skip callback stuff for now */ @@ -2344,5 +2366,6 @@ rl_execute_named_command (int count, int key) r = 1; } + free (command); return r; }