diff options
Diffstat (limited to 'doc/readline.0')
| -rw-r--r-- | doc/readline.0 | 66 |
1 files changed, 44 insertions, 22 deletions
diff --git a/doc/readline.0 b/doc/readline.0 index cdc125b..a09722e 100644 --- a/doc/readline.0 +++ b/doc/readline.0 @@ -14,7 +14,7 @@ SSYYNNOOPPSSIISS rreeaaddlliinnee (_c_o_n_s_t _c_h_a_r _*_p_r_o_m_p_t); CCOOPPYYRRIIGGHHTT - Readline is Copyright (C) 1989-2009 Free Software Foundation, Inc. + Readline is Copyright (C) 1989-2011 Free Software Foundation, Inc. DDEESSCCRRIIPPTTIIOONN rreeaaddlliinnee will read a line from the terminal and return it, using pprroommpptt @@ -38,7 +38,7 @@ RREETTUURRNN VVAALLUUEE it is treated as a newline. NNOOTTAATTIIOONN - An emacs-style notation is used to denote keystrokes. Control keys are + An Emacs-style notation is used to denote keystrokes. Control keys are 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 @@ -187,9 +187,19 @@ IINNIITTIIAALLIIZZAATTIIOONN FFIILLEE 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. ccoommpplleettiioonn--iiggnnoorree--ccaassee ((OOffff)) If set to OOnn, readline performs filename matching and completion in a case-insensitive fashion. + 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. 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 @@ -216,7 +226,7 @@ IINNIITTIIAALLIIZZAATTIIOONN FFIILLEE mapped to sseellff--iinnsseerrtt. eeddiittiinngg--mmooddee ((eemmaaccss)) Controls whether readline begins with a set of key bindings sim- - ilar to emacs or vi. eeddiittiinngg--mmooddee can be set to either eemmaaccss or + ilar to _E_m_a_c_s or _v_i. eeddiittiinngg--mmooddee can be set to either eemmaaccss or vvii. eecchhoo--ccoonnttrrooll--cchhaarraacctteerrss ((OOnn)) When set to OOnn, on operating systems that indicate they support @@ -231,10 +241,10 @@ IINNIITTIIAALLIIZZAATTIIOONN FFIILLEE key the terminal claims to support when it is called. On many terminals, the meta key is used to send eight-bit characters. eexxppaanndd--ttiillddee ((OOffff)) - If set to oonn, tilde expansion is performed when readline + If set to OOnn, tilde expansion is performed when readline attempts word completion. hhiissttoorryy--pprreesseerrvvee--ppooiinntt ((OOffff)) - If set to oonn, the history code attempts to place point at the + 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 ((00)) @@ -275,8 +285,12 @@ IINNIITTIIAALLIIZZAATTIIOONN FFIILLEE 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, unless the leading `.' is supplied by the - user in the filename to be completed. + filename completion. If set to OOffff, the leading `.' must be + supplied by the user in the filename to be completed. + 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. 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. @@ -288,18 +302,18 @@ IINNIITTIIAALLIIZZAATTIIOONN FFIILLEE sorted horizontally in alphabetical order, rather than down the screen. rreevveerrtt--aallll--aatt--nneewwlliinnee ((OOffff)) - If set to oonn, readline will undo all changes to history lines + 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 rreeaaddlliinnee. 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 + If set to OOnn, words which have more than one possible completion cause the matches to be listed immediately instead of ringing the bell. 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 + 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 @@ -350,7 +364,7 @@ IINNIITTIIAALLIIZZAATTIIOONN FFIILLEE 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: + bbaasshh: $$iiff Bash # Quote the current or previous word @@ -484,12 +498,16 @@ EEDDIITTIINNGG CCOOMMMMAANNDDSS "!_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 an argument, behave + of the previous history entry). With a numeric argument, behave exactly like yyaannkk--nntthh--aarrgg. Successive calls to yyaannkk--llaasstt--aarrgg - move back through the history list, inserting the last argument - of each line in turn. The history expansion facilities are used - to extract the last argument, as if the "!$" history expansion - had been specified. + 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 + (back or forward). The history expansion facilities are used to + extract the last argument, as if the "!$" history expansion had + been specified. CCoommmmaannddss ffoorr CChhaannggiinngg TTeexxtt ddeelleettee--cchhaarr ((CC--dd)) @@ -612,7 +630,11 @@ EEDDIITTIINNGG CCOOMMMMAANNDDSS hand, allows completion of program functions and variables, and only attempts filename completion under certain circumstances. ppoossssiibbllee--ccoommpplleettiioonnss ((MM--??)) - List the possible completions of the text before point. + 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 ccoommpplleettiioonn--ddiissppllaayy--wwiiddtthh, the value + of the environment variable CCOOLLUUMMNNSS, or the screen width, in + that order. iinnsseerrtt--ccoommpplleettiioonnss ((MM--**)) Insert all completions of the text before point that would have been generated by ppoossssiibbllee--ccoommpplleettiioonnss. @@ -626,9 +648,9 @@ EEDDIITTIINNGG CCOOMMMMAANNDDSS moves _n positions forward in the list of matches; a negative argument may be used to move backward through the list. This command is intended to be bound to TTAABB, but is unbound by - default.cc - mmeennuu--ccoommpplleettee--kkrrdd - Identicwwal to mmeennuu--ccoommpplleettee, but moves backward through the list + 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. ddeelleettee--cchhaarr--oorr--lliisstt @@ -682,7 +704,7 @@ EEDDIITTIINNGG CCOOMMMMAANNDDSS A character is read and point is moved to the previous occur- rence of that character. A negative count searches for subse- quent occurrences. - sskkiipp--ccssii--sseeqquueennccee (()) + 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 @@ -967,4 +989,4 @@ BBUUGGSS -GNU Readline 6.1 2009 October 9 READLINE(3) +GNU Readline 6.2 2010 August 28 READLINE(3) |