summaryrefslogtreecommitdiff
path: root/doc/readline.0
diff options
context:
space:
mode:
Diffstat (limited to 'doc/readline.0')
-rw-r--r--doc/readline.0788
1 files changed, 394 insertions, 394 deletions
diff --git a/doc/readline.0 b/doc/readline.0
index e81db5a..c925d52 100644
--- a/doc/readline.0
+++ b/doc/readline.0
@@ -61,7 +61,7 @@ NNOOTTAATTIIOONN
-GNU 1997 Feb 5 1
+GNU 1998 Feb 19 1
@@ -127,7 +127,7 @@ IINNIITTIIAALLIIZZAATTIIOONN FFIILLEE
-GNU 1997 Feb 5 2
+GNU 1998 Feb 19 2
@@ -149,67 +149,83 @@ READLINE(3) READLINE(3)
In this example, _C_-_u is again bound to the function uunnii--
vveerrssaall--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 FFuunnccttiioonn KKeeyy 11. The full set of escape sequences is
-
+ text FFuunnccttiioonn KKeeyy 11. The full set of GNU Emacs style
+ escape sequences is
\\CC-- control prefix
-
\\MM-- meta prefix
-
\\ee an escape character
-
\\\\ backslash
-
\\"" literal "
-
\\'' literal '
+ In addition to the GNU Emacs style escape sequences, a
+ second set of backslash escapes is available:
+ \\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 character whose ASCII code is the octal
+ value _n_n_n (one to three digits)
+ \\xx_n_n_n the character whose ASCII code is the hex-
+ adecimal value _n_n_n (one to three 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. Backslash will
- quote any character in the macro text, including " and '.
-
- BBaasshh allows the current readline key bindings to be dis-
- played or modified with the bbiinndd builtin command. The
- editing mode may be switched during interactive use by
- using the --oo option to the sseett builtin command. 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 provide any other means to incorporate new bind-
+ text is assumed to be a function name. In the macro body,
+ the backslash escapes described above are expanded. Back-
+ slash will quote any other character in the macro text,
+ including " and '.
+
+ BBaasshh allows the current readline key bindings to be dis-
+ played or modified with the bbiinndd builtin command. The
+ editing mode may be switched during interactive use by
+ using the --oo option to the sseett builtin command. 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 provide any other means to incorporate new bind-
ings.
- VVaarriiaabblleess
- Readline has variables that can be used to further cus-
- tomize its behavior. A variable may be set in the _i_n_p_u_t_r_c
- file with a statement of the form
- 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
- OOnn or OOffff. The variables and their default values are:
- bbeellll--ssttyyllee ((aauuddiibbllee))
- Controls what happens when readline wants to ring
- the terminal bell. If set to nnoonnee, readline never
+GNU 1998 Feb 19 3
-GNU 1997 Feb 5 3
+READLINE(3) READLINE(3)
-READLINE(3) READLINE(3)
+ VVaarriiaabblleess
+ Readline has variables that can be used to further cus-
+ tomize its behavior. A variable may be set in the _i_n_p_u_t_r_c
+ file with a statement of the form
+ 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
+ OOnn or OOffff. The variables and their default values are:
+
+ 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 aauuddii--
+ visible bell if one is available. If set to aauuddii--
bbllee, readline attempts to ring the terminal's bell.
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 com-
+ 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 com-
mand mode.
+ ccoommpplleettiioonn--iiggnnoorree--ccaassee ((OOffff))
+ If set to OOnn, readline performs filename matching
+ and completion in a case-insensitive fashion.
ccoommpplleettiioonn--qquueerryy--iitteemmss ((110000))
This determines when the user is queried about
viewing the number of possible completions gener-
@@ -240,6 +256,18 @@ READLINE(3) READLINE(3)
need this to enable the arrow keys.
eexxppaanndd--ttiillddee ((OOffff))
If set to oonn, tilde expansion is performed when
+
+
+
+GNU 1998 Feb 19 4
+
+
+
+
+
+READLINE(3) READLINE(3)
+
+
readline attempts word completion.
hhoorriizzoonnttaall--ssccrroollll--mmooddee ((OOffff))
When set to OOnn, makes readline use a single line
@@ -255,19 +283,7 @@ READLINE(3) READLINE(3)
value of eeddiittiinngg--mmooddee also affects the default
keymap.
mmaarrkk--ddiirreeccttoorriieess ((OOnn))
- If set to OOnn, completed directory names have a
-
-
-
-GNU 1997 Feb 5 4
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
+ If set to OOnn, complete<d directory names have a
slash appended.
mmaarrkk--mmooddiiffiieedd--lliinneess ((OOffff))
If set to OOnn, history lines that have been modified
@@ -281,6 +297,10 @@ READLINE(3) READLINE(3)
If set to OOnn, readline will display characters with
the eighth bit set directly rather than as a meta-
prefixed escape sequence.
+ pprriinntt--ccoommpplleettiioonnss--hhoorriizzoonnttaallllyy ((OOffff))
+ If set to OOnn, readline will display completions
+ with matches sorted horizontally in alphabetical
+ order, rather than down the screen.
sshhooww--aallll--iiff--aammbbiigguuoouuss ((OOffff))
This alters the default behavior of the completion
functions. If set to oonn, words which have more
@@ -295,13 +315,25 @@ READLINE(3) READLINE(3)
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 per-
- formed as the result of tests. There are three parser
+ formed as the result of tests. There are four parser
directives used.
$$iiff The $$iiff construct allows bindings to be made based
on the editing mode, the terminal being used, or
the application using readline. The text of the
test extends to the end of the line; no characters
+
+
+
+GNU 1998 Feb 19 5
+
+
+
+
+
+READLINE(3) READLINE(3)
+
+
are required to isolate it.
mmooddee The mmooddee== form of the $$iiff directive is used
@@ -321,19 +353,6 @@ READLINE(3) READLINE(3)
name before the first --. This allows _s_u_n to
match both _s_u_n and _s_u_n_-_c_m_d, for instance.
-
-
-
-
-GNU 1997 Feb 5 5
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
aapppplliiccaattiioonn
The aapppplliiccaattiioonn construct is used to include
application-specific settings. Each program
@@ -345,64 +364,72 @@ READLINE(3) READLINE(3)
the following command adds a key sequence
that quotes the current or previous word in
Bash:
+
$$iiff bash
# Quote the current or previous word
"\C-xq": "\eb\"\ef\""
$$eennddiiff
- $$eennddiiff This command, as you saw in the previous example,
- terminates an $$iiff command.
+ $$eennddiiff This command, as seen in the previous example, ter-
+ minates an $$iiff command.
$$eellssee Commands in this branch of the $$iiff directive are
executed if the test fails.
-SSEEAARRCCHHIINNGG
- Readline provides commands for searching through the com-
- mand 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.
+ $$iinncclluuddee
+ This directive takes a single filename as an argu-
+ ment and reads commands and bindings from that
+ file. For example, the following directive would
+ read _/_e_t_c_/_i_n_p_u_t_r_c:
- Incremental searches begin before the user has finished
- typing the search string. As each character of the search
- string is typed, readline 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. The Escape character is used
- to terminate an incremental search. Control-J will also
- terminate the search. Control-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 current line. To find other matching entries
- in the history list, type Control-S or Control-R as appro-
- priate. This will search backward or forward in the his-
- tory 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 execute that command. For
- instance, a _n_e_w_l_i_n_e will terminate the search and accept
- the line, thereby executing the command from the history
- list.
+ $$iinncclluuddee _/_e_t_c_/_i_n_p_u_t_r_c
- 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 part of the con-
- tents of the current line.
+SSEEAARRCCHHIINNGG
+ Readline provides commands for searching through the com-
+ mand 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_-
+GNU 1998 Feb 19 6
-GNU 1997 Feb 5 6
+READLINE(3) READLINE(3)
-READLINE(3) READLINE(3)
+ _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, readline 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. The Escape character is used
+ to terminate an incremental search. Control-J will also
+ terminate the search. Control-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 current line. To find other matching entries
+ in the history list, type Control-S or Control-R as appro-
+ priate. This will search backward or forward in the his-
+ tory 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 execute that command. For
+ instance, a _n_e_w_l_i_n_e will terminate the search and accept
+ the line, thereby executing the command from the history
+ list.
+
+ 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.
EEDDIITTIINNGG CCOOMMMMAANNDDSS
- The following is a list of the names of the commands and
- the default key sequences to which they are bound. Com-
+ The following is a list of the names of the commands and
+ the default key sequences to which they are bound. Com-
mand names without an accompanying key sequence are
unbound by default.
@@ -416,312 +443,351 @@ EEDDIITTIINNGG CCOOMMMMAANNDDSS
bbaacckkwwaarrdd--cchhaarr ((CC--bb))
Move back a character.
ffoorrwwaarrdd--wwoorrdd ((MM--ff))
- Move forward to the end of the next word. Words
- are composed of alphanumeric characters (letters
+ Move forward to the end of the next word. Words
+ are composed of alphanumeric characters (letters
and digits).
bbaacckkwwaarrdd--wwoorrdd ((MM--bb))
- Move back to the start of this, or the previous,
- word. Words are composed of alphanumeric charac-
+ Move back to the start of this, or the previous,
+ word. Words are composed of alphanumeric charac-
ters (letters and digits).
cclleeaarr--ssccrreeeenn ((CC--ll))
- Clear the screen leaving the current line at the
- top of the screen. With an argument, refresh the
+ Clear the screen leaving the current line at the
+ top of the screen. With an argument, refresh the
current line without clearing the screen.
+
+
+
+GNU 1998 Feb 19 7
+
+
+
+
+
+READLINE(3) READLINE(3)
+
+
rreeddrraaww--ccuurrrreenntt--lliinnee
Refresh the current line.
CCoommmmaannddss ffoorr MMaanniippuullaattiinngg tthhee HHiissttoorryy
aacccceepptt--lliinnee ((NNeewwlliinnee,, RReettuurrnn))
- Accept the line regardless of where the cursor is.
- If this line is non-empty, add it to the history
- list. If the line is a modified history line, then
+ Accept the line regardless of where the cursor is.
+ If this line is non-empty, add it to the history
+ list. If the line is a modified history line, then
restore the history line to its original state.
pprreevviioouuss--hhiissttoorryy ((CC--pp))
- Fetch the previous command from the history list,
+ Fetch the previous command from the history list,
moving back in the list.
nneexxtt--hhiissttoorryy ((CC--nn))
- Fetch the next command from the history list, mov-
+ Fetch the next command from the history list, mov-
ing forward in the list.
bbeeggiinnnniinngg--ooff--hhiissttoorryy ((MM--<<))
Move to the first line in the history.
eenndd--ooff--hhiissttoorryy ((MM-->>))
- Move to the end of the input history, i.e., the
+ Move to the end of the input history, i.e., the
line currently being entered.
rreevveerrssee--sseeaarrcchh--hhiissttoorryy ((CC--rr))
- Search backward starting at the current line and
+ Search backward starting at the current line and
moving `up' through the history as necessary. This
is an incremental search.
ffoorrwwaarrdd--sseeaarrcchh--hhiissttoorryy ((CC--ss))
- Search forward starting at the current line and
- moving `down' through the history as necessary.
-
-
-
-GNU 1997 Feb 5 7
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
+ Search forward starting at the current line and
+ moving `down' through the history as necessary.
This is an incremental search.
nnoonn--iinnccrreemmeennttaall--rreevveerrssee--sseeaarrcchh--hhiissttoorryy ((MM--pp))
Search backward through the history starting at the
- current line using a non-incremental search for a
+ current line using a non-incremental search for a
string supplied by the user.
nnoonn--iinnccrreemmeennttaall--ffoorrwwaarrdd--sseeaarrcchh--hhiissttoorryy ((MM--nn))
- Search forward through the history using a non-
- incremental search for a string supplied by the
+ Search forward through the history using a non-
+ incremental search for a string supplied by the
user.
hhiissttoorryy--sseeaarrcchh--ffoorrwwaarrdd
- Search forward through the history for the string
+ Search forward through the history for the string
of characters between the start of the current line
- and the current cursor position (the _p_o_i_n_t). This
+ and the current cursor position (the _p_o_i_n_t). This
is a non-incremental search.
hhiissttoorryy--sseeaarrcchh--bbaacckkwwaarrdd
- Search backward through the history for the string
+ Search backward through the history for the string
of characters between the start of the current line
and the point. This is a non-incremental search.
yyaannkk--nntthh--aarrgg ((MM--CC--yy))
- Insert the first argument to the previous command
- (usually the second word on the previous line) at
+ Insert the first argument to the previous command
+ (usually the second word on the previous line) at
point (the current cursor position). With an argu-
- ment _n, insert the _nth word from the previous com-
- mand (the words in the previous command begin with
- word 0). A negative argument inserts the _nth word
+ ment _n, insert the _nth word from the previous com-
+ mand (the words in the previous command begin with
+ word 0). A negative argument inserts the _nth word
from the end of the previous command.
+
+
+
+
+GNU 1998 Feb 19 8
+
+
+
+
+
+READLINE(3) READLINE(3)
+
+
yyaannkk--llaasstt--aarrgg ((MM--..,, MM--__))
- Insert the last argument to the previous command
- (the last word of the previous history entry).
+ Insert the last argument to the previous command
+ (the last word of the previous history entry).
With an 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.
CCoommmmaannddss ffoorr CChhaannggiinngg TTeexxtt
ddeelleettee--cchhaarr ((CC--dd))
Delete the character under the cursor. If point is
- at the beginning of the line, there are no charac-
- ters in the line, and the last character typed was
- not CC--dd, then return EEOOFF.
+ at the beginning of the line, there are no charac-
+ ters in the line, and the last character typed was
+ not bound to BBddeelleettee--cchhaarr, then return EEOOFF.
bbaacckkwwaarrdd--ddeelleettee--cchhaarr ((RRuubboouutt))
Delete the character behind the cursor. When given
- a numeric argument, save the deleted text on the
+ a numeric argument, save the deleted text on the
kill ring.
qquuootteedd--iinnsseerrtt ((CC--qq,, CC--vv))
- Add the next character that you type to the line
- verbatim. This is how to insert characters like
+ Add the next character that you type to the line
+ verbatim. This is how to insert characters like
CC--qq, for example.
ttaabb--iinnsseerrtt ((MM--TTAABB))
Insert a tab character.
sseellff--iinnsseerrtt ((aa,, bb,, AA,, 11,, !!,, ......))
Insert the character typed.
ttrraannssppoossee--cchhaarrss ((CC--tt))
- Drag the character before point forward over the
- character at point. Point moves forward as well.
- If point is at the end of the line, then transpose
- the two characters before point. Negative
+ Drag the character before point forward over the
+ character at point. Point moves forward as well.
+ If point is at the end of the line, then transpose
+ the two characters before point. Negative argu-
+ ments don't work.
+ ttrraannssppoossee--wwoorrddss ((MM--tt))
+ Drag the word behind the cursor past the word in
+ front of the cursor moving the cursor over that
+ word as well.
+ uuppccaassee--wwoorrdd ((MM--uu))
+ Uppercase the current (or following) word. With a
+ negative argument, uppercase the previous word, but
+ do not move point.
+ ddoowwnnccaassee--wwoorrdd ((MM--ll))
+ Lowercase the current (or following) word. With a
+ negative argument, lowercase the previous word, but
+ do not move point.
+ ccaappiittaalliizzee--wwoorrdd ((MM--cc))
+ Capitalize the current (or following) word. With a
+ negative argument, capitalize the previous word,
+ but do not move point.
+ KKiilllliinngg aanndd YYaannkkiinngg
+ kkiillll--lliinnee ((CC--kk))
+ Kill the text from the current cursor position to
+ the end of the line.
-GNU 1997 Feb 5 8
+GNU 1998 Feb 19 9
-READLINE(3) READLINE(3)
- arguments don't work.
- ttrraannssppoossee--wwoorrddss ((MM--tt))
- Drag the word behind the cursor past the word in
- front of the cursor moving the cursor over that
- word as well.
- uuppccaassee--wwoorrdd ((MM--uu))
- Uppercase the current (or following) word. With a
- negative argument, do the previous word, but do not
- move point.
- ddoowwnnccaassee--wwoorrdd ((MM--ll))
- Lowercase the current (or following) word. With a
- negative argument, do the previous word, but do not
- move point.
- ccaappiittaalliizzee--wwoorrdd ((MM--cc))
- Capitalize the current (or following) word. With a
- negative argument, do the previous word, but do not
- move point.
+READLINE(3) READLINE(3)
+
- KKiilllliinngg aanndd YYaannkkiinngg
- kkiillll--lliinnee ((CC--kk))
- Kill the text from the current cursor position to
- the end of the line.
bbaacckkwwaarrdd--kkiillll--lliinnee ((CC--xx RRuubboouutt))
Kill backward to the beginning of the line.
uunniixx--lliinnee--ddiissccaarrdd ((CC--uu))
- Kill backward from point to the beginning of the
- line.
+ Kill backward from point to the beginning of the
+ line. The killed text is saved on the kill-ring.
kkiillll--wwhhoollee--lliinnee
- Kill all characters on the current line, no matter
+ Kill all characters on the current line, no matter
where the cursor is.
kkiillll--wwoorrdd ((MM--dd))
- Kill from the cursor to 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
+ Kill from the cursor to 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 the cursor. Word boundaries
+ Kill the word behind the cursor. Word boundaries
are the same as those used by bbaacckkwwaarrdd--wwoorrdd.
uunniixx--wwoorrdd--rruubboouutt ((CC--ww))
- Kill the word behind the cursor, using white space
- as a word boundary. The word boundaries are dif-
+ Kill the word behind the cursor, using white space
+ as a word boundary. The word boundaries are dif-
ferent from bbaacckkwwaarrdd--kkiillll--wwoorrdd.
ddeelleettee--hhoorriizzoonnttaall--ssppaaccee ((MM--\\))
Delete all spaces and tabs around point.
kkiillll--rreeggiioonn
- Kill the text between the point and _m_a_r_k (saved
- cursor position). This text is referred to as the
+ Kill the text between the point and _m_a_r_k (saved
+ cursor position). 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.
ccooppyy--bbaacckkwwaarrdd--wwoorrdd
- Copy the word before point to the kill buffer.
+ Copy the word before point to the kill buffer. The
+ word boundaries are the same as bbaacckkwwaarrdd--wwoorrdd.
ccooppyy--ffoorrwwaarrdd--wwoorrdd
- Copy the word following point to the kill buffer.
-
-
-
-GNU 1997 Feb 5 9
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
+ 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
+ Yank the top of the kill ring into the buffer at
the cursor.
yyaannkk--ppoopp ((MM--yy))
- Rotate the kill ring, and yank the new top. Only
+ Rotate the kill ring, and yank the new top. Only
works following yyaannkk or yyaannkk--ppoopp.
NNuummeerriicc AArrgguummeennttss
ddiiggiitt--aarrgguummeenntt ((MM--00,, MM--11,, ......,, MM----))
- Add this digit to the argument already accumulat-
- ing, or start a new argument. M-- starts a nega-
+ Add this digit to the argument already accumulat-
+ ing, or start a new argument. M-- starts a nega-
tive argument.
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
+ This is another way to specify an argument. If
+ this command is followed by one or more digits,
+ optionally with a leading minus sign, those digits
define the argument. If the command is followed by
digits, executing uunniivveerrssaall--aarrgguummeenntt again ends the
- numeric argument, but is otherwise ignored. As a
- special case, if this command is immediately fol-
- lowed by a character that is neither a digit or
+ numeric argument, but is otherwise ignored. As a
+ special case, if this command is immediately
+
+
+
+GNU 1998 Feb 19 10
+
+
+
+
+
+READLINE(3) READLINE(3)
+
+
+ followed by a character that is neither a digit or
minus sign, the argument count for the next command
- is multiplied by four. The argument count is ini-
- tially one, so executing this function the first
- time makes the argument count four, a second time
+ is multiplied by four. The argument count is ini-
+ tially one, so executing this function the first
+ time makes the argument count four, a second time
makes the argument count sixteen, and so on.
CCoommpplleettiinngg
ccoommpplleettee ((TTAABB))
- Attempt to perform completion on the text before
+ Attempt to perform completion on the text before
point. The actual completion performed is applica-
- tion-specific. BBaasshh, for instance, attempts com-
- pletion 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.
+ tion-specific. BBaasshh, for instance, attempts com-
+ pletion 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 comple-
- tion is attempted. GGddbb, on the other hand, allows
- completion of program functions and variables, and
- only attempts filename completion under certain
+ tion is attempted. GGddbb, on the other 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
+ List the possible completions of the text before
point.
iinnsseerrtt--ccoommpplleettiioonnss ((MM--**))
- Insert all completions of the text before point
- that would have been generated by ppoossssiibbllee--ccoommppllee--
+ Insert all completions of the text before point
+ that would have been generated by ppoossssiibbllee--ccoommppllee--
ttiioonnss.
+ mmeennuu--ccoommpplleettee
+ Similar to ccoommpplleettee, but replaces the word to be
+ completed with a single match from the list of pos-
+ sible completions. Repeated execution of mmeennuu--ccoomm--
+ pplleettee steps through the list of possible comple-
+ tions, inserting each match in turn. At the end of
+ the list of completions, the bell is rung and the
+ original text is restored. An argument of _n moves
+ _n positions forward in the list of matches; a nega-
+ tive argument may be used to move backward through
+ the list. This command is intended to be bound to
+ TTAABB, but is unbound by default.
KKeeyybbooaarrdd MMaaccrrooss
ssttaarrtt--kkbbdd--mmaaccrroo ((CC--xx (())
- Begin saving the characters typed into the current
+ Begin saving the characters typed into the current
keyboard macro.
+ eenndd--kkbbdd--mmaaccrroo ((CC--xx ))))
+ Stop saving the characters typed into the current
+ keyboard macro and store the definition.
+ ccaallll--llaasstt--kkbbdd--mmaaccrroo ((CC--xx ee))
+ Re-execute the last keyboard macro defined, by mak-
+ ing the characters in the macro appear as if typed
+ at the keyboard.
-GNU 1997 Feb 5 10
+GNU 1998 Feb 19 11
-READLINE(3) READLINE(3)
+READLINE(3) READLINE(3)
- eenndd--kkbbdd--mmaaccrroo ((CC--xx ))))
- Stop saving the characters typed into the current
- keyboard macro and store the definition.
- ccaallll--llaasstt--kkbbdd--mmaaccrroo ((CC--xx ee))
- Re-execute the last keyboard macro defined, by mak-
- ing the characters in the macro appear as if typed
- at the keyboard.
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
+ Read in the contents of the _i_n_p_u_t_r_c file, and
+ incorporate any bindings or variable assignments
found there.
aabboorrtt ((CC--gg))
Abort the current editing command and ring the ter-
minal's bell (subject to the setting of
bbeellll--ssttyyllee).
ddoo--uuppppeerrccaassee--vveerrssiioonn ((MM--aa,, MM--bb,, MM--_x,, ......))
- If the metafied character _x is lowercase, run the
- command that is bound to the corresponding upper-
+ If the metafied character _x is lowercase, run the
+ command that is bound to the corresponding upper-
case character.
pprreeffiixx--mmeettaa ((EESSCC))
- Metafy the next character typed. EESSCC ff is equiva-
+ Metafy the next character typed. EESSCC ff is equiva-
lent to MMeettaa--ff.
uunnddoo ((CC--__,, CC--xx CC--uu))
- Incremental undo, separately remembered for each
+ Incremental undo, separately remembered for each
line.
rreevveerrtt--lliinnee ((MM--rr))
- Undo all changes made to this line. This is like
- typing the uunnddoo command enough times to return the
- line to its initial state.
+ Undo all changes made to this line. This is like
+ executing the uunnddoo command enough times to return
+ the line to its initial state.
ttiillddee--eexxppaanndd ((MM--~~))
Perform tilde expansion on the current word.
sseett--mmaarrkk ((CC--@@,, MM--<<ssppaaccee>>))
- Set the mark to the current point. If a numeric
+ Set the mark to the current point. If a numeric
argument is supplied, the mark is set to that posi-
tion.
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
+ 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.
cchhaarraacctteerr--sseeaarrcchh ((CC--]]))
- A character is read and point is moved to the next
- occurrence of that character. A negative count
+ A character is read and point is moved to the next
+ occurrence of that character. A negative count
searches for previous occurrences.
cchhaarraacctteerr--sseeaarrcchh--bbaacckkwwaarrdd ((MM--CC--]]))
- A character is read and point is moved to the pre-
- vious occurrence of that character. A negative
+ A character is read and point is moved to the pre-
+ vious occurrence of that character. A negative
count searches for subsequent occurrences.
iinnsseerrtt--ccoommmmeenntt ((MM--##))
The value of the readline ccoommmmeenntt--bbeeggiinn variable is
- inserted at the beginning of the current line, and
- the line is accepted as if a newline had been
- typed. This makes the current line a shell
+ inserted at the beginning of the current line, and
+ the line is accepted as if a newline had been
+ typed. This makes the current line a shell com-
+ ment.
+ dduummpp--ffuunnccttiioonnss
+ Print all of the functions and their key bindings
+ to the readline output stream. If a numeric argu-
+ ment is supplied, the output 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
-GNU 1997 Feb 5 11
+GNU 1998 Feb 19 12
@@ -730,72 +796,44 @@ GNU 1997 Feb 5 11
READLINE(3) READLINE(3)
- comment.
- gglloobb--eexxppaanndd--wwoorrdd ((CC--xx **))
- The word before point is treated as a pattern for
- pathname expansion, and the list of matching file
- names is inserted, replacing the word.
- gglloobb--lliisstt--eexxppaannssiioonnss ((CC--xx gg))
- The list of expansions that would have been gener-
- ated by gglloobb--eexxppaanndd--wwoorrdd is inserted into the line,
- replacing the word before point.
- dduummpp--ffuunnccttiioonnss
- Print all of the functions and their key bindings
- to the readline output stream. If a numeric argu-
- ment is supplied, the output 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 val-
- ues 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 _i_n_p_u_t_r_c
+ 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 _i_n_p_u_t_r_c
file.
dduummpp--mmaaccrrooss
- Print all of the readline key sequences bound to
- macros and the strings they ouput. If a numeric
- argument is supplied, the output is formatted in
- such a way that it can be made part of an _i_n_p_u_t_r_c
+ Print all of the readline key sequences bound to
+ macros and the strings they ouput. If a numeric
+ argument is supplied, the output is formatted in
+ such a way that it can be made part of an _i_n_p_u_t_r_c
file.
eemmaaccss--eeddiittiinngg--mmooddee ((CC--ee))
- When in vvii editing mode, this causes a switch to
+ When in vvii editing mode, this causes a switch to
eemmaaccss editing mode.
vvii--eeddiittiinngg--mmooddee ((MM--CC--jj))
When in eemmaaccss editing mode, this causes a switch to
vvii editing mode.
DDEEFFAAUULLTT KKEEYY BBIINNDDIINNGGSS
- The following is a list of the default emacs and vi bind-
- ings. Characters with the 8th bit set are written as
+ The following is a list of the default emacs and vi bind-
+ ings. Characters with the 8th bit set are written as
M-<character>, and are referred 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 _s_e_l_f_-_i_n_s_e_r_t
- function, which just inserts the given character into the
- input line. In vi insertion mode, all characters not
- specifically mentioned are bound to _s_e_l_f_-_i_n_s_e_r_t. Charac-
- ters assigned to signal generation by _s_t_t_y(1) or the ter-
- minal driver, such as C-Z or C-C, retain that function.
- Upper and lower case _m_e_t_a_f_i_e_d characters are bound to the
- same function in the emacs mode meta keymap. The remain-
- ing characters are unbound, which causes readline to ring
- the bell (subject to the setting of the bbeellll--ssttyyllee vari-
+ The printable ASCII characters not mentioned in the list
+ of emacs standard bindings are bound to the _s_e_l_f_-_i_n_s_e_r_t
+ function, which just inserts the given character into the
+ input line. In vi insertion mode, all characters not
+ specifically mentioned are bound to _s_e_l_f_-_i_n_s_e_r_t. Charac-
+ ters assigned to signal generation by _s_t_t_y(1) or the ter-
+ minal driver, such as C-Z or C-C, retain that function.
+ Upper and lower case _m_e_t_a_f_i_e_d characters are bound to the
+ same function in the emacs mode meta keymap. The remain-
+ ing characters are unbound, which causes readline to ring
+ the bell (subject to the setting of the bbeellll--ssttyyllee vari-
able).
EEmmaaccss MMooddee
Emacs Standard bindings
"C-@" set-mark
-
-
-
-GNU 1997 Feb 5 12
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
"C-A" beginning-of-line
"C-B" backward-char
"C-D" delete-char
@@ -812,6 +850,18 @@ READLINE(3) READLINE(3)
"C-P" previous-history
"C-Q" quoted-insert
"C-R" reverse-search-history
+
+
+
+GNU 1998 Feb 19 13
+
+
+
+
+
+READLINE(3) READLINE(3)
+
+
"C-S" forward-search-history
"C-T" transpose-chars
"C-U" unix-line-discard
@@ -850,18 +900,6 @@ READLINE(3) READLINE(3)
"M-5" digit-argument
"M-6" digit-argument
"M-7" digit-argument
-
-
-
-GNU 1997 Feb 5 13
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
"M-8" digit-argument
"M-9" digit-argument
"M-<" beginning-of-history
@@ -878,6 +916,18 @@ READLINE(3) READLINE(3)
"M-R" revert-line
"M-T" transpose-words
"M-U" upcase-word
+
+
+
+GNU 1998 Feb 19 14
+
+
+
+
+
+READLINE(3) READLINE(3)
+
+
"M-Y" yank-pop
"M-\" delete-horizontal-space
"M-~" tilde-expand
@@ -916,18 +966,6 @@ READLINE(3) READLINE(3)
" " to "~" self-insert
"C-?" backward-delete-char
-
-
-
-GNU 1997 Feb 5 14
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
VI Command Mode functions
"C-D" vi-eof-maybe
@@ -944,6 +982,18 @@ READLINE(3) READLINE(3)
"C-R" reverse-search-history
"C-S" forward-search-history
"C-T" transpose-chars
+
+
+
+GNU 1998 Feb 19 15
+
+
+
+
+
+READLINE(3) READLINE(3)
+
+
"C-U" unix-line-discard
"C-V" quoted-insert
"C-W" unix-word-rubout
@@ -982,18 +1032,6 @@ READLINE(3) READLINE(3)
"X" backward-delete-char
"Y" vi-yank-to
"\" vi-complete
-
-
-
-GNU 1997 Feb 5 15
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
"^" vi-first-print
"_" vi-yank-arg
"`" vi-goto-mark
@@ -1010,6 +1048,18 @@ READLINE(3) READLINE(3)
"l" forward-char
"m" vi-set-mark
"n" vi-search-again
+
+
+
+GNU 1998 Feb 19 16
+
+
+
+
+
+READLINE(3) READLINE(3)
+
+
"p" vi-put
"r" vi-change-char
"s" vi-subst
@@ -1038,31 +1088,19 @@ AAUUTTHHOORRSS
chet@ins.CWRU.Edu
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
+ 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 _b_u_g_-_r_e_a_d_l_i_n_e@_p_r_e_p_._a_i_._M_I_T_._E_d_u. 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@_p_r_e_p_._a_i_._M_I_T_._E_d_u or posted to the Usenet newsgroup
-
-
-
-GNU 1997 Feb 5 16
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
+ 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
+ Comments and bug reports concerning this manual page
should be directed to _c_h_e_t_@_i_n_s_._C_W_R_U_._E_d_u.
BBUUGGSS
@@ -1079,44 +1117,6 @@ BBUUGGSS
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-GNU 1997 Feb 5 17
+GNU 1998 Feb 19 17