-
-
-
READLINE(3) READLINE(3)
+
N\bNA\bAM\bME\bE
readline - get a line from a user with editing
S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
#\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<s\bst\btd\bdi\bio\bo.\b.h\bh>\b>
- #\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<r\bre\bea\bad\bdl\bli\bin\bne\be.\b.h\bh>\b>
- #\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<h\bhi\bis\bst\bto\bor\bry\by.\b.h\bh>\b>
+ #\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<r\bre\bea\bad\bdl\bli\bin\bne\be/\b/r\bre\bea\bad\bdl\bli\bin\bne\be.\b.h\bh>\b>
+ #\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<r\bre\bea\bad\bdl\bli\bin\bne\be/\b/h\bhi\bis\bst\bto\bor\bry\by.\b.h\bh>\b>
- c\bch\bha\bar\br *\b*r\bre\bea\bad\bdl\bli\bin\bne\be (\b(p\bpr\bro\bom\bmp\bpt\bt)\b)
- c\bch\bha\bar\br *\b*p\bpr\bro\bom\bmp\bpt\bt;\b;
+ _\bc_\bh_\ba_\br _\b*
+ r\bre\bea\bad\bdl\bli\bin\bne\be (_\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bp_\br_\bo_\bm_\bp_\bt);
C\bCO\bOP\bPY\bYR\bRI\bIG\bGH\bHT\bT
- Readline is Copyright (C) 1989, 1991, 1993, 1995, 1996 by
- the Free Software Foundation, Inc.
+ Readline is Copyright (C) 1989-2002 by the Free Software
+ Foundation, Inc.
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
r\bre\bea\bad\bdl\bli\bin\bne\be will read a line from the terminal and return it,
- using p\bpr\bro\bom\bmp\bpt\bt as a prompt. If p\bpr\bro\bom\bmp\bpt\bt is null, no prompt is
- issued. The line returned is allocated with _\bm_\ba_\bl_\bl_\bo_\bc(3), so
- the caller must free it when finished. The line returned
- has the final newline removed, so only the text of the
- line remains.
+ using p\bpr\bro\bom\bmp\bpt\bt as a prompt. If p\bpr\bro\bom\bmp\bpt\bt is N\bNU\bUL\bLL\bL or the empty
+ string, no prompt is issued. The line returned is allo-
+ cated with _\bm_\ba_\bl_\bl_\bo_\bc(3); the caller must free it when fin-
+ ished. The line returned has the final newline removed,
+ so only the text of the line remains.
r\bre\bea\bad\bdl\bli\bin\bne\be 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
+ r\bre\bea\bad\bdl\bli\bin\bne\be. Much more functionality is available; see _\bT_\bh_\be
+ _\bG_\bN_\bU _\bR_\be_\ba_\bd_\bl_\bi_\bn_\be _\bL_\bi_\bb_\br_\ba_\br_\by and _\bT_\bh_\be _\bG_\bN_\bU _\bH_\bi_\bs_\bt_\bo_\br_\by _\bL_\bi_\bb_\br_\ba_\br_\by for addi-
+ tional information.
+
R\bRE\bET\bTU\bUR\bRN\bN V\bVA\bAL\bLU\bUE\bE
- r\bre\bea\bad\bdl\bli\bin\bne\be returns the text of the line read. A blank line
- returns the empty string. If E\bEO\bOF\bF is encountered while
- reading a line, and the line is empty, N\bNU\bUL\bLL\bL is returned.
- If an E\bEO\bOF\bF is read with a non-empty line, it is treated as
+ r\bre\bea\bad\bdl\bli\bin\bne\be returns the text of the line read. A blank line
+ returns the empty string. If E\bEO\bOF\bF is encountered while
+ reading a line, and the line is empty, N\bNU\bUL\bLL\bL is returned.
+ If an E\bEO\bOF\bF is read with a non-empty line, it is treated as
a newline.
N\bNO\bOT\bTA\bAT\bTI\bIO\bON\bN
- An emacs-style notation is used to denote keystrokes.
- Control keys are denoted by C-_\bk_\be_\by, e.g., C-n means Con-
+ An emacs-style notation is used to denote keystrokes.
+ Control keys are denoted by C-_\bk_\be_\by, e.g., C-n means Con-
trol-N. Similarly, _\bm_\be_\bt_\ba keys are denoted by M-_\bk_\be_\by, so M-x
means Meta-X. (On keyboards without a _\bm_\be_\bt_\ba key, M-_\bx means
- ESC _\bx, i.e., press the Escape key then the _\bx key. This
- makes ESC the _\bm_\be_\bt_\ba _\bp_\br_\be_\bf_\bi_\bx. The combination M-C-_\bx means
- ESC-Control-_\bx, or press the Escape key then hold the Con-
+ ESC _\bx, i.e., press the Escape key then the _\bx key. This
+ makes ESC the _\bm_\be_\bt_\ba _\bp_\br_\be_\bf_\bi_\bx. The combination M-C-_\bx means
+ ESC-Control-_\bx, or press the Escape key then hold the Con-
trol key while pressing the _\bx key.)
- Readline commands may be given numeric _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs, which
+ Readline commands may be given numeric _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs, 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., k\bki\bil\bll\bl-\b-l\bli\bin\bne\be) causes that command to act in
- a backward direction. Commands whose behavior with argu-
+ the sign of the argument that is significant. Passing a
+ negative argument to a command that acts in the forward
+ direction (e.g., k\bki\bil\bll\bl-\b-l\bli\bin\bne\be) causes that command to act in
+ a backward direction. Commands whose behavior with argu-
ments deviates from this are noted.
- When a command is described as _\bk_\bi_\bl_\bl_\bi_\bn_\bg text, the text
-
-
-
-GNU 1998 Dec 31 1
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
- deleted is saved for possible future retrieval (_\by_\ba_\bn_\bk_\bi_\bn_\bg).
- The killed text is saved in a _\bk_\bi_\bl_\bl _\br_\bi_\bn_\bg. Consecutive
- kills cause the text to be accumulated into one unit,
- which can be yanked all at once. Commands which do not
+ When a command is described as _\bk_\bi_\bl_\bl_\bi_\bn_\bg text, the text
+ deleted is saved for possible future retrieval (_\by_\ba_\bn_\bk_\bi_\bn_\bg).
+ The killed text is saved in a _\bk_\bi_\bl_\bl _\br_\bi_\bn_\bg. 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.
I\bIN\bNI\bIT\bTI\bIA\bAL\bLI\bIZ\bZA\bAT\bTI\bIO\bON\bN F\bFI\bIL\bLE\bE
- Readline is customized by putting commands in an initial-
+ Readline is customized by putting commands in an initial-
ization file (the _\bi_\bn_\bp_\bu_\bt_\br_\bc file). The name of this file is
- taken from the value of the I\bIN\bNP\bPU\bUT\bTR\bRC\bC environment variable.
- If that variable is unset, the default is _\b~_\b/_\b._\bi_\bn_\bp_\bu_\bt_\br_\bc.
- When a program which uses the readline library starts up,
- the init file is read, and the key bindings and variables
+ taken from the value of the I\bIN\bNP\bPU\bUT\bTR\bRC\bC environment variable.
+ If that variable is unset, the default is _\b~_\b/_\b._\bi_\bn_\bp_\bu_\bt_\br_\bc.
+ 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
+ the readline init file. Blank lines are ignored. Lines
beginning with a #\b# are comments. Lines beginning with a $\b$
- indicate conditional constructs. Other lines denote key
- bindings and variable settings. Each program using this
+ 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
M-Control-u: universal-argument
or
C-Meta-u: universal-argument
- into the _\bi_\bn_\bp_\bu_\bt_\br_\bc would make M-C-u execute the readline
+
+ into the _\bi_\bn_\bp_\bu_\bt_\br_\bc would make M-C-u execute the readline
command _\bu_\bn_\bi_\bv_\be_\br_\bs_\ba_\bl_\b-_\ba_\br_\bg_\bu_\bm_\be_\bn_\bt.
- The following symbolic character names are recognized
- while processing key bindings: _\bR_\bU_\bB_\bO_\bU_\bT, _\bD_\bE_\bL, _\bE_\bS_\bC, _\bL_\bF_\bD, _\bN_\bE_\bW_\b-
- _\bL_\bI_\bN_\bE, _\bR_\bE_\bT, _\bR_\bE_\bT_\bU_\bR_\bN, _\bS_\bP_\bC, _\bS_\bP_\bA_\bC_\bE, and _\bT_\bA_\bB. In addition to
- command names, readline allows keys to be bound to a
- string that is inserted when the key is pressed (a _\bm_\ba_\bc_\br_\bo).
+ The following symbolic character names are recognized
+ while processing key bindings: _\bD_\bE_\bL, _\bE_\bS_\bC, _\bE_\bS_\bC_\bA_\bP_\bE, _\bL_\bF_\bD, _\bN_\bE_\bW_\b-
+ _\bL_\bI_\bN_\bE, _\bR_\bE_\bT, _\bR_\bE_\bT_\bU_\bR_\bN, _\bR_\bU_\bB_\bO_\bU_\bT, _\bS_\bP_\bA_\bC_\bE, _\bS_\bP_\bC, and _\bT_\bA_\bB.
+
+ In addition to command names, readline allows keys to be
+ bound to a string that is inserted when the key is pressed
+ (a _\bm_\ba_\bc_\br_\bo).
K\bKe\bey\by B\bBi\bin\bnd\bdi\bin\bng\bgs\bs
command or the text of a macro and a key sequence to which
it should be bound. The name may be specified in one of
two ways: as a symbolic key name, possibly with _\bM_\be_\bt_\ba_\b- or
- _\bC_\bo_\bn_\bt_\br_\bo_\bl_\b- prefixes, or as a key sequence. When using the
- form k\bke\bey\byn\bna\bam\bme\be:_\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn_\b-_\bn_\ba_\bm_\be or _\bm_\ba_\bc_\br_\bo, _\bk_\be_\by_\bn_\ba_\bm_\be is the name
- of a key spelled out in English. For example:
+ _\bC_\bo_\bn_\bt_\br_\bo_\bl_\b- prefixes, or as a key sequence.
+
+ When using the form k\bke\bey\byn\bna\bam\bme\be:_\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn_\b-_\bn_\ba_\bm_\be or _\bm_\ba_\bc_\br_\bo, _\bk_\be_\by_\b-
+ _\bn_\ba_\bm_\be is the name of a key spelled out in English. For
+ example:
Control-u: universal-argument
Meta-Rubout: backward-kill-word
- Control-o: ">&output"
+ Control-o: "> output"
In the above example, _\bC_\b-_\bu is bound to the function u\bun\bni\biv\bve\ber\br-\b-
s\bsa\bal\bl-\b-a\bar\brg\bgu\bum\bme\ben\bnt\bt, _\bM_\b-_\bD_\bE_\bL is bound to the function b\bba\bac\bck\bk-\b-
w\bwa\bar\brd\bd-\b-k\bki\bil\bll\bl-\b-w\bwo\bor\brd\bd, and _\bC_\b-_\bo is bound to run the macro
expressed on the right hand side (that is, to insert the
- text _\b>_\b&_\bo_\bu_\bt_\bp_\bu_\bt into the line).
-
-
-
-GNU 1998 Dec 31 2
-
-
-
-
-
-READLINE(3) READLINE(3)
-
+ text ``> output'' into the line).
In the second form, "\b"k\bke\bey\bys\bse\beq\bq"\b":_\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn_\b-_\bn_\ba_\bm_\be or _\bm_\ba_\bc_\br_\bo, k\bke\bey\by-\b-
s\bse\beq\bq differs from k\bke\bey\byn\bna\bam\bme\be 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.
+ 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, _\bC_\b-_\bu is again bound to the function u\bun\bni\bi-\b-
- v\bve\ber\brs\bsa\bal\bl-\b-a\bar\brg\bgu\bum\bme\ben\bnt\bt. _\bC_\b-_\bx _\bC_\b-_\br is bound to the function
- r\bre\be-\b-r\bre\bea\bad\bd-\b-i\bin\bni\bit\bt-\b-f\bfi\bil\ble\be, and _\bE_\bS_\bC _\b[ _\b1 _\b1 _\b~ is bound to insert the
- text F\bFu\bun\bnc\bct\bti\bio\bon\bn K\bKe\bey\by 1\b1. The full set of GNU Emacs style
- escape sequences is
+ In this example, _\bC_\b-_\bu is again bound to the function u\bun\bni\bi-\b-
+ v\bve\ber\brs\bsa\bal\bl-\b-a\bar\brg\bgu\bum\bme\ben\bnt\bt. _\bC_\b-_\bx _\bC_\b-_\br is bound to the function
+ r\bre\be-\b-r\bre\bea\bad\bd-\b-i\bin\bni\bit\bt-\b-f\bfi\bil\ble\be, and _\bE_\bS_\bC _\b[ _\b1 _\b1 _\b~ is bound to insert the
+ text ``Function Key 1''.
+
+ The full set of GNU Emacs style escape sequences available
+ when specifying key sequences is
\\b\C\bC-\b- control prefix
\\b\M\bM-\b- meta prefix
\\b\e\be an escape character
\\b\\\b\ backslash
- \\b\"\b" literal "
- \\b\'\b' literal '
+ \\b\"\b" literal ", a double quote
+ \\b\'\b' literal ', a single quote
- In addition to the GNU Emacs style escape sequences, a
+ In addition to the GNU Emacs style escape sequences, a
second set of backslash escapes is available:
\\b\a\ba alert (bell)
\\b\b\bb backspace
\\b\r\br carriage return
\\b\t\bt horizontal tab
\\b\v\bv vertical tab
- \\b\_\bn_\bn_\bn the character whose ASCII code is the octal
- value _\bn_\bn_\bn (one to three digits)
- \\b\x\bx_\bn_\bn_\bn the character whose ASCII code is the hex-
- adecimal value _\bn_\bn_\bn (one to three digits)
+ \\b\_\bn_\bn_\bn the eight-bit character whose value is the
+ octal value _\bn_\bn_\bn (one to three digits)
+ \\b\x\bx_\bH_\bH the eight-bit character whose value is the
+ hexadecimal value _\bH_\bH (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
does not provide any other means to incorporate new bind-
ings.
-
-
-
-
-GNU 1998 Dec 31 3
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
V\bVa\bar\bri\bia\bab\bbl\ble\bes\bs
Readline has variables that can be used to further cus-
tomize its behavior. A variable may be set in the _\bi_\bn_\bp_\bu_\bt_\br_\bc
s\bse\bet\bt _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be_\b-_\bn_\ba_\bm_\be _\bv_\ba_\bl_\bu_\be
Except where noted, readline variables can take the values
- O\bOn\bn or O\bOf\bff\bf. The variables and their default values are:
+ O\bOn\bn or O\bOf\bff\bf (without regard to case). The variables and
+ their default values are:
b\bbe\bel\bll\bl-\b-s\bst\bty\byl\ble\be (\b(a\bau\bud\bdi\bib\bbl\ble\be)\b)
- Controls what happens when readline wants to ring
- the terminal bell. If set to n\bno\bon\bne\be, readline never
+ Controls what happens when readline wants to ring
+ the terminal bell. If set to n\bno\bon\bne\be, readline never
rings the bell. If set to v\bvi\bis\bsi\bib\bbl\ble\be, readline uses a
- visible bell if one is available. If set to a\bau\bud\bdi\bi-\b-
+ visible bell if one is available. If set to a\bau\bud\bdi\bi-\b-
b\bbl\ble\be, readline attempts to ring the terminal's bell.
c\bco\bom\bmm\bme\ben\bnt\bt-\b-b\bbe\beg\bgi\bin\bn (\b(`\b``\b`#\b#'\b''\b')\b)
- The string that is inserted in v\bvi\bi mode when the
- i\bin\bns\bse\ber\brt\bt-\b-c\bco\bom\bmm\bme\ben\bnt\bt command is executed. This command
- is bound to M\bM-\b-#\b# in emacs mode and to #\b# in vi com-
+ The string that is inserted in v\bvi\bi mode when the
+ i\bin\bns\bse\ber\brt\bt-\b-c\bco\bom\bmm\bme\ben\bnt\bt command is executed. This command
+ is bound to M\bM-\b-#\b# in emacs mode and to #\b# in vi com-
mand mode.
c\bco\bom\bmp\bpl\ble\bet\bti\bio\bon\bn-\b-i\big\bgn\bno\bor\bre\be-\b-c\bca\bas\bse\be (\b(O\bOf\bff\bf)\b)
- If set to O\bOn\bn, readline performs filename matching
+ If set to O\bOn\bn, readline performs filename matching
and completion in a case-insensitive fashion.
c\bco\bom\bmp\bpl\ble\bet\bti\bio\bon\bn-\b-q\bqu\bue\ber\bry\by-\b-i\bit\bte\bem\bms\bs (\b(1\b10\b00\b0)\b)
- This determines when the user is queried about
- viewing the number of possible completions gener-
- ated by the p\bpo\bos\bss\bsi\bib\bbl\ble\be-\b-c\bco\bom\bmp\bpl\ble\bet\bti\bio\bon\bns\bs 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 vari-
+ This determines when the user is queried about
+ viewing the number of possible completions gener-
+ ated by the p\bpo\bos\bss\bsi\bib\bbl\ble\be-\b-c\bco\bom\bmp\bpl\ble\bet\bti\bio\bon\bns\bs 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 vari-
able, the user is asked whether or not he wishes to
- view them; otherwise they are simply listed on the
+ view them; otherwise they are simply listed on the
terminal.
c\bco\bon\bnv\bve\ber\brt\bt-\b-m\bme\bet\bta\ba (\b(O\bOn\bn)\b)
If set to O\bOn\bn, readline will convert characters with
- the eighth bit set to an ASCII key sequence by
- stripping the eighth bit and prepending an escape
- character (in effect, using escape as the _\bm_\be_\bt_\ba _\bp_\br_\be_\b-
- _\bf_\bi_\bx).
+ 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
+ _\bm_\be_\bt_\ba _\bp_\br_\be_\bf_\bi_\bx).
d\bdi\bis\bsa\bab\bbl\ble\be-\b-c\bco\bom\bmp\bpl\ble\bet\bti\bio\bon\bn (\b(O\bOf\bff\bf)\b)
- If set to O\bOn\bn, readline will inhibit word comple-
- tion. Completion characters will be inserted into
+ If set to O\bOn\bn, readline will inhibit word comple-
+ tion. Completion characters will be inserted into
the line as if they had been mapped to s\bse\bel\blf\bf-\b-i\bin\bns\bse\ber\brt\bt.
e\bed\bdi\bit\bti\bin\bng\bg-\b-m\bmo\bod\bde\be (\b(e\bem\bma\bac\bcs\bs)\b)
- Controls whether readline begins with a set of key
- bindings similar to _\be_\bm_\ba_\bc_\bs or _\bv_\bi. e\bed\bdi\bit\bti\bin\bng\bg-\b-m\bmo\bod\bde\be can
+ Controls whether readline begins with a set of key
+ bindings similar to emacs or vi. e\bed\bdi\bit\bti\bin\bng\bg-\b-m\bmo\bod\bde\be can
be set to either e\bem\bma\bac\bcs\bs or v\bvi\bi.
e\ben\bna\bab\bbl\ble\be-\b-k\bke\bey\byp\bpa\bad\bd (\b(O\bOf\bff\bf)\b)
- When set to O\bOn\bn, readline will try to enable the
+ When set to O\bOn\bn, readline will try to enable the
application keypad when it is called. Some systems
need this to enable the arrow keys.
e\bex\bxp\bpa\ban\bnd\bd-\b-t\bti\bil\bld\bde\be (\b(O\bOf\bff\bf)\b)
- If set to o\bon\bn, tilde expansion is performed when
-
-
-
-GNU 1998 Dec 31 4
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
+ If set to o\bon\bn, tilde expansion is performed when
readline attempts word completion.
+ h\bhi\bis\bst\bto\bor\bry\by-\b-p\bpr\bre\bes\bse\ber\brv\bve\be-\b-p\bpo\boi\bin\bnt\bt
+ If set to o\bon\bn, the history code attempts to place
+ point at the same location on each history line
+ retrived with p\bpr\bre\bev\bvi\bio\bou\bus\bs-\b-h\bhi\bis\bst\bto\bor\bry\by or n\bne\bex\bxt\bt-\b-h\bhi\bis\bst\bto\bor\bry\by.
h\bho\bor\bri\biz\bzo\bon\bnt\bta\bal\bl-\b-s\bsc\bcr\bro\bol\bll\bl-\b-m\bmo\bod\bde\be (\b(O\bOf\bff\bf)\b)
- When set to O\bOn\bn, makes readline use a single line
- for display, scrolling the input horizontally on a
- single screen line when it becomes longer than the
+ When set to O\bOn\bn, 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.
i\bin\bnp\bpu\but\bt-\b-m\bme\bet\bta\ba (\b(O\bOf\bff\bf)\b)
- If set to O\bOn\bn, readline will enable eight-bit input
- (that is, it will not strip the high bit from the
+ If set to O\bOn\bn, readline will enable eight-bit input
+ (that is, it will not clear the eighth bit in the
characters it reads), regardless of what the termi-
nal claims it can support. The name m\bme\bet\bta\ba-\b-f\bfl\bla\bag\bg is a
synonym for this variable.
- i\bis\bse\bea\bar\brc\bch\bh-\b-t\bte\ber\brm\bmi\bin\bna\bat\bto\bor\brs\bs (\b(`\b``\b`C\bC-\b-[\b[C\bC-\b-J\bJ'\b''\b')\b)
- The string of characters that should terminate an
- incremental search without subsequently executing
- the character as a command. If this variable has
- not been given a value, the characters _\bE_\bS_\bC and _\bC_\b-_\bJ
+ i\bis\bse\bea\bar\brc\bch\bh-\b-t\bte\ber\brm\bmi\bin\bna\bat\bto\bor\brs\bs (\b(`\b``\b`C\bC-\b-[\b[ C\bC-\b-J\bJ'\b''\b')\b)
+ The string of characters that should terminate an
+ incremental search without subsequently executing
+ the character as a command. If this variable has
+ not been given a value, the characters _\bE_\bS_\bC and _\bC_\b-_\bJ
will terminate an incremental search.
k\bke\bey\bym\bma\bap\bp (\b(e\bem\bma\bac\bcs\bs)\b)
- Set the current readline keymap. The set of legal
- keymap names is _\be_\bm_\ba_\bc_\bs_\b, _\be_\bm_\ba_\bc_\bs_\b-_\bs_\bt_\ba_\bn_\bd_\ba_\br_\bd_\b, _\be_\bm_\ba_\bc_\bs_\b-_\bm_\be_\bt_\ba_\b,
+ Set the current readline keymap. The set of legal
+ keymap names is _\be_\bm_\ba_\bc_\bs_\b, _\be_\bm_\ba_\bc_\bs_\b-_\bs_\bt_\ba_\bn_\bd_\ba_\br_\bd_\b, _\be_\bm_\ba_\bc_\bs_\b-_\bm_\be_\bt_\ba_\b,
_\be_\bm_\ba_\bc_\bs_\b-_\bc_\bt_\bl_\bx_\b, _\bv_\bi_\b, _\bv_\bi_\b-_\bm_\bo_\bv_\be_\b, _\bv_\bi_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd, and _\bv_\bi_\b-_\bi_\bn_\bs_\be_\br_\bt.
_\bv_\bi is equivalent to _\bv_\bi_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd; _\be_\bm_\ba_\bc_\bs is equivalent
- to _\be_\bm_\ba_\bc_\bs_\b-_\bs_\bt_\ba_\bn_\bd_\ba_\br_\bd. The default value is _\be_\bm_\ba_\bc_\bs; the
- value of e\bed\bdi\bit\bti\bin\bng\bg-\b-m\bmo\bod\bde\be also affects the default
+ to _\be_\bm_\ba_\bc_\bs_\b-_\bs_\bt_\ba_\bn_\bd_\ba_\br_\bd. The default value is _\be_\bm_\ba_\bc_\bs.
+ The value of e\bed\bdi\bit\bti\bin\bng\bg-\b-m\bmo\bod\bde\be also affects the default
keymap.
m\bma\bar\brk\bk-\b-d\bdi\bir\bre\bec\bct\bto\bor\bri\bie\bes\bs (\b(O\bOn\bn)\b)
- If set to O\bOn\bn, complete<d directory names have a
+ If set to O\bOn\bn, completed directory names have a
slash appended.
m\bma\bar\brk\bk-\b-m\bmo\bod\bdi\bif\bfi\bie\bed\bd-\b-l\bli\bin\bne\bes\bs (\b(O\bOf\bff\bf)\b)
If set to O\bOn\bn, history lines that have been modified
are displayed with a preceding asterisk (*\b*).
+ m\bma\bar\brk\bk-\b-s\bsy\bym\bml\bli\bin\bnk\bke\bed\bd-\b-d\bdi\bir\bre\bec\bct\bto\bor\bri\bie\bes\bs (\b(O\bOf\bff\bf)\b)
+ If set to O\bOn\bn, completed names which are symbolic
+ links to directories have a slash appended (subject
+ to the value of m\bma\bar\brk\bk-\b-d\bdi\bir\bre\bec\bct\bto\bor\bri\bie\bes\bs).
+ m\bma\bat\btc\bch\bh-\b-h\bhi\bid\bdd\bde\ben\bn-\b-f\bfi\bil\ble\bes\bs (\b(O\bOn\bn)\b)
+ This variable, when set to O\bOn\bn, 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.
o\bou\but\btp\bpu\but\bt-\b-m\bme\bet\bta\ba (\b(O\bOf\bff\bf)\b)
If set to O\bOn\bn, readline will display characters with
- the eighth bit set directly rather than as a meta-
+ the eighth bit set directly rather than as a meta-
prefixed escape sequence.
+ p\bpa\bag\bge\be-\b-c\bco\bom\bmp\bpl\ble\bet\bti\bio\bon\bns\bs (\b(O\bOn\bn)\b)
+ If set to O\bOn\bn, readline uses an internal _\bm_\bo_\br_\be-like
+ pager to display a screenful of possible comple-
+ tions at a time.
p\bpr\bri\bin\bnt\bt-\b-c\bco\bom\bmp\bpl\ble\bet\bti\bio\bon\bns\bs-\b-h\bho\bor\bri\biz\bzo\bon\bnt\bta\bal\bll\bly\by (\b(O\bOf\bff\bf)\b)
- If set to O\bOn\bn, readline will display completions
- with matches sorted horizontally in alphabetical
+ If set to O\bOn\bn, readline will display completions
+ with matches sorted horizontally in alphabetical
order, rather than down the screen.
s\bsh\bho\bow\bw-\b-a\bal\bll\bl-\b-i\bif\bf-\b-a\bam\bmb\bbi\big\bgu\buo\bou\bus\bs (\b(O\bOf\bff\bf)\b)
- This alters the default behavior of the completion
- functions. If set to o\bon\bn, words which have more
- than one possible completion cause the matches to
- be listed immediately instead of ringing the bell.
+ This alters the default behavior of the completion
+ functions. If set to o\bon\bn, words which have more
+ than one possible completion cause the matches to
+ be listed immediately instead of ringing the bell.
v\bvi\bis\bsi\bib\bbl\ble\be-\b-s\bst\bta\bat\bts\bs (\b(O\bOf\bff\bf)\b)
If set to O\bOn\bn, a character denoting a file's type as
- reported by s\bst\bta\bat\bt(2) is appended to the filename
+ reported by _\bs_\bt_\ba_\bt(2) is appended to the filename
when listing possible completions.
C\bCo\bon\bnd\bdi\bit\bti\bio\bon\bna\bal\bl C\bCo\bon\bns\bst\btr\bru\buc\bct\bts\bs
- 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
-
-
-
-GNU 1998 Dec 31 5
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
- performed as the result of tests. There are four parser
+ 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 four parser
directives used.
- $\b$i\bif\bf The $\b$i\bif\bf 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
+ $\b$i\bif\bf The $\b$i\bif\bf 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
are required to isolate it.
- m\bmo\bod\bde\be The m\bmo\bod\bde\be=\b= form of the $\b$i\bif\bf directive is used
- to test whether readline is in emacs or vi
- mode. This may be used in conjunction with
+ m\bmo\bod\bde\be The m\bmo\bod\bde\be=\b= form of the $\b$i\bif\bf directive is used
+ to test whether readline is in emacs or vi
+ mode. This may be used in conjunction with
the s\bse\bet\bt k\bke\bey\bym\bma\bap\bp command, for instance, to set
- bindings in the _\be_\bm_\ba_\bc_\bs_\b-_\bs_\bt_\ba_\bn_\bd_\ba_\br_\bd and _\be_\bm_\ba_\bc_\bs_\b-
- _\bc_\bt_\bl_\bx keymaps only if readline is starting
+ bindings in the _\be_\bm_\ba_\bc_\bs_\b-_\bs_\bt_\ba_\bn_\bd_\ba_\br_\bd and _\be_\bm_\ba_\bc_\bs_\b-
+ _\bc_\bt_\bl_\bx keymaps only if readline is starting
out in emacs mode.
t\bte\ber\brm\bm The t\bte\ber\brm\bm=\b= form may be used to include termi-
- nal-specific key bindings, perhaps to bind
- the key sequences output by the terminal's
- function keys. The word on the right side
- of the =\b= is tested against the full name of
+ nal-specific key bindings, perhaps to bind
+ the key sequences output by the terminal's
+ function keys. The word on the right side
+ of the =\b= is tested against the full name of
the terminal and the portion of the terminal
name before the first -\b-. This allows _\bs_\bu_\bn to
match both _\bs_\bu_\bn and _\bs_\bu_\bn_\b-_\bc_\bm_\bd, for instance.
The a\bap\bpp\bpl\bli\bic\bca\bat\bti\bio\bon\bn construct is used to include
application-specific settings. Each program
using the readline library sets the _\ba_\bp_\bp_\bl_\bi_\bc_\ba_\b-
- _\bt_\bi_\bo_\bn _\bn_\ba_\bm_\be, and an initialization file can
- test for a particular value. This could be
+ _\bt_\bi_\bo_\bn _\bn_\ba_\bm_\be, and an initialization file can
+ test for a particular value. This could be
used to bind key sequences to functions use-
- ful for a specific program. For instance,
- the following command adds a key sequence
- that quotes the current or previous word in
+ ful for a specific program. For instance,
+ the following command adds a key sequence
+ that quotes the current or previous word in
Bash:
- $\b$i\bif\bf bash
+ $\b$i\bif\bf Bash
# Quote the current or previous word
"\C-xq": "\eb\"\ef\""
$\b$e\ben\bnd\bdi\bif\bf
$\b$e\ben\bnd\bdi\bif\bf This command, as seen in the previous example, ter-
minates an $\b$i\bif\bf command.
- $\b$e\bel\bls\bse\be Commands in this branch of the $\b$i\bif\bf directive are
+ $\b$e\bel\bls\bse\be Commands in this branch of the $\b$i\bif\bf directive are
executed if the test fails.
$\b$i\bin\bnc\bcl\blu\bud\bde\be
- This directive takes a single filename as an argu-
- ment and reads commands and bindings from that
- file. For example, the following directive would
+ 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 _\b/_\be_\bt_\bc_\b/_\bi_\bn_\bp_\bu_\bt_\br_\bc:
-
-
-GNU 1998 Dec 31 6
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
$\b$i\bin\bnc\bcl\blu\bud\bde\be _\b/_\be_\bt_\bc_\b/_\bi_\bn_\bp_\bu_\bt_\br_\bc
S\bSE\bEA\bAR\bRC\bCH\bHI\bIN\bNG\bG
- Readline provides commands for searching through the com-
- mand history for lines containing a specified string.
- There are two search modes: _\bi_\bn_\bc_\br_\be_\bm_\be_\bn_\bt_\ba_\bl and _\bn_\bo_\bn_\b-_\bi_\bn_\bc_\br_\be_\bm_\be_\bn_\b-
+ Readline provides commands for searching through the com-
+ mand history for lines containing a specified string.
+ There are two search modes: _\bi_\bn_\bc_\br_\be_\bm_\be_\bn_\bt_\ba_\bl and _\bn_\bo_\bn_\b-_\bi_\bn_\bc_\br_\be_\bm_\be_\bn_\b-
_\bt_\ba_\bl.
- Incremental searches begin before the user has finished
+ 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 characters present in the
- value of the _\bi_\bs_\be_\ba_\br_\bc_\bh_\b-_\bt_\be_\br_\bm_\bi_\bn_\ba_\bt_\bo_\br_\bs variable are used to ter-
- minate an incremental search. If that variable has not
- been assigned a value the Escape and Control-J characters
- will terminate an incremental search. Control-G will
- abort an incremental search and restore the original line.
- When the search is terminated, the history entry contain-
- ing the search string becomes the current line. To find
- other matching entries in the history list, type Control-S
- or Control-R as appropriate. This will search backward or
+ 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 his-
+ tory for a particular string, type C\bC-\b-r\br. Typing C\bC-\b-s\bs
+ searches forward through the history. The characters pre-
+ sent in the value of the i\bis\bse\bea\bar\brc\bch\bh-\b-t\bte\ber\brm\bmi\bin\bna\bat\bto\bor\brs\bs variable are
+ used to terminate an incremental search. If that variable
+ has not been assigned a value the _\bE_\bs_\bc_\ba_\bp_\be and C\bC-\b-J\bJ charac-
+ ters will terminate an incremental search. C\bC-\b-G\bG 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\bC-\b-s\bs or C\bC-\b-r\br 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 _\bn_\be_\bw_\bl_\bi_\bn_\be will terminate
+ cute that command. For instance, a newline will terminate
the search and accept the line, thereby executing the com-
- mand from the history list.
+ mand from the history list. A movement command will ter-
+ minate 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
mand names without an accompanying key sequence are
unbound by default.
+ In the following descriptions, _\bp_\bo_\bi_\bn_\bt refers to the current
+ cursor position, and _\bm_\ba_\br_\bk refers to a cursor position
+ saved by the s\bse\bet\bt-\b-m\bma\bar\brk\bk command. The text between the point
+ and mark is referred to as the _\br_\be_\bg_\bi_\bo_\bn.
+
C\bCo\bom\bmm\bma\ban\bnd\bds\bs f\bfo\bor\br M\bMo\bov\bvi\bin\bng\bg
b\bbe\beg\bgi\bin\bnn\bni\bin\bng\bg-\b-o\bof\bf-\b-l\bli\bin\bne\be (\b(C\bC-\b-a\ba)\b)
Move to the start of the current line.
b\bba\bac\bck\bkw\bwa\bar\brd\bd-\b-c\bch\bha\bar\br (\b(C\bC-\b-b\bb)\b)
Move back a character.
f\bfo\bor\brw\bwa\bar\brd\bd-\b-w\bwo\bor\brd\bd (\b(M\bM-\b-f\bf)\b)
- 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).
-
-
-
-GNU 1998 Dec 31 7
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
b\bba\bac\bck\bkw\bwa\bar\brd\bd-\b-w\bwo\bor\brd\bd (\b(M\bM-\b-b\bb)\b)
- Move back to the start of this, or the previous,
- word. Words are composed of alphanumeric charac-
+ Move back to the start of the current or previous
+ word. Words are composed of alphanumeric charac-
ters (letters and digits).
c\bcl\ble\bea\bar\br-\b-s\bsc\bcr\bre\bee\ben\bn (\b(C\bC-\b-l\bl)\b)
- 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.
r\bre\bed\bdr\bra\baw\bw-\b-c\bcu\bur\brr\bre\ben\bnt\bt-\b-l\bli\bin\bne\be
Refresh the current line.
C\bCo\bom\bmm\bma\ban\bnd\bds\bs f\bfo\bor\br M\bMa\ban\bni\bip\bpu\bul\bla\bat\bti\bin\bng\bg t\bth\bhe\be H\bHi\bis\bst\bto\bor\bry\by
a\bac\bcc\bce\bep\bpt\bt-\b-l\bli\bin\bne\be (\b(N\bNe\bew\bwl\bli\bin\bne\be,\b, R\bRe\bet\btu\bur\brn\bn)\b)
- 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.
+ 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 recall with a\bad\bdd\bd_\b_h\bhi\bis\bst\bto\bor\bry\by(\b()\b).
+ If the line is a modified history line, the history
+ line is restored to its original state.
p\bpr\bre\bev\bvi\bio\bou\bus\bs-\b-h\bhi\bis\bst\bto\bor\bry\by (\b(C\bC-\b-p\bp)\b)
Fetch the previous command from the history list,
moving back in the list.
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.
-
-
-
-
-GNU 1998 Dec 31 8
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
y\bya\ban\bnk\bk-\b-n\bnt\bth\bh-\b-a\bar\brg\bg (\b(M\bM-\b-C\bC-\b-y\by)\b)
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 _\bn, insert the _\bnth word from the previous com-
- mand (the words in the previous command begin with
- word 0). A negative argument inserts the _\bnth word
- from the end of the previous command.
+ point. With an argument _\bn, insert the _\bnth word
+ from the previous command (the words in the previ-
+ ous command begin with word 0). A negative argu-
+ ment inserts the _\bnth word from the end of the pre-
+ vious command.
y\bya\ban\bnk\bk-\b-l\bla\bas\bst\bt-\b-a\bar\brg\bg (\b(M\bM-\b-.\b.,\b, M\bM-\b-_\b_)\b)
Insert the last argument to the previous command
(the last word of the previous history entry).
C\bCo\bom\bmm\bma\ban\bnd\bds\bs f\bfo\bor\br C\bCh\bha\ban\bng\bgi\bin\bng\bg T\bTe\bex\bxt\bt
d\bde\bel\ble\bet\bte\be-\b-c\bch\bha\bar\br (\b(C\bC-\b-d\bd)\b)
- 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 bound to B\bBd\bde\bel\ble\bet\bte\be-\b-c\bch\bha\bar\br, then return E\bEO\bOF\bF.
+ Delete the character at point. If point is at the
+ beginning of the line, there are no characters in
+ the line, and the last character typed was not
+ bound to d\bde\bel\ble\bet\bte\be-\b-c\bch\bha\bar\br, then return E\bEO\bOF\bF.
b\bba\bac\bck\bkw\bwa\bar\brd\bd-\b-d\bde\bel\ble\bet\bte\be-\b-c\bch\bha\bar\br (\b(R\bRu\bub\bbo\bou\but\bt)\b)
Delete the character behind the cursor. When given
a numeric argument, save the deleted text on the
f\bfo\bor\brw\bwa\bar\brd\bd-\b-b\bba\bac\bck\bkw\bwa\bar\brd\bd-\b-d\bde\bel\ble\bet\bte\be-\b-c\bch\bha\bar\br
Delete the character under the cursor, unless the
cursor is at the end of the line, in which case the
- character behind the cursor is deleted. By
- default, this is not bound to a key.
+ character behind the cursor is deleted.
q\bqu\buo\bot\bte\bed\bd-\b-i\bin\bns\bse\ber\brt\bt (\b(C\bC-\b-q\bq,\b, C\bC-\b-v\bv)\b)
- 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
C\bC-\b-q\bq, for example.
t\bta\bab\bb-\b-i\bin\bns\bse\ber\brt\bt (\b(M\bM-\b-T\bTA\bAB\bB)\b)
Insert a tab character.
s\bse\bel\blf\bf-\b-i\bin\bns\bse\ber\brt\bt (\b(a\ba,\b, b\bb,\b, A\bA,\b, 1\b1,\b, !\b!,\b, .\b..\b..\b.)\b)
Insert the character typed.
t\btr\bra\ban\bns\bsp\bpo\bos\bse\be-\b-c\bch\bha\bar\brs\bs (\b(C\bC-\b-t\bt)\b)
- 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.
+ 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. Nega-
+ tive arguments have no effect.
t\btr\bra\ban\bns\bsp\bpo\bos\bse\be-\b-w\bwo\bor\brd\bds\bs (\b(M\bM-\b-t\bt)\b)
- Drag the word behind the cursor past the word in
- front of the cursor moving the cursor over that
- word as well.
+ 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.
u\bup\bpc\bca\bas\bse\be-\b-w\bwo\bor\brd\bd (\b(M\bM-\b-u\bu)\b)
Uppercase the current (or following) word. With a
negative argument, uppercase the previous word, but
do not move point.
-
-
-
-
-GNU 1998 Dec 31 9
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
d\bdo\bow\bwn\bnc\bca\bas\bse\be-\b-w\bwo\bor\brd\bd (\b(M\bM-\b-l\bl)\b)
Lowercase the current (or following) word. With a
negative argument, lowercase the previous word, but
Capitalize the current (or following) word. With a
negative argument, capitalize the previous word,
but do not move point.
+ o\bov\bve\ber\brw\bwr\bri\bit\bte\be-\b-m\bmo\bod\bde\be
+ Toggle overwrite mode. With an explicit positive
+ numeric argument, switches to overwrite mode. With
+ an explicit non-positive numeric argument, switches
+ to insert mode. This command affects only e\bem\bma\bac\bcs\bs
+ mode; v\bvi\bi mode does overwrite differently. Each
+ call to _\br_\be_\ba_\bd_\bl_\bi_\bn_\be_\b(_\b) starts in insert mode. In over-
+ write mode, characters bound to s\bse\bel\blf\bf-\b-i\bin\bns\bse\ber\brt\bt replace
+ the text at point rather than pushing the text to
+ the right. Characters bound to b\bba\bac\bck\bk-\b-
+ w\bwa\bar\brd\bd-\b-d\bde\bel\ble\bet\bte\be-\b-c\bch\bha\bar\br replace the character before point
+ with a space. By default, this command is unbound.
K\bKi\bil\bll\bli\bin\bng\bg a\ban\bnd\bd Y\bYa\ban\bnk\bki\bin\bng\bg
k\bki\bil\bll\bl-\b-l\bli\bin\bne\be (\b(C\bC-\b-k\bk)\b)
- Kill the text from the current cursor position to
- the end of the line.
+ Kill the text from point to the end of the line.
b\bba\bac\bck\bkw\bwa\bar\brd\bd-\b-k\bki\bil\bll\bl-\b-l\bli\bin\bne\be (\b(C\bC-\b-x\bx R\bRu\bub\bbo\bou\but\bt)\b)
Kill backward to the beginning of the line.
u\bun\bni\bix\bx-\b-l\bli\bin\bne\be-\b-d\bdi\bis\bsc\bca\bar\brd\bd (\b(C\bC-\b-u\bu)\b)
line. The killed text is saved on the kill-ring.
k\bki\bil\bll\bl-\b-w\bwh\bho\bol\ble\be-\b-l\bli\bin\bne\be
Kill all characters on the current line, no matter
- where the cursor is.
+ where point is.
k\bki\bil\bll\bl-\b-w\bwo\bor\brd\bd (\b(M\bM-\b-d\bd)\b)
- 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 f\bfo\bor\brw\bwa\bar\brd\bd-\b-w\bwo\bor\brd\bd.
+ 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 f\bfo\bor\br-\b-
+ w\bwa\bar\brd\bd-\b-w\bwo\bor\brd\bd.
b\bba\bac\bck\bkw\bwa\bar\brd\bd-\b-k\bki\bil\bll\bl-\b-w\bwo\bor\brd\bd (\b(M\bM-\b-R\bRu\bub\bbo\bou\but\bt)\b)
- Kill the word behind the cursor. Word boundaries
- are the same as those used by b\bba\bac\bck\bkw\bwa\bar\brd\bd-\b-w\bwo\bor\brd\bd.
+ Kill the word behind point. Word boundaries are
+ the same as those used by b\bba\bac\bck\bkw\bwa\bar\brd\bd-\b-w\bwo\bor\brd\bd.
u\bun\bni\bix\bx-\b-w\bwo\bor\brd\bd-\b-r\bru\bub\bbo\bou\but\bt (\b(C\bC-\b-w\bw)\b)
- Kill the word behind the cursor, using white space
- as a word boundary. The word boundaries are dif-
- ferent from b\bba\bac\bck\bkw\bwa\bar\brd\bd-\b-k\bki\bil\bll\bl-\b-w\bwo\bor\brd\bd.
+ Kill the word behind point, using white space as a
+ word boundary. The killed text is saved on the
+ kill-ring.
d\bde\bel\ble\bet\bte\be-\b-h\bho\bor\bri\biz\bzo\bon\bnt\bta\bal\bl-\b-s\bsp\bpa\bac\bce\be (\b(M\bM-\b-\\b\)\b)
Delete all spaces and tabs around point.
k\bki\bil\bll\bl-\b-r\bre\beg\bgi\bio\bon\bn
The word boundaries are the same as f\bfo\bor\brw\bwa\bar\brd\bd-\b-w\bwo\bor\brd\bd.
y\bya\ban\bnk\bk (\b(C\bC-\b-y\by)\b)
Yank the top of the kill ring into the buffer at
- the cursor.
+ point.
y\bya\ban\bnk\bk-\b-p\bpo\bop\bp (\b(M\bM-\b-y\by)\b)
Rotate the kill ring, and yank the new top. Only
works following y\bya\ban\bnk\bk or y\bya\ban\bnk\bk-\b-p\bpo\bop\bp.
-
-
-
-GNU 1998 Dec 31 10
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
N\bNu\bum\bme\ber\bri\bic\bc A\bAr\brg\bgu\bum\bme\ben\bnt\bts\bs
d\bdi\big\bgi\bit\bt-\b-a\bar\brg\bgu\bum\bme\ben\bnt\bt (\b(M\bM-\b-0\b0,\b, M\bM-\b-1\b1,\b, .\b..\b..\b.,\b, M\bM-\b--\b-)\b)
Add this digit to the argument already accumulat-
sible completions. Repeated execution of m\bme\ben\bnu\bu-\b-c\bco\bom\bm-\b-
p\bpl\ble\bet\bte\be 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 _\bn moves
- _\bn 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
- T\bTA\bAB\bB, but is unbound by default.
-
-
-
-
-GNU 1998 Dec 31 11
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
+ the list of completions, the bell is rung (subject
+ to the setting of 0\b0a\ban\bnd\bd t\bth\bhe\be o\bor\bri\big\bgi\bin\bna\bal\bl t\bte\bex\bxt\bt i\bis\bs
+ r\bre\bes\bst\bto\bor\bre\bed\bd.\b. A\bAn\bn a\bar\brg\bgu\bum\bme\ben\bnt\bt o\bof\bf _\bn m\bmo\bov\bve\bes\bs _\bn p\bpo\bos\bsi\bit\bti\bio\bon\bns\bs f\bfo\bor\br-\b-
+ w\bwa\bar\brd\bd i\bin\bn t\bth\bhe\be l\bli\bis\bst\bt o\bof\bf m\bma\bat\btc\bch\bhe\bes\bs;\b; a\ba n\bne\beg\bga\bat\bti\biv\bve\be a\bar\brg\bgu\bum\bme\ben\bnt\bt
+ m\bma\bay\by b\bbe\be u\bus\bse\bed\bd t\bto\bo m\bmo\bov\bve\be b\bba\bac\bck\bkw\bwa\bar\brd\bd t\bth\bhr\bro\bou\bug\bgh\bh t\bth\bhe\be l\bli\bis\bst\bt.\b.
+ T\bTh\bhi\bis\bs c\bco\bom\bmm\bma\ban\bnd\bd i\bis\bs i\bin\bnt\bte\ben\bnd\bde\bed\bd t\bto\bo b\bbe\be b\bbo\bou\bun\bnd\bd t\bto\bo T\bTA\bAB\bB,\b, b\bbu\but\bt i\bis\bs
+ u\bun\bnb\bbo\bou\bun\bnd\bd b\bby\by d\bde\bef\bfa\bau\bul\blt\bt.\b.
d\bde\bel\ble\bet\bte\be-\b-c\bch\bha\bar\br-\b-o\bor\br-\b-l\bli\bis\bst\bt
- Deletes the character under the cursor if not at
- the beginning or end of the line (like d\bde\bel\ble\bet\bte\be-\b-
- c\bch\bha\bar\br). If at the end of the line, behaves identi-
- cally to p\bpo\bos\bss\bsi\bib\bbl\ble\be-\b-c\bco\bom\bmp\bpl\ble\bet\bti\bio\bon\bns\bs. This command is
- unbound by default.
+ Deletes the character under the cursor if not at
+ the beginning or end of the line (like d\bde\bel\ble\bet\bte\be-\b-
+ c\bch\bha\bar\br). If at the end of the line, behaves identi-
+ cally to p\bpo\bos\bss\bsi\bib\bbl\ble\be-\b-c\bco\bom\bmp\bpl\ble\bet\bti\bio\bon\bns\bs.
K\bKe\bey\byb\bbo\boa\bar\brd\bd M\bMa\bac\bcr\bro\bos\bs
s\bst\bta\bar\brt\bt-\b-k\bkb\bbd\bd-\b-m\bma\bac\bcr\bro\bo (\b(C\bC-\b-x\bx (\b()\b)
t\bti\bil\bld\bde\be-\b-e\bex\bxp\bpa\ban\bnd\bd (\b(M\bM-\b-&\b&)\b)
Perform tilde expansion on the current word.
s\bse\bet\bt-\b-m\bma\bar\brk\bk (\b(C\bC-\b-@\b@,\b, M\bM-\b-<\b<s\bsp\bpa\bac\bce\be>\b>)\b)
- Set the mark to the current point. If a numeric
- argument is supplied, the mark is set to that posi-
- tion.
+ Set the mark to the point. If a numeric argument
+ is supplied, the mark is set to that position.
e\bex\bxc\bch\bha\ban\bng\bge\be-\b-p\bpo\boi\bin\bnt\bt-\b-a\ban\bnd\bd-\b-m\bma\bar\brk\bk (\b(C\bC-\b-x\bx C\bC-\b-x\bx)\b)
- 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.
c\bch\bha\bar\bra\bac\bct\bte\ber\br-\b-s\bse\bea\bar\brc\bch\bh (\b(C\bC-\b-]\b])\b)
- A character is read and point is moved to the next
-
-
-
-GNU 1998 Dec 31 12
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
- 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.
c\bch\bha\bar\bra\bac\bct\bte\ber\br-\b-s\bse\bea\bar\brc\bch\bh-\b-b\bba\bac\bck\bkw\bwa\bar\brd\bd (\b(M\bM-\b-C\bC-\b-]\b])\b)
- 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.
i\bin\bns\bse\ber\brt\bt-\b-c\bco\bom\bmm\bme\ben\bnt\bt (\b(M\bM-\b-#\b#)\b)
- The value of the readline c\bco\bom\bmm\bme\ben\bnt\bt-\b-b\bbe\beg\bgi\bin\bn 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 com-
- ment.
+ Without a numeric argument, the value of the read-
+ line c\bco\bom\bmm\bme\ben\bnt\bt-\b-b\bbe\beg\bgi\bin\bn variable is inserted at the
+ beginning of the current line. If a numeric argu-
+ ment is supplied, this command acts as a toggle:
+ if the characters at the beginning of the line do
+ not match the value of c\bco\bom\bmm\bme\ben\bnt\bt-\b-b\bbe\beg\bgi\bin\bn, the value is
+ inserted, otherwise the characters in c\bco\bom\bmm\bme\ben\bnt\bt-\b-b\bbe\beg\bgi\bin\bn
+ are deleted from the beginning of the line. In
+ either case, the line is accepted as if a newline
+ had been typed. The default value of c\bco\bom\bmm\bme\ben\bnt\bt-\b-b\bbe\beg\bgi\bin\bn
+ makes the current line a shell comment. If a
+ numeric argument causes the comment character to be
+ removed, the line will be executed by the shell.
d\bdu\bum\bmp\bp-\b-f\bfu\bun\bnc\bct\bti\bio\bon\bns\bs
- 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 _\bi_\bn_\bp_\bu_\bt_\br_\bc file.
+ Print all of the functions and their key bindings
+ to the readline output stream. If a numeric
+ argument is supplied, the output is formatted in
+ such a way that it can be made part of an _\bi_\bn_\bp_\bu_\bt_\br_\bc
+ file.
d\bdu\bum\bmp\bp-\b-v\bva\bar\bri\bia\bab\bbl\ble\bes\bs
Print all of the settable variables and their val-
ues to the readline output stream. If a numeric
such a way that it can be made part of an _\bi_\bn_\bp_\bu_\bt_\br_\bc
file.
e\bem\bma\bac\bcs\bs-\b-e\bed\bdi\bit\bti\bin\bng\bg-\b-m\bmo\bod\bde\be (\b(C\bC-\b-e\be)\b)
- When in v\bvi\bi editing mode, this causes a switch to
+ When in v\bvi\bi command mode, this causes a switch to
e\bem\bma\bac\bcs\bs editing mode.
v\bvi\bi-\b-e\bed\bdi\bit\bti\bin\bng\bg-\b-m\bmo\bod\bde\be (\b(M\bM-\b-C\bC-\b-j\bj)\b)
When in e\bem\bma\bac\bcs\bs editing mode, this causes a switch to
D\bDE\bEF\bFA\bAU\bUL\bLT\bT K\bKE\bEY\bY B\bBI\bIN\bND\bDI\bIN\bNG\bGS\bS
The following is a list of the default emacs and vi bind-
- ings. Characters with the 8th bit set are written as
+ ings. Characters with the eighth bit set are written as
M-<character>, and are referred to as _\bm_\be_\bt_\ba_\bf_\bi_\be_\bd characters.
The printable ASCII characters not mentioned in the list
- of emacs standard bindings are bound to the _\bs_\be_\bl_\bf_\b-_\bi_\bn_\bs_\be_\br_\bt
+ of emacs standard bindings are bound to the s\bse\bel\blf\bf-\b-i\bin\bns\bse\ber\brt\bt
function, which just inserts the given character into the
input line. In vi insertion mode, all characters not
- specifically mentioned are bound to _\bs_\be_\bl_\bf_\b-_\bi_\bn_\bs_\be_\br_\bt. Charac-
+ specifically mentioned are bound to s\bse\bel\blf\bf-\b-i\bin\bns\bse\ber\brt\bt. Charac-
ters assigned to signal generation by _\bs_\bt_\bt_\by(1) or the ter-
minal driver, such as C-Z or C-C, retain that function.
- Upper and lower case _\bm_\be_\bt_\ba_\bf_\bi_\be_\bd characters are bound to the
+ Upper and lower case metafied 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 b\bbe\bel\bll\bl-\b-s\bst\bty\byl\ble\be vari-
able).
-
-
-
-
-GNU 1998 Dec 31 13
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
E\bEm\bma\bac\bcs\bs M\bMo\bod\bde\be
Emacs Standard bindings
"M-1" digit-argument
"M-2" digit-argument
"M-3" digit-argument
-
-
-
-GNU 1998 Dec 31 14
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
"M-4" digit-argument
"M-5" digit-argument
"M-6" digit-argument
"M-Y" yank-pop
"M-\" delete-horizontal-space
"M-~" tilde-expand
- "M-C-?" backward-delete-word
+ "M-C-?" backward-kill-word
"M-_" yank-last-arg
Emacs Control-X bindings
"C-W" unix-word-rubout
"C-Y" yank
"C-[" vi-movement-mode
-
-
-
-GNU 1998 Dec 31 15
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
"C-_" undo
" " to "~" self-insert
"C-?" backward-delete-char
"C-V" quoted-insert
"C-W" unix-word-rubout
"C-Y" yank
+ "C-_" vi-undo
" " forward-char
"#" insert-comment
"$" end-of-line
"S" vi-subst
"T" vi-char-search
"U" revert-line
-
-
-
-GNU 1998 Dec 31 16
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
"W" vi-next-word
"X" backward-delete-char
"Y" vi-yank-to
"r" vi-change-char
"s" vi-subst
"t" vi-char-search
- "u" undo
+ "u" vi-undo
"w" vi-next-word
"x" vi-delete
"y" vi-yank-to
Individual r\bre\bea\bad\bdl\bli\bin\bne\be initialization file
A\bAU\bUT\bTH\bHO\bOR\bRS\bS
- Brian Fox, Free Software Foundation (primary author)
- bfox@ai.MIT.Edu
+ Brian Fox, Free Software Foundation
+ bfox@gnu.org
Chet Ramey, Case Western Reserve University
chet@ins.CWRU.Edu
library that you have.
Once you have determined that a bug actually exists, mail
-
-
-
-GNU 1998 Dec 31 17
-
-
-
-
-
-READLINE(3) READLINE(3)
-
-
a bug report to _\bb_\bu_\bg_\b-_\br_\be_\ba_\bd_\bl_\bi_\bn_\be@_\bg_\bn_\bu_\b._\bo_\br_\bg. If you have a fix,
you are welcome to mail that as well! Suggestions and
`philosophical' bug reports may be mailed to _\bb_\bu_\bg_\b-_\br_\be_\ba_\bd_\b-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-GNU 1998 Dec 31 18
-
-
+GNU Readline 4.3 2002 January 22 READLINE(3)
projects / deliverable / binutils-gdb.git / blobdiff