version 1.1.1.1, 2014/07/30 08:16:46
|
version 1.1.1.2, 2021/03/17 01:01:01
|
Line 1
|
Line 1
|
READLINE(3) READLINE(3) | READLINE(3) Library Functions Manual READLINE(3) |
|
|
|
|
|
|
NNAAMMEE | [1mNAME[0m |
readline - get a line from a user with editing |
readline - get a line from a user with editing |
|
|
SSYYNNOOPPSSIISS | [1mSYNOPSIS[0m |
##iinncclluuddee <<ssttddiioo..hh>> | [1m#include <stdio.h>[0m |
##iinncclluuddee <<rreeaaddlliinnee//rreeaaddlliinnee..hh>> | [1m#include <readline/readline.h>[0m |
##iinncclluuddee <<rreeaaddlliinnee//hhiissttoorryy..hh>> | [1m#include <readline/history.h>[0m |
|
|
_c_h_a_r _* | [4mchar[24m [4m*[0m |
rreeaaddlliinnee (_c_o_n_s_t _c_h_a_r _*_p_r_o_m_p_t); | [1mreadline [22m([4mconst[24m [4mchar[24m [4m*prompt[24m); |
|
|
CCOOPPYYRRIIGGHHTT | [1mCOPYRIGHT[0m |
Readline is Copyright (C) 1989-2011 Free Software Foundation, Inc. | Readline is Copyright (C) 1989-2020 Free Software Foundation, Inc. |
|
|
DDEESSCCRRIIPPTTIIOONN | [1mDESCRIPTION[0m |
rreeaaddlliinnee will read a line from the terminal and return it, using pprroommpptt | [1mreadline [22mwill read a line from the terminal and return it, using [1mprompt[0m |
as a prompt. If pprroommpptt is NNUULLLL or the empty string, no prompt is | as a prompt. If [1mprompt [22mis [1mNULL [22mor the empty string, no prompt is is- |
issued. The line returned is allocated with _m_a_l_l_o_c(3); the caller must | sued. The line returned is allocated with [4mmalloc[24m(3); the caller must |
free it when finished. The line returned has the final newline | free it when finished. The line returned has the final newline re- |
removed, so only the text of the line remains. | moved, so only the text of the line remains. |
|
|
rreeaaddlliinnee offers editing capabilities while the user is entering the | [1mreadline [22moffers editing capabilities while the user is entering the |
line. By default, the line editing commands are similar to those of |
line. By default, the line editing commands are similar to those of |
emacs. A vi-style line editing interface is also available. |
emacs. A vi-style line editing interface is also available. |
|
|
This manual page describes only the most basic use of rreeaaddlliinnee. Much | This manual page describes only the most basic use of [1mreadline[22m. Much |
more functionality is available; see _T_h_e _G_N_U _R_e_a_d_l_i_n_e _L_i_b_r_a_r_y and _T_h_e | more functionality is available; see [4mThe[24m [4mGNU[24m [4mReadline[24m [4mLibrary[24m and [4mThe[0m |
_G_N_U _H_i_s_t_o_r_y _L_i_b_r_a_r_y for additional information. | [4mGNU[24m [4mHistory[24m [4mLibrary[24m for additional information. |
|
|
RREETTUURRNN VVAALLUUEE | [1mRETURN VALUE[0m |
rreeaaddlliinnee returns the text of the line read. A blank line returns the | [1mreadline [22mreturns the text of the line read. A blank line returns the |
empty string. If EEOOFF is encountered while reading a line, and the line | empty string. If [1mEOF [22mis encountered while reading a line, and the line |
is empty, NNUULLLL is returned. If an EEOOFF is read with a non-empty line, | is empty, [1mNULL [22mis returned. If an [1mEOF [22mis read with a non-empty line, |
it is treated as a newline. |
it is treated as a newline. |
|
|
NNOOTTAATTIIOONN | [1mNOTATION[0m |
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 C-[4mkey[24m, e.g., C-n means Control-N. Similarly, [4mmeta[24m keys are |
denoted by M-_k_e_y, so M-x means Meta-X. (On keyboards without a _m_e_t_a | denoted by M-[4mkey[24m, so M-x means Meta-X. (On keyboards without a [4mmeta[0m |
key, M-_x means ESC _x, i.e., press the Escape key then the _x key. This | key, M-[4mx[24m means ESC [4mx[24m, i.e., press the Escape key then the [4mx[24m key. This |
makes ESC the _m_e_t_a _p_r_e_f_i_x. The combination M-C-_x means ESC-Control-_x, | makes ESC the [4mmeta[24m [4mprefix[24m. The combination M-C-[4mx[24m means ESC-Control-[4mx[24m, |
or press the Escape key then hold the Control key while pressing the _x | or press the Escape key then hold the Control key while pressing the [4mx[0m |
key.) |
key.) |
|
|
Readline commands may be given numeric _a_r_g_u_m_e_n_t_s, which normally act as | Readline commands may be given numeric [4marguments[24m, which normally act as |
a repeat count. Sometimes, however, it is the sign of the argument |
a repeat count. Sometimes, however, it is the sign of the argument |
that is significant. Passing a negative argument to a command that |
that is significant. Passing a negative argument to a command that |
acts in the forward direction (e.g., kkiillll--lliinnee) causes that command to | acts in the forward direction (e.g., [1mkill-line[22m) causes that command to |
act in a backward direction. Commands whose behavior with arguments |
act in a backward direction. Commands whose behavior with arguments |
deviates from this are noted. | deviates from this are noted below. |
|
|
When a command is described as _k_i_l_l_i_n_g text, the text deleted is saved | When a command is described as [4mkilling[24m text, the text deleted is saved |
for possible future retrieval (_y_a_n_k_i_n_g). The killed text is saved in a | for possible future retrieval ([4myanking[24m). The killed text is saved in a |
_k_i_l_l _r_i_n_g. Consecutive kills cause the text to be accumulated into one | [4mkill[24m [4mring[24m. Consecutive kills cause the text to be accumulated into one |
unit, which can be yanked all at once. Commands which do not kill text |
unit, which can be yanked all at once. Commands which do not kill text |
separate the chunks of text on the kill ring. |
separate the chunks of text on the kill ring. |
|
|
IINNIITTIIAALLIIZZAATTIIOONN FFIILLEE | [1mINITIALIZATION FILE[0m |
Readline is customized by putting commands in an initialization file |
Readline is customized by putting commands in an initialization file |
(the _i_n_p_u_t_r_c file). The name of this file is taken from the value of | (the [4minputrc[24m file). The name of this file is taken from the value of |
the IINNPPUUTTRRCC environment variable. If that variable is unset, the | the [1mINPUTRC [22menvironment variable. If that variable is unset, the de- |
default is _~_/_._i_n_p_u_t_r_c. If that file does not exist or cannot be read, | fault is [4m~/.inputrc[24m. If that file does not exist or cannot be read, |
the ultimate default is _/_e_t_c_/_i_n_p_u_t_r_c. When a program which uses the | the ultimate default is [4m/etc/inputrc[24m. When a program which uses the |
readline library starts up, the init file is read, and the key bindings |
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 |
and variables are set. There are only a few basic constructs allowed |
in the readline init file. Blank lines are ignored. Lines beginning |
in the readline init file. Blank lines are ignored. Lines beginning |
with a ## are comments. Lines beginning with a $$ indicate conditional | with a [1m# [22mare comments. Lines beginning with a [1m$ [22mindicate conditional |
constructs. Other lines denote key bindings and variable settings. |
constructs. Other lines denote key bindings and variable settings. |
Each program using this library may add its own commands and bindings. | Each program using this library may add its own commands and bindings. |
|
|
For example, placing |
For example, placing |
|
|
Line 78 IINNIITTIIAALLIIZZAATTIIOONN FFIILLE
|
Line 78 IINNIITTIIAALLIIZZAATTIIOONN FFIILLE
|
or |
or |
C-Meta-u: universal-argument |
C-Meta-u: universal-argument |
|
|
into the _i_n_p_u_t_r_c would make M-C-u execute the readline command _u_n_i_v_e_r_- | into the [4minputrc[24m would make M-C-u execute the readline command [4muniver-[0m |
_s_a_l_-_a_r_g_u_m_e_n_t. | [4msal-argument[24m. |
|
|
The following symbolic character names are recognized while processing | The following symbolic character names are recognized while processing |
key bindings: _D_E_L, _E_S_C, _E_S_C_A_P_E, _L_F_D, _N_E_W_L_I_N_E, _R_E_T, _R_E_T_U_R_N, _R_U_B_O_U_T, | key bindings: [4mDEL[24m, [4mESC[24m, [4mESCAPE[24m, [4mLFD[24m, [4mNEWLINE[24m, [4mRET[24m, [4mRETURN[24m, [4mRUBOUT[24m, |
_S_P_A_C_E, _S_P_C, and _T_A_B. | [4mSPACE[24m, [4mSPC[24m, and [4mTAB[24m. |
|
|
In addition to command names, readline allows keys to be bound to a | In addition to command names, readline allows keys to be bound to a |
string that is inserted when the key is pressed (a _m_a_c_r_o). | string that is inserted when the key is pressed (a [4mmacro[24m). |
|
|
| [1mKey Bindings[0m |
KKeeyy BBiinnddiinnggss | The syntax for controlling key bindings in the [4minputrc[24m file is simple. |
The syntax for controlling key bindings in the _i_n_p_u_t_r_c file is simple. | All that is required is the name of the command or the text of a macro |
All that is required is the name of the command or the text of a macro | and a key sequence to which it should be bound. The name may be speci- |
and a key sequence to which it should be bound. The name may be speci- | fied in one of two ways: as a symbolic key name, possibly with [4mMeta-[24m or |
fied in one of two ways: as a symbolic key name, possibly with _M_e_t_a_- or | [4mControl-[24m prefixes, or as a key sequence. The name and key sequence are |
_C_o_n_t_r_o_l_- prefixes, or as a key sequence. The name and key sequence are | separated by a colon. There can be no whitespace between the name and |
separated by a colon. There can be no whitespace between the name and | |
the colon. |
the colon. |
|
|
When using the form kkeeyynnaammee:_f_u_n_c_t_i_o_n_-_n_a_m_e or _m_a_c_r_o, _k_e_y_n_a_m_e is the name | When using the form [1mkeyname[22m:[4mfunction-name[24m or [4mmacro[24m, [4mkeyname[24m is the name |
of a key spelled out in English. For example: |
of a key spelled out in English. For example: |
|
|
Control-u: universal-argument |
Control-u: universal-argument |
Meta-Rubout: backward-kill-word |
Meta-Rubout: backward-kill-word |
Control-o: "> output" |
Control-o: "> output" |
|
|
In the above example, _C_-_u is bound to the function uunniivveerrssaall--aarrgguummeenntt, | In the above example, [4mC-u[24m is bound to the function [1muniversal-argument[22m, |
_M_-_D_E_L is bound to the function bbaacckkwwaarrdd--kkiillll--wwoorrdd, and _C_-_o is bound to | [4mM-DEL[24m is bound to the function [1mbackward-kill-word[22m, and [4mC-o[24m is bound to |
run the macro expressed on the right hand side (that is, to insert the | run the macro expressed on the right hand side (that is, to insert the |
text ``> output'' into the line). |
text ``> output'' into the line). |
|
|
In the second form, ""kkeeyysseeqq"":_f_u_n_c_t_i_o_n_-_n_a_m_e or _m_a_c_r_o, kkeeyysseeqq differs | In the second form, [1m"keyseq"[22m:[4mfunction-name[24m or [4mmacro[24m, [1mkeyseq [22mdiffers |
from kkeeyynnaammee above in that strings denoting an entire key sequence may | from [1mkeyname [22mabove in that strings denoting an entire key sequence may |
be specified by placing the sequence within double quotes. Some GNU | be specified by placing the sequence within double quotes. Some GNU |
Emacs style key escapes can be used, as in the following example, but | the symbolic character names are not recognized. |
the symbolic character names are not recognized. |
the symbolic character names are not recognized. |
|
|
"\C-u": universal-argument |
"\C-u": universal-argument |
"\C-x\C-r": re-read-init-file |
"\C-x\C-r": re-read-init-file |
"\e[11~": "Function Key 1" |
"\e[11~": "Function Key 1" |
|
|
In this example, _C_-_u is again bound to the function uunniivveerrssaall--aarrgguummeenntt. | In this example, [4mC-u[24m is again bound to the function [1muniversal-argument[22m. |
_C_-_x _C_-_r is bound to the function rree--rreeaadd--iinniitt--ffiillee, and _E_S_C _[ _1 _1 _~ is | [4mC-x[24m [4mC-r[24m is bound to the function [1mre-read-init-file[22m, and [4mESC[24m [4m[[24m [4m1[24m [4m1[24m [4m~[24m is |
bound to insert the text ``Function Key 1''. |
bound to insert the text ``Function Key 1''. |
|
|
The full set of GNU Emacs style escape sequences available when speci- | The full set of GNU Emacs style escape sequences available when speci- |
fying key sequences is |
fying key sequences is |
\\CC-- control prefix | [1m\C- [22mcontrol prefix |
\\MM-- meta prefix | [1m\M- [22mmeta prefix |
\\ee an escape character | [1m\e [22man escape character |
\\\\ backslash | [1m\\ [22mbackslash |
\\"" literal ", a double quote | [1m\" [22mliteral ", a double quote |
\\'' literal ', a single quote | [1m\' [22mliteral ', a single quote |
|
|
In addition to the GNU Emacs style escape sequences, a second set of | In addition to the GNU Emacs style escape sequences, a second set of |
backslash escapes is available: |
backslash escapes is available: |
\\aa alert (bell) | [1m\a [22malert (bell) |
\\bb backspace | [1m\b [22mbackspace |
\\dd delete | [1m\d [22mdelete |
\\ff form feed | [1m\f [22mform feed |
\\nn newline | [1m\n [22mnewline |
\\rr carriage return | [1m\r [22mcarriage return |
\\tt horizontal tab | [1m\t [22mhorizontal tab |
\\vv vertical tab | [1m\v [22mvertical tab |
\\_n_n_n the eight-bit character whose value is the octal value | [1m\[4m[22mnnn[24m the eight-bit character whose value is the octal value |
_n_n_n (one to three digits) | [4mnnn[24m (one to three digits) |
\\xx_H_H the eight-bit character whose value is the hexadecimal | [1m\x[4m[22mHH[24m the eight-bit character whose value is the hexadecimal |
value _H_H (one or two hex digits) | value [4mHH[24m (one or two hex digits) |
|
|
When entering the text of a macro, single or double quotes should be | 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 | used to indicate a macro definition. Unquoted text is assumed to be a |
function name. In the macro body, the backslash escapes described | function name. In the macro body, the backslash escapes described |
above are expanded. Backslash will quote any other character in the | above are expanded. Backslash will quote any other character in the |
macro text, including " and '. |
macro text, including " and '. |
|
|
BBaasshh allows the current readline key bindings to be displayed or modi- | [1mBash [22mallows the current readline key bindings to be displayed or modi- |
fied with the bbiinndd builtin command. The editing mode may be switched | fied with the [1mbind [22mbuiltin command. The editing mode may be switched |
during interactive use by using the --oo option to the sseett builtin com- | during interactive use by using the [1m-o [22moption to the [1mset [22mbuiltin com- |
mand. Other programs using this library provide similar mechanisms. | mand. Other programs using this library provide similar mechanisms. |
The _i_n_p_u_t_r_c file may be edited and re-read if a program does not pro- | The [4minputrc[24m file may be edited and re-read if a program does not pro- |
vide any other means to incorporate new bindings. |
vide any other means to incorporate new bindings. |
|
|
VVaarriiaabblleess | [1mVariables[0m |
Readline has variables that can be used to further customize its behav- |
Readline has variables that can be used to further customize its behav- |
ior. A variable may be set in the _i_n_p_u_t_r_c file with a statement of the | ior. A variable may be set in the [4minputrc[24m file with a statement of the |
form |
form |
|
|
sseett _v_a_r_i_a_b_l_e_-_n_a_m_e _v_a_l_u_e | [1mset [4m[22mvariable-name[24m [4mvalue[0m |
|
|
Except where noted, readline variables can take the values OOnn or OOffff | Except where noted, readline variables can take the values [1mOn [22mor [1mOff[0m |
(without regard to case). Unrecognized variable names are ignored. | (without regard to case). Unrecognized variable names are ignored. |
When a variable value is read, empty or null values, "on" (case-insen- | When a variable value is read, empty or null values, "on" (case-insen- |
sitive), and "1" are equivalent to OOnn. All other values are equivalent | sitive), and "1" are equivalent to [1mOn[22m. All other values are equivalent |
to OOffff. The variables and their default values are: | to [1mOff[22m. The variables and their default values are: |
|
|
bbeellll--ssttyyllee ((aauuddiibbllee)) | [1mbell-style (audible)[0m |
Controls what happens when readline wants to ring the terminal | Controls what happens when readline wants to ring the terminal |
bell. If set to nnoonnee, readline never rings the bell. If set to | bell. If set to [1mnone[22m, readline never rings the bell. If set to |
vviissiibbllee, readline uses a visible bell if one is available. If | [1mvisible[22m, readline uses a visible bell if one is available. If |
set to aauuddiibbllee, readline attempts to ring the terminal's bell. | set to [1maudible[22m, readline attempts to ring the terminal's bell. |
bbiinndd--ttttyy--ssppeecciiaall--cchhaarrss ((OOnn)) | [1mbind-tty-special-chars (On)[0m |
If set to OOnn, readline attempts to bind the control characters | If set to [1mOn [22m(the default), readline attempts to bind the con- |
treated specially by the kernel's terminal driver to their read- | trol characters treated specially by the kernel's terminal |
line equivalents. | driver to their readline equivalents. |
ccoolloorreedd--ssttaattss ((OOffff)) | [1mblink-matching-paren (Off)[0m |
If set to OOnn, readline displays possible completions using dif- | If set to [1mOn[22m, readline attempts to briefly move the cursor to an |
ferent colors to indicate their file type. The color defini- | opening parenthesis when a closing parenthesis is inserted. |
tions are taken from the value of the LLSS__CCOOLLOORRSS environment | [1mcolored-completion-prefix (Off)[0m |
| If set to [1mOn[22m, when listing completions, readline displays the |
| common prefix of the set of possible completions using a differ- |
| ent color. The color definitions are taken from the value of |
| the [1mLS_COLORS [22menvironment variable. |
| [1mcolored-stats (Off)[0m |
| If set to [1mOn[22m, readline displays possible completions using dif- |
| ferent colors to indicate their file type. The color defini- |
| tions are taken from the value of the [1mLS_COLORS [22menvironment |
variable. |
variable. |
ccoommmmeenntt--bbeeggiinn ((````##'''')) | [1mcomment-begin (``#'')[0m |
The string that is inserted in vvii mode when the iinnsseerrtt--ccoommmmeenntt | The string that is inserted in [1mvi [22mmode when the [1minsert-comment[0m |
command is executed. This command is bound to MM--## in emacs mode | command is executed. This command is bound to [1mM-# [22min emacs mode |
and to ## in vi command mode. | and to [1m# [22min vi command mode. |
ccoommpplleettiioonn--ddiissppllaayy--wwiiddtthh ((--11)) | [1mcompletion-display-width (-1)[0m |
The number of screen columns used to display possible matches | The number of screen columns used to display possible matches |
when performing completion. The value is ignored if it is less | when performing completion. The value is ignored if it is less |
than 0 or greater than the terminal screen width. A value of 0 | than 0 or greater than the terminal screen width. A value of 0 |
will cause matches to be displayed one per line. The default | will cause matches to be displayed one per line. The default |
value is -1. |
value is -1. |
ccoommpplleettiioonn--iiggnnoorree--ccaassee ((OOffff)) | [1mcompletion-ignore-case (Off)[0m |
If set to OOnn, readline performs filename matching and completion | If set to [1mOn[22m, readline performs filename matching and completion |
in a case-insensitive fashion. |
in a case-insensitive fashion. |
ccoommpplleettiioonn--mmaapp--ccaassee ((OOffff)) | [1mcompletion-map-case (Off)[0m |
If set to OOnn, and ccoommpplleettiioonn--iiggnnoorree--ccaassee is enabled, readline | If set to [1mOn[22m, and [1mcompletion-ignore-case [22mis enabled, readline |
treats hyphens (_-) and underscores (__) as equivalent when per- | forming case-insensitive filename matching and completion. |
forming case-insensitive filename matching and completion. |
forming case-insensitive filename matching and completion. |
ccoommpplleettiioonn--pprreeffiixx--ddiissppllaayy--lleennggtthh ((00)) | [1mcompletion-prefix-display-length (0)[0m |
The length in characters of the common prefix of a list of pos- | The length in characters of the common prefix of a list of pos- |
sible completions that is displayed without modification. When | sible completions that is displayed without modification. When |
set to a value greater than zero, common prefixes longer than | set to a value greater than zero, common prefixes longer than |
this value are replaced with an ellipsis when displaying possi- | ble completions. |
ble completions. |
ble completions. |
ccoommpplleettiioonn--qquueerryy--iitteemmss ((110000)) | [1mcompletion-query-items (100)[0m |
This determines when the user is queried about viewing the num- | This determines when the user is queried about viewing the num- |
ber of possible completions generated by the ppoossssiibbllee--ccoommppllee-- | ber of possible completions generated by the [1mpossible-comple-[0m |
ttiioonnss command. It may be set to any integer value greater than | [1mtions [22mcommand. It may be set to any integer value greater than |
or equal to zero. If the number of possible completions is | or equal to zero. If the number of possible completions is |
greater than or equal to the value of this variable, the user is | greater than or equal to the value of this variable, readline |
asked whether or not he wishes to view them; otherwise they are | will ask whether or not the user wishes to view them; otherwise |
simply listed on the terminal. A negative value causes readline | they are simply listed on the terminal. A negative value causes |
to never ask. | readline to never ask. |
ccoonnvveerrtt--mmeettaa ((OOnn)) | [1mconvert-meta (On)[0m |
If set to OOnn, readline will convert characters with the eighth | If set to [1mOn[22m, readline will convert characters with the eighth |
bit set to an ASCII key sequence by stripping the eighth bit and |
bit set to an ASCII key sequence by stripping the eighth bit and |
prefixing it with an escape character (in effect, using escape | prefixing it with an escape character (in effect, using escape |
as the _m_e_t_a _p_r_e_f_i_x). | as the [4mmeta[24m [4mprefix[24m). The default is [4mOn[24m, but readline will set |
ddiissaabbllee--ccoommpplleettiioonn ((OOffff)) | it to [4mOff[24m if the locale contains eight-bit characters. |
If set to OOnn, readline will inhibit word completion. Completion | [1mdisable-completion (Off)[0m |
| If set to [1mOn[22m, readline will inhibit word completion. Completion |
characters will be inserted into the line as if they had been |
characters will be inserted into the line as if they had been |
mapped to sseellff--iinnsseerrtt. | mapped to [1mself-insert[22m. |
eeddiittiinngg--mmooddee ((eemmaaccss)) | [1mecho-control-characters (On)[0m |
Controls whether readline begins with a set of key bindings sim- | When set to [1mOn[22m, on operating systems that indicate they support |
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 | |
it, readline echoes a character corresponding to a signal gener- |
it, readline echoes a character corresponding to a signal gener- |
ated from the keyboard. |
ated from the keyboard. |
eennaabbllee--kkeeyyppaadd ((OOffff)) | [1mediting-mode (emacs)[0m |
When set to OOnn, readline will try to enable the application key- | Controls whether readline begins with a set of key bindings sim- |
pad when it is called. Some systems need this to enable the | ilar to [4mEmacs[24m or [4mvi[24m. [1mediting-mode [22mcan be set to either [1memacs [22mor |
arrow keys. | [1mvi[22m. |
eennaabbllee--mmeettaa--kkeeyy ((OOnn)) | [1memacs-mode-string (@)[0m |
When set to OOnn, readline will try to enable any meta modifier | If the [4mshow-mode-in-prompt[24m variable is enabled, this string is |
| displayed immediately before the last line of the primary prompt |
| when emacs editing mode is active. The value is expanded like a |
| key binding, so the standard set of meta- and control prefixes |
| and backslash escape sequences is available. Use the \1 and \2 |
| escapes to begin and end sequences of non-printing characters, |
| which can be used to embed a terminal control sequence into the |
| mode string. |
| [1menable-bracketed-paste (On)[0m |
| When set to [1mOn[22m, readline will configure the terminal in a way |
| that will enable it to insert each paste into the editing buffer |
| as a single string of characters, instead of treating each char- |
| acter as if it had been read from the keyboard. This can pre- |
| vent pasted characters from being interpreted as editing com- |
| mands. |
| [1menable-keypad (Off)[0m |
| When set to [1mOn[22m, readline will try to enable the application key- |
| pad when it is called. Some systems need this to enable the ar- |
| row keys. |
| [1menable-meta-key (On)[0m |
| When set to [1mOn[22m, readline will try to enable any meta modifier |
key the terminal claims to support when it is called. On many |
key the terminal claims to support when it is called. On many |
terminals, the meta key is used to send eight-bit characters. |
terminals, the meta key is used to send eight-bit characters. |
eexxppaanndd--ttiillddee ((OOffff)) | [1mexpand-tilde (Off)[0m |
If set to OOnn, tilde expansion is performed when readline | If set to [1mOn[22m, tilde expansion is performed when readline at- |
attempts word completion. | tempts word completion. |
hhiissttoorryy--pprreesseerrvvee--ppooiinntt ((OOffff)) | [1mhistory-preserve-point (Off)[0m |
If set to OOnn, the history code attempts to place point at the | If set to [1mOn[22m, the history code attempts to place point at the |
same location on each history line retrieved with pprreevviioouuss--hhiiss-- | same location on each history line retrieved with [1mprevious-his-[0m |
ttoorryy or nneexxtt--hhiissttoorryy. | [1mtory [22mor [1mnext-history[22m. |
hhiissttoorryy--ssiizzee ((00)) | [1mhistory-size (unset)[0m |
Set the maximum number of history entries saved in the history |
Set the maximum number of history entries saved in the history |
list. If set to zero, any existing history entries are deleted |
list. If set to zero, any existing history entries are deleted |
and no new entries are saved. If set to a value less than zero, |
and no new entries are saved. If set to a value less than zero, |
the number of history entries is not limited. By default, the |
the number of history entries is not limited. By default, the |
number of history entries is not limited. | number of history entries is not limited. If an attempt is made |
hhoorriizzoonnttaall--ssccrroollll--mmooddee ((OOffff)) | to set [4mhistory-size[24m to a non-numeric value, the maximum number |
When set to OOnn, makes readline use a single line for display, | of history entries will be set to 500. |
| [1mhorizontal-scroll-mode (Off)[0m |
| When set to [1mOn[22m, makes readline use a single line for display, |
scrolling the input horizontally on a single screen line when it |
scrolling the input horizontally on a single screen line when it |
becomes longer than the screen width rather than wrapping to a |
becomes longer than the screen width rather than wrapping to a |
new line. | new line. This setting is automatically enabled for terminals |
iinnppuutt--mmeettaa ((OOffff)) | of height 1. |
If set to OOnn, readline will enable eight-bit input (that is, it | [1minput-meta (Off)[0m |
will not clear the eighth bit in the characters it reads), | If set to [1mOn[22m, readline will enable eight-bit input (that is, it |
regardless of what the terminal claims it can support. The name | will not clear the eighth bit in the characters it reads), re- |
mmeettaa--ffllaagg is a synonym for this variable. | gardless of what the terminal claims it can support. The name |
iisseeaarrcchh--tteerrmmiinnaattoorrss ((````CC--[[ CC--JJ'''')) | [1mmeta-flag [22mis a synonym for this variable. The default is [4mOff[24m, |
The string of characters that should terminate an incremental | but readline will set it to [4mOn[24m if the locale contains eight-bit |
search without subsequently executing the character as a com- | characters. |
mand. If this variable has not been given a value, the charac- | [1misearch-terminators (``C-[ C-J'')[0m |
ters _E_S_C and _C_-_J will terminate an incremental search. | The string of characters that should terminate an incremental |
kkeeyymmaapp ((eemmaaccss)) | search without subsequently executing the character as a com- |
Set the current readline keymap. The set of legal keymap names | mand. If this variable has not been given a value, the charac- |
is _e_m_a_c_s_, _e_m_a_c_s_-_s_t_a_n_d_a_r_d_, _e_m_a_c_s_-_m_e_t_a_, _e_m_a_c_s_-_c_t_l_x_, _v_i_, _v_i_-_m_o_v_e_, | ters [4mESC[24m and [4mC-J[24m will terminate an incremental search. |
_v_i_-_c_o_m_m_a_n_d, and _v_i_-_i_n_s_e_r_t. _v_i is equivalent to _v_i_-_c_o_m_m_a_n_d; | [1mkeymap (emacs)[0m |
_e_m_a_c_s is equivalent to _e_m_a_c_s_-_s_t_a_n_d_a_r_d. The default value is | Set the current readline keymap. The set of legal keymap names |
_e_m_a_c_s. The value of eeddiittiinngg--mmooddee also affects the default | is [4memacs,[24m [4memacs-standard,[24m [4memacs-meta,[24m [4memacs-ctlx,[24m [4mvi,[24m [4mvi-move,[0m |
| [4mvi-command[24m, and [4mvi-insert[24m. [4mvi[24m is equivalent to [4mvi-command[24m; |
| [4memacs[24m is equivalent to [4memacs-standard[24m. The default value is |
| [4memacs[24m. The value of [1mediting-mode [22malso affects the default |
keymap. |
keymap. |
kkeeyysseeqq--ttiimmeeoouutt ((550000)) | [1mkeyseq-timeout (500)[0m |
Specifies the duration _r_e_a_d_l_i_n_e will wait for a character when | Specifies the duration [4mreadline[24m will wait for a character when |
reading an ambiguous key sequence (one that can form a complete | reading an ambiguous key sequence (one that can form a complete |
key sequence using the input read so far, or can take additional |
key sequence using the input read so far, or can take additional |
input to complete a longer key sequence). If no input is | input to complete a longer key sequence). If no input is re- |
received within the timeout, _r_e_a_d_l_i_n_e will use the shorter but | ceived within the timeout, [4mreadline[24m will use the shorter but |
complete key sequence. The value is specified in milliseconds, | complete key sequence. The value is specified in milliseconds, |
so a value of 1000 means that _r_e_a_d_l_i_n_e will wait one second for | so a value of 1000 means that [4mreadline[24m will wait one second for |
additional input. If this variable is set to a value less than | additional input. If this variable is set to a value less than |
or equal to zero, or to a non-numeric value, _r_e_a_d_l_i_n_e will wait | or equal to zero, or to a non-numeric value, [4mreadline[24m will wait |
until another key is pressed to decide which key sequence to | until another key is pressed to decide which key sequence to |
complete. |
complete. |
mmaarrkk--ddiirreeccttoorriieess ((OOnn)) | [1mmark-directories (On)[0m |
If set to OOnn, completed directory names have a slash appended. | If set to [1mOn[22m, completed directory names have a slash appended. |
mmaarrkk--mmooddiiffiieedd--lliinneess ((OOffff)) | [1mmark-modified-lines (Off)[0m |
If set to OOnn, history lines that have been modified are dis- | If set to [1mOn[22m, history lines that have been modified are dis- |
played with a preceding asterisk (**). | played with a preceding asterisk ([1m*[22m). |
mmaarrkk--ssyymmlliinnkkeedd--ddiirreeccttoorriieess ((OOffff)) | [1mmark-symlinked-directories (Off)[0m |
If set to OOnn, completed names which are symbolic links to direc- | If set to [1mOn[22m, completed names which are symbolic links to direc- |
tories have a slash appended (subject to the value of | tories have a slash appended (subject to the value of [1mmark-di-[0m |
mmaarrkk--ddiirreeccttoorriieess). | [1mrectories[22m). |
mmaattcchh--hhiiddddeenn--ffiilleess ((OOnn)) | [1mmatch-hidden-files (On)[0m |
This variable, when set to OOnn, causes readline to match files | This variable, when set to [1mOn[22m, causes readline to match files |
whose names begin with a `.' (hidden files) when performing | whose names begin with a `.' (hidden files) when performing |
filename completion. If set to OOffff, the leading `.' must be | filename completion. If set to [1mOff[22m, the leading `.' must be |
supplied by the user in the filename to be completed. |
supplied by the user in the filename to be completed. |
mmeennuu--ccoommpplleettee--ddiissppllaayy--pprreeffiixx ((OOffff)) | [1mmenu-complete-display-prefix (Off)[0m |
If set to OOnn, menu completion displays the common prefix of the | If set to [1mOn[22m, menu completion displays the common prefix of the |
list of possible completions (which may be empty) before cycling |
list of possible completions (which may be empty) before cycling |
through the list. |
through the list. |
oouuttppuutt--mmeettaa ((OOffff)) | [1moutput-meta (Off)[0m |
If set to OOnn, readline will display characters with the eighth | If set to [1mOn[22m, readline will display characters with the eighth |
bit set directly rather than as a meta-prefixed escape sequence. |
bit set directly rather than as a meta-prefixed escape sequence. |
ppaaggee--ccoommpplleettiioonnss ((OOnn)) | The default is [4mOff[24m, but readline will set it to [4mOn[24m if the locale |
If set to OOnn, readline uses an internal _m_o_r_e-like pager to dis- | contains eight-bit characters. |
| [1mpage-completions (On)[0m |
| If set to [1mOn[22m, readline uses an internal [4mmore[24m-like pager to dis- |
play a screenful of possible completions at a time. |
play a screenful of possible completions at a time. |
pprriinntt--ccoommpplleettiioonnss--hhoorriizzoonnttaallllyy ((OOffff)) | [1mprint-completions-horizontally (Off)[0m |
If set to OOnn, readline will display completions with matches | If set to [1mOn[22m, readline will display completions with matches |
sorted horizontally in alphabetical order, rather than down the |
sorted horizontally in alphabetical order, rather than down the |
screen. |
screen. |
rreevveerrtt--aallll--aatt--nneewwlliinnee ((OOffff)) | [1mrevert-all-at-newline (Off)[0m |
If set to OOnn, readline will undo all changes to history lines | If set to [1mOn[22m, readline will undo all changes to history lines |
before returning when aacccceepptt--lliinnee is executed. By default, his- | before returning when [1maccept-line [22mis executed. By default, his- |
tory lines may be modified and retain individual undo lists |
tory lines may be modified and retain individual undo lists |
across calls to rreeaaddlliinnee. | across calls to [1mreadline[22m. |
sshhooww--aallll--iiff--aammbbiigguuoouuss ((OOffff)) | [1mshow-all-if-ambiguous (Off)[0m |
This alters the default behavior of the completion functions. |
This alters the default behavior of the completion functions. |
If set to OOnn, words which have more than one possible completion | If set to [1mOn[22m, words which have more than one possible completion |
cause the matches to be listed immediately instead of ringing |
cause the matches to be listed immediately instead of ringing |
the bell. |
the bell. |
sshhooww--aallll--iiff--uunnmmooddiiffiieedd ((OOffff)) | [1mshow-all-if-unmodified (Off)[0m |
This alters the default behavior of the completion functions in |
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 [1mshow-all-if-ambiguous[22m. If set to [1mOn[22m, words |
which have more than one possible completion without any possi- |
which have more than one possible completion without any possi- |
ble partial completion (the possible completions don't share a |
ble partial completion (the possible completions don't share a |
common prefix) cause the matches to be listed immediately | common prefix) cause the matches to be listed immediately in- |
instead of ringing the bell. | stead of ringing the bell. |
sshhooww--mmooddee--iinn--pprroommpptt ((OOffff)) | [1mshow-mode-in-prompt (Off)[0m |
If set to OOnn, add a character to the beginning of the prompt | If set to [1mOn[22m, add a string to the beginning of the prompt indi- |
indicating the editing mode: emacs (@), vi command (:) or vi | cating the editing mode: emacs, vi command, or vi insertion. |
insertion (+). | The mode strings are user-settable (e.g., [4memacs-mode-string[24m). |
sskkiipp--ccoommpplleetteedd--tteexxtt ((OOffff)) | [1mskip-completed-text (Off)[0m |
If set to OOnn, this alters the default completion behavior when | If set to [1mOn[22m, this alters the default completion behavior when |
inserting a single match into the line. It's only active when |
inserting a single match into the line. It's only active when |
performing completion in the middle of a word. If enabled, |
performing completion in the middle of a word. If enabled, |
readline does not insert characters from the completion that |
readline does not insert characters from the completion that |
match characters after point in the word being completed, so |
match characters after point in the word being completed, so |
portions of the word following the cursor are not duplicated. |
portions of the word following the cursor are not duplicated. |
vviissiibbllee--ssttaattss ((OOffff)) | [1mvi-cmd-mode-string ((cmd))[0m |
If set to OOnn, a character denoting a file's type as reported by | If the [4mshow-mode-in-prompt[24m variable is enabled, this string is |
_s_t_a_t(2) is appended to the filename when listing possible com- | displayed immediately before the last line of the primary prompt |
| when vi editing mode is active and in command mode. The value |
| is expanded like a key binding, so the standard set of meta- and |
| control prefixes and backslash escape sequences is available. |
| Use the \1 and \2 escapes to begin and end sequences of non- |
| printing characters, which can be used to embed a terminal con- |
| trol sequence into the mode string. |
| [1mvi-ins-mode-string ((ins))[0m |
| If the [4mshow-mode-in-prompt[24m variable is enabled, this string is |
| displayed immediately before the last line of the primary prompt |
| when vi editing mode is active and in insertion mode. The value |
| is expanded like a key binding, so the standard set of meta- and |
| control prefixes and backslash escape sequences is available. |
| Use the \1 and \2 escapes to begin and end sequences of non- |
| printing characters, which can be used to embed a terminal con- |
| trol sequence into the mode string. |
| [1mvisible-stats (Off)[0m |
| If set to [1mOn[22m, a character denoting a file's type as reported by |
| [4mstat[24m(2) is appended to the filename when listing possible com- |
pletions. |
pletions. |
|
|
CCoonnddiittiioonnaall CCoonnssttrruuccttss | [1mConditional Constructs[0m |
Readline implements a facility similar in spirit to the conditional |
Readline implements a facility similar in spirit to the conditional |
compilation features of the C preprocessor which allows key bindings |
compilation features of the C preprocessor which allows key bindings |
and variable settings to be performed as the result of tests. There |
and variable settings to be performed as the result of tests. There |
are four parser directives used. |
are four parser directives used. |
|
|
$$iiff The $$iiff construct allows bindings to be made based on the edit- | [1m$if [22mThe [1m$if [22mconstruct allows bindings to be made based on the edit- |
ing mode, the terminal being used, or the application using |
ing mode, the terminal being used, or the application using |
readline. The text of the test extends to the end of the line; | readline. The text of the test, after any comparison operator, |
no characters are required to isolate it. | extends to the end of the line; unless otherwise noted, no char- |
| acters are required to isolate it. |
|
|
mmooddee The mmooddee== form of the $$iiff directive is used to test | [1mmode [22mThe [1mmode= [22mform of the [1m$if [22mdirective is used to test |
whether readline is in emacs or vi mode. This may be | whether readline is in emacs or vi mode. This may be |
used in conjunction with the sseett kkeeyymmaapp command, for | used in conjunction with the [1mset keymap [22mcommand, for in- |
instance, to set bindings in the _e_m_a_c_s_-_s_t_a_n_d_a_r_d and | stance, to set bindings in the [4memacs-standard[24m and [4memacs-[0m |
_e_m_a_c_s_-_c_t_l_x keymaps only if readline is starting out in | [4mctlx[24m keymaps only if readline is starting out in emacs |
emacs mode. | mode. |
|
|
tteerrmm The tteerrmm== form may be used to include terminal-specific | [1mterm [22mThe [1mterm= [22mform may be used to include terminal-specific |
key bindings, perhaps to bind the key sequences output by |
key bindings, perhaps to bind the key sequences output by |
the terminal's function keys. The word on the right side |
the terminal's function keys. The word on the right side |
of the == is tested against the full name of the terminal | of the [1m= [22mis tested against the full name of the terminal |
and the portion of the terminal name before the first --. | and the portion of the terminal name before the first [1m-[22m. |
This allows _s_u_n to match both _s_u_n and _s_u_n_-_c_m_d, for | This allows [4msun[24m to match both [4msun[24m and [4msun-cmd[24m, for in- |
instance. | stance. |
|
|
aapppplliiccaattiioonn | [1mversion[0m |
The aapppplliiccaattiioonn construct is used to include application- | The [1mversion [22mtest may be used to perform comparisons |
specific settings. Each program using the readline | against specific readline versions. The [1mversion [22mexpands |
library sets the _a_p_p_l_i_c_a_t_i_o_n _n_a_m_e, and an initialization | to the current readline version. The set of comparison |
| operators includes [1m=[22m, (and [1m==[22m), [1m!=[22m, [1m<=[22m, [1m>=[22m, [1m<[22m, and [1m>[22m. |
| The version number supplied on the right side of the op- |
| erator consists of a major version number, an optional |
| decimal point, and an optional minor version (e.g., [1m7.1[22m). |
| If the minor version is omitted, it is assumed to be [1m0[22m. |
| The operator may be separated from the string [1mversion [22mand |
| from the version number argument by whitespace. |
| |
| [1mapplication[0m |
| The [1mapplication [22mconstruct is used to include application- |
| specific settings. Each program using the readline li- |
| brary sets the [4mapplication[24m [4mname[24m, and an initialization |
file can test for a particular value. This could be used |
file can test for a particular value. This could be used |
to bind key sequences to functions useful for a specific |
to bind key sequences to functions useful for a specific |
program. For instance, the following command adds a key |
program. For instance, the following command adds a key |
sequence that quotes the current or previous word in |
sequence that quotes the current or previous word in |
bbaasshh: | [1mbash[22m: |
|
|
$$iiff Bash | [1m$if [22mBash |
# Quote the current or previous word |
# Quote the current or previous word |
"\C-xq": "\eb\"\ef\"" |
"\C-xq": "\eb\"\ef\"" |
$$eennddiiff | [1m$endif[0m |
|
|
$$eennddiiff This command, as seen in the previous example, terminates an $$iiff | [4mvariable[0m |
| The [4mvariable[24m construct provides simple equality tests for |
| readline variables and values. The permitted comparison |
| operators are [4m=[24m, [4m==[24m, and [4m!=[24m. The variable name must be |
| separated from the comparison operator by whitespace; the |
| operator may be separated from the value on the right |
| hand side by whitespace. Both string and boolean vari- |
| ables may be tested. Boolean variables must be tested |
| against the values [4mon[24m and [4moff[24m. |
| |
| [1m$endif [22mThis command, as seen in the previous example, terminates an [1m$if[0m |
command. |
command. |
|
|
$$eellssee Commands in this branch of the $$iiff directive are executed if the | [1m$else [22mCommands in this branch of the [1m$if [22mdirective are executed if the |
test fails. |
test fails. |
|
|
$$iinncclluuddee | [1m$include[0m |
This directive takes a single filename as an argument and reads | This directive takes a single filename as an argument and reads |
commands and bindings from that file. For example, the follow- | commands and bindings from that file. For example, the follow- |
ing directive would read _/_e_t_c_/_i_n_p_u_t_r_c: | ing directive would read [4m/etc/inputrc[24m: |
|
|
$$iinncclluuddee _/_e_t_c_/_i_n_p_u_t_r_c | [1m$include [4m[22m/etc/inputrc[0m |
|
|
SSEEAARRCCHHIINNGG | [1mSEARCHING[0m |
Readline provides commands for searching through the command history | Readline provides commands for searching through the command history |
for lines containing a specified string. There are two search modes: | 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. | [4mincremental[24m and [4mnon-incremental[24m. |
|
|
Incremental searches begin before the user has finished typing the | Incremental searches begin before the user has finished typing the |
search string. As each character of the search string is typed, read- | search string. As each character of the search string is typed, read- |
line displays the next entry from the history matching the string typed |
line displays the next entry from the history matching the string typed |
so far. An incremental search requires only as many characters as | so far. An incremental search requires only as many characters as |
needed to find the desired history entry. To search backward in the | needed to find the desired history entry. To search backward in the |
history for a particular string, type CC--rr. Typing CC--ss searches forward | history for a particular string, type [1mC-r[22m. Typing [1mC-s [22msearches forward |
through the history. The characters present in the value of the | through the history. The characters present in the value of the |
iisseeaarrcchh--tteerrmmiinnaattoorrss variable are used to terminate an incremental | [1misearch-terminators [22mvariable are used to terminate an incremental |
search. If that variable has not been assigned a value the _E_s_c_a_p_e and | search. If that variable has not been assigned a value the [4mEscape[24m and |
CC--JJ characters will terminate an incremental search. CC--GG will abort an | [1mC-J [22mcharacters will terminate an incremental search. [1mC-G [22mwill abort an |
incremental search and restore the original line. When the search is | incremental search and restore the original line. When the search is |
terminated, the history entry containing the search string becomes the | terminated, the history entry containing the search string becomes the |
current line. |
current line. |
|
|
To find other matching entries in the history list, type CC--ss or CC--rr as | To find other matching entries in the history list, type [1mC-s [22mor [1mC-r [22mas |
appropriate. This will search backward or forward in the history for | appropriate. This will search backward or forward in the history for |
the next line matching the search string typed so far. Any other key | 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- |
sequence bound to a readline command will terminate the search and exe- |
cute that command. For instance, a newline will terminate the search | cute that command. For instance, a newline will terminate the search |
and accept the line, thereby executing the command from the history | and accept the line, thereby executing the command from the history |
list. A movement command will terminate the search, make the last line |
list. A movement command will terminate the search, make the last line |
found the current line, and begin editing. |
found the current line, and begin editing. |
|
|
Non-incremental searches read the entire search string before starting | Non-incremental searches read the entire search string before starting |
to search for matching history lines. The search string may be typed | 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. |
by the user or be part of the contents of the current line. |
|
|
EEDDIITTIINNGG CCOOMMMMAANNDDSS | [1mEDITING COMMANDS[0m |
The following is a list of the names of the commands and the default | The following is a list of the names of the commands and the default |
key sequences to which they are bound. Command names without an accom- |
key sequences to which they are bound. Command names without an accom- |
panying key sequence are unbound by default. |
panying key sequence are unbound by default. |
|
|
In the following descriptions, _p_o_i_n_t refers to the current cursor posi- | In the following descriptions, [4mpoint[24m refers to the current cursor posi- |
tion, and _m_a_r_k refers to a cursor position saved by the sseett--mmaarrkk com- | tion, and [4mmark[24m refers to a cursor position saved by the [1mset-mark [22mcom- |
mand. The text between the point and mark is referred to as the | mand. The text between the point and mark is referred to as the [4mre-[0m |
_r_e_g_i_o_n. | [4mgion[24m. |
|
|
CCoommmmaannddss ffoorr MMoovviinngg | [1mCommands for Moving[0m |
bbeeggiinnnniinngg--ooff--lliinnee ((CC--aa)) | [1mbeginning-of-line (C-a)[0m |
Move to the start of the current line. |
Move to the start of the current line. |
eenndd--ooff--lliinnee ((CC--ee)) | [1mend-of-line (C-e)[0m |
Move to the end of the line. |
Move to the end of the line. |
ffoorrwwaarrdd--cchhaarr ((CC--ff)) | [1mforward-char (C-f)[0m |
Move forward a character. |
Move forward a character. |
bbaacckkwwaarrdd--cchhaarr ((CC--bb)) | [1mbackward-char (C-b)[0m |
Move back a character. |
Move back a character. |
ffoorrwwaarrdd--wwoorrdd ((MM--ff)) | [1mforward-word (M-f)[0m |
Move forward to the end of the next word. Words are composed of |
Move forward to the end of the next word. Words are composed of |
alphanumeric characters (letters and digits). |
alphanumeric characters (letters and digits). |
bbaacckkwwaarrdd--wwoorrdd ((MM--bb)) | [1mbackward-word (M-b)[0m |
Move back to the start of the current or previous word. Words | Move back to the start of the current or previous word. Words |
are composed of alphanumeric characters (letters and digits). |
are composed of alphanumeric characters (letters and digits). |
cclleeaarr--ssccrreeeenn ((CC--ll)) | [1mprevious-screen-line[0m |
Clear the screen leaving the current line at the top of the | Attempt to move point to the same physical screen column on the |
screen. With an argument, refresh the current line without | previous physical screen line. This will not have the desired |
clearing the screen. | effect if the current Readline line does not take up more than |
rreeddrraaww--ccuurrrreenntt--lliinnee | one physical line or if point is not greater than the length of |
| the prompt plus the screen width. |
| [1mnext-screen-line[0m |
| Attempt to move point to the same physical screen column on the |
| next physical screen line. This will not have the desired effect |
| if the current Readline line does not take up more than one |
| physical line or if the length of the current Readline line is |
| not greater than the length of the prompt plus the screen width. |
| [1mclear-display (M-C-l)[0m |
| Clear the screen and, if possible, the terminal's scrollback |
| buffer, then redraw the current line, leaving the current line |
| at the top of the screen. |
| [1mclear-screen (C-l)[0m |
| Clear the screen, then redraw the current line, leaving the cur- |
| rent line at the top of the screen. With an argument, refresh |
| the current line without clearing the screen. |
| [1mredraw-current-line[0m |
Refresh the current line. |
Refresh the current line. |
|
|
CCoommmmaannddss ffoorr MMaanniippuullaattiinngg tthhee HHiissttoorryy | [1mCommands for Manipulating the History[0m |
aacccceepptt--lliinnee ((NNeewwlliinnee,, RReettuurrnn)) | [1maccept-line (Newline, Return)[0m |
Accept the line regardless of where the cursor is. If this line |
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 | is non-empty, it may be added to the history list for future re- |
recall with aadddd__hhiissttoorryy(()). If the line is a modified history | call with [1madd_history()[22m. If the line is a modified history |
line, the history line is restored to its original state. |
line, the history line is restored to its original state. |
pprreevviioouuss--hhiissttoorryy ((CC--pp)) | [1mprevious-history (C-p)[0m |
Fetch the previous command from the history list, moving back in |
Fetch the previous command from the history list, moving back in |
the list. |
the list. |
nneexxtt--hhiissttoorryy ((CC--nn)) | [1mnext-history (C-n)[0m |
Fetch the next command from the history list, moving forward in | Fetch the next command from the history list, moving forward in |
the list. |
the list. |
bbeeggiinnnniinngg--ooff--hhiissttoorryy ((MM--<<)) | [1mbeginning-of-history (M-<)[0m |
Move to the first line in the history. |
Move to the first line in the history. |
eenndd--ooff--hhiissttoorryy ((MM-->>)) | [1mend-of-history (M->)[0m |
Move to the end of the input history, i.e., the line currently | Move to the end of the input history, i.e., the line currently |
being entered. |
being entered. |
rreevveerrssee--sseeaarrcchh--hhiissttoorryy ((CC--rr)) | [1mreverse-search-history (C-r)[0m |
Search backward starting at the current line and moving `up' | Search backward starting at the current line and moving `up' |
through the history as necessary. This is an incremental | through the history as necessary. This is an incremental |
search. |
search. |
ffoorrwwaarrdd--sseeaarrcchh--hhiissttoorryy ((CC--ss)) | [1mforward-search-history (C-s)[0m |
Search forward starting at the current line and moving `down' | Search forward starting at the current line and moving `down' |
through the history as necessary. This is an incremental | through the history as necessary. This is an incremental |
search. |
search. |
nnoonn--iinnccrreemmeennttaall--rreevveerrssee--sseeaarrcchh--hhiissttoorryy ((MM--pp)) | [1mnon-incremental-reverse-search-history (M-p)[0m |
Search backward through the history starting at the current line |
Search backward through the history starting at the current line |
using a non-incremental search for a string supplied by the | using a non-incremental search for a string supplied by the |
user. |
user. |
nnoonn--iinnccrreemmeennttaall--ffoorrwwaarrdd--sseeaarrcchh--hhiissttoorryy ((MM--nn)) | [1mnon-incremental-forward-search-history (M-n)[0m |
Search forward through the history using a non-incremental | Search forward through the history using a non-incremental |
search for a string supplied by the user. |
search for a string supplied by the user. |
hhiissttoorryy--sseeaarrcchh--bbaacckkwwaarrdd | [1mhistory-search-backward[0m |
Search backward through the history for the string of characters |
Search backward through the history for the string of characters |
between the start of the current line and the current cursor | between the start of the current line and the current cursor po- |
position (the _p_o_i_n_t). The search string must match at the | sition (the [4mpoint[24m). The search string must match at the begin- |
beginning of a history line. This is a non-incremental search. | ning of a history line. This is a non-incremental search. |
hhiissttoorryy--sseeaarrcchh--ffoorrwwaarrdd | [1mhistory-search-forward[0m |
Search forward through the history for the string of characters |
Search forward through the history for the string of characters |
between the start of the current line and the point. The search |
between the start of the current line and the point. The search |
string must match at the beginning of a history line. This is a |
string must match at the beginning of a history line. This is a |
non-incremental search. |
non-incremental search. |
hhiissttoorryy--ssuubbssttrriinngg--sseeaarrcchh--bbaacckkwwaarrdd | [1mhistory-substring-search-backward[0m |
Search backward through the history for the string of characters |
Search backward through the history for the string of characters |
between the start of the current line and the current cursor | between the start of the current line and the current cursor po- |
position (the _p_o_i_n_t). The search string may match anywhere in a | sition (the [4mpoint[24m). The search string may match anywhere in a |
history line. This is a non-incremental search. |
history line. This is a non-incremental search. |
hhiissttoorryy--ssuubbssttrriinngg--sseeaarrcchh--ffoorrwwaarrdd | [1mhistory-substring-search-forward[0m |
Search forward through the history for the string of characters |
Search forward through the history for the string of characters |
between the start of the current line and the point. The search |
between the start of the current line and the point. The search |
string may match anywhere in a history line. This is a non- | string may match anywhere in a history line. This is a non-in- |
incremental search. | cremental search. |
yyaannkk--nntthh--aarrgg ((MM--CC--yy)) | [1myank-nth-arg (M-C-y)[0m |
Insert the first argument to the previous command (usually the |
Insert the first argument to the previous command (usually the |
second word on the previous line) at point. With an argument _n, | second word on the previous line) at point. With an argument [4mn[24m, |
insert the _nth word from the previous command (the words in the | insert the [4mn[24mth word from the previous command (the words in the |
previous command begin with word 0). A negative argument | previous command begin with word 0). A negative argument in- |
inserts the _nth word from the end of the previous command. Once | serts the [4mn[24mth word from the end of the previous command. Once |
the argument _n is computed, the argument is extracted as if the | the argument [4mn[24m is computed, the argument is extracted as if the |
"!_n" history expansion had been specified. | "![4mn[24m" history expansion had been specified. |
yyaannkk--llaasstt--aarrgg ((MM--..,, MM--__)) | [1myank-last-arg (M-., M-_)[0m |
Insert the last argument to the previous command (the last word |
Insert the last argument to the previous command (the last word |
of the previous history entry). With a numeric argument, behave |
of the previous history entry). With a numeric argument, behave |
exactly like yyaannkk--nntthh--aarrgg. Successive calls to yyaannkk--llaasstt--aarrgg | exactly like [1myank-nth-arg[22m. Successive calls to [1myank-last-arg[0m |
move back through the history list, inserting the last word (or |
move back through the history list, inserting the last word (or |
the word specified by the argument to the first call) of each |
the word specified by the argument to the first call) of each |
line in turn. Any numeric argument supplied to these successive |
line in turn. Any numeric argument supplied to these successive |
Line 543 EEDDIITTIINNGG CCOOMMMMAANNDDSS
|
Line 631 EEDDIITTIINNGG CCOOMMMMAANNDDSS
|
(back or forward). The history expansion facilities are used to |
(back or forward). The history expansion facilities are used to |
extract the last argument, as if the "!$" history expansion had |
extract the last argument, as if the "!$" history expansion had |
been specified. |
been specified. |
|
[1moperate-and-get-next (C-o)[0m |
|
Accept the current line for return to the calling application as |
|
if a newline had been entered, and fetch the next line relative |
|
to the current line from the history for editing. A numeric ar- |
|
gument, if supplied, specifies the history entry to use instead |
|
of the current line. |
|
|
CCoommmmaannddss ffoorr CChhaannggiinngg TTeexxtt | [1mCommands for Changing Text[0m |
_e_n_d_-_o_f_-_f_i_l_e ((uussuuaallllyy CC--dd)) | [4mend-of-file[24m [1m(usually C-d)[0m |
The character indicating end-of-file as set, for example, by |
The character indicating end-of-file as set, for example, by |
``stty''. If this character is read when there are no charac- |
``stty''. If this character is read when there are no charac- |
ters on the line, and point is at the beginning of the line, |
ters on the line, and point is at the beginning of the line, |
Readline interprets it as the end of input and returns EEOOFF. | Readline interprets it as the end of input and returns [1mEOF[22m. |
ddeelleettee--cchhaarr ((CC--dd)) | [1mdelete-char (C-d)[0m |
Delete the character at point. If this function is bound to the |
Delete the character at point. If this function is bound to the |
same character as the tty EEOOFF character, as CC--dd commonly is, see | same character as the tty [1mEOF [22mcharacter, as [1mC-d [22mcommonly is, see |
above for the effects. |
above for the effects. |
bbaacckkwwaarrdd--ddeelleettee--cchhaarr ((RRuubboouutt)) | [1mbackward-delete-char (Rubout)[0m |
Delete the character behind the cursor. When given a numeric |
Delete the character behind the cursor. When given a numeric |
argument, save the deleted text on the kill ring. |
argument, save the deleted text on the kill ring. |
ffoorrwwaarrdd--bbaacckkwwaarrdd--ddeelleettee--cchhaarr | [1mforward-backward-delete-char[0m |
Delete the character under the cursor, unless the cursor is at |
Delete the character under the cursor, unless the cursor is at |
the end of the line, in which case the character behind the cur- |
the end of the line, in which case the character behind the cur- |
sor is deleted. |
sor is deleted. |
qquuootteedd--iinnsseerrtt ((CC--qq,, CC--vv)) | [1mquoted-insert (C-q, C-v)[0m |
Add the next character that you type to the line verbatim. This |
Add the next character that you type to the line verbatim. This |
is how to insert characters like CC--qq, for example. | is how to insert characters like [1mC-q[22m, for example. |
ttaabb--iinnsseerrtt ((MM--TTAABB)) | [1mtab-insert (M-TAB)[0m |
Insert a tab character. |
Insert a tab character. |
sseellff--iinnsseerrtt ((aa,, bb,, AA,, 11,, !!,, ......)) | [1mself-insert (a, b, A, 1, !, ...)[0m |
Insert the character typed. |
Insert the character typed. |
ttrraannssppoossee--cchhaarrss ((CC--tt)) | [1mtranspose-chars (C-t)[0m |
Drag the character before point forward over the character at |
Drag the character before point forward over the character at |
point, moving point forward as well. If point is at the end of |
point, moving point forward as well. If point is at the end of |
the line, then this transposes the two characters before point. |
the line, then this transposes the two characters before point. |
Negative arguments have no effect. |
Negative arguments have no effect. |
ttrraannssppoossee--wwoorrddss ((MM--tt)) | [1mtranspose-words (M-t)[0m |
Drag the word before point past the word after point, moving |
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 |
point over that word as well. If point is at the end of the |
line, this transposes the last two words on the line. |
line, this transposes the last two words on the line. |
uuppccaassee--wwoorrdd ((MM--uu)) | [1mupcase-word (M-u)[0m |
Uppercase the current (or following) word. With a negative | Uppercase the current (or following) word. With a negative ar- |
argument, uppercase the previous word, but do not move point. | gument, uppercase the previous word, but do not move point. |
ddoowwnnccaassee--wwoorrdd ((MM--ll)) | [1mdowncase-word (M-l)[0m |
Lowercase the current (or following) word. With a negative | Lowercase the current (or following) word. With a negative ar- |
argument, lowercase the previous word, but do not move point. | gument, lowercase the previous word, but do not move point. |
ccaappiittaalliizzee--wwoorrdd ((MM--cc)) | [1mcapitalize-word (M-c)[0m |
Capitalize the current (or following) word. With a negative | Capitalize the current (or following) word. With a negative ar- |
argument, capitalize the previous word, but do not move point. | gument, capitalize the previous word, but do not move point. |
oovveerrwwrriittee--mmooddee | [1moverwrite-mode[0m |
Toggle overwrite mode. With an explicit positive numeric argu- |
Toggle overwrite mode. With an explicit positive numeric argu- |
ment, switches to overwrite mode. With an explicit non-positive |
ment, switches to overwrite mode. With an explicit non-positive |
numeric argument, switches to insert mode. This command affects |
numeric argument, switches to insert mode. This command affects |
only eemmaaccss mode; vvii mode does overwrite differently. Each call | only [1memacs [22mmode; [1mvi [22mmode does overwrite differently. Each call |
to _r_e_a_d_l_i_n_e_(_) starts in insert mode. In overwrite mode, charac- | to [4mreadline()[24m starts in insert mode. In overwrite mode, charac- |
ters bound to sseellff--iinnsseerrtt replace the text at point rather than | ters bound to [1mself-insert [22mreplace the text at point rather than |
pushing the text to the right. Characters bound to bbaacckk-- | pushing the text to the right. Characters bound to [1mback-[0m |
wwaarrdd--ddeelleettee--cchhaarr replace the character before point with a | [1mward-delete-char [22mreplace the character before point with a |
space. By default, this command is unbound. |
space. By default, this command is unbound. |
|
|
KKiilllliinngg aanndd YYaannkkiinngg | [1mKilling and Yanking[0m |
kkiillll--lliinnee ((CC--kk)) | [1mkill-line (C-k)[0m |
Kill the text from point to the end of the line. |
Kill the text from point to the end of the line. |
bbaacckkwwaarrdd--kkiillll--lliinnee ((CC--xx RRuubboouutt)) | [1mbackward-kill-line (C-x Rubout)[0m |
Kill backward to the beginning of the line. |
Kill backward to the beginning of the line. |
uunniixx--lliinnee--ddiissccaarrdd ((CC--uu)) | [1munix-line-discard (C-u)[0m |
Kill backward from point to the beginning of the line. The |
Kill backward from point to the beginning of the line. The |
killed text is saved on the kill-ring. |
killed text is saved on the kill-ring. |
kkiillll--wwhhoollee--lliinnee | [1mkill-whole-line[0m |
Kill all characters on the current line, no matter where point |
Kill all characters on the current line, no matter where point |
is. |
is. |
kkiillll--wwoorrdd ((MM--dd)) | [1mkill-word (M-d)[0m |
Kill from point the end of the current word, or if between |
Kill from point the end of the current word, or if between |
words, to the end of the next word. Word boundaries are the |
words, to the end of the next word. Word boundaries are the |
same as those used by ffoorrwwaarrdd--wwoorrdd. | same as those used by [1mforward-word[22m. |
bbaacckkwwaarrdd--kkiillll--wwoorrdd ((MM--RRuubboouutt)) | [1mbackward-kill-word (M-Rubout)[0m |
Kill the word behind point. Word boundaries are the same as |
Kill the word behind point. Word boundaries are the same as |
those used by bbaacckkwwaarrdd--wwoorrdd. | those used by [1mbackward-word[22m. |
uunniixx--wwoorrdd--rruubboouutt ((CC--ww)) | [1munix-word-rubout (C-w)[0m |
Kill the word behind point, using white space as a word bound- |
Kill the word behind point, using white space as a word bound- |
ary. The killed text is saved on the kill-ring. |
ary. The killed text is saved on the kill-ring. |
uunniixx--ffiilleennaammee--rruubboouutt | [1munix-filename-rubout[0m |
Kill the word behind point, using white space and the slash |
Kill the word behind point, using white space and the slash |
character as the word boundaries. The killed text is saved on |
character as the word boundaries. The killed text is saved on |
the kill-ring. |
the kill-ring. |
ddeelleettee--hhoorriizzoonnttaall--ssppaaccee ((MM--\\)) | [1mdelete-horizontal-space (M-\)[0m |
Delete all spaces and tabs around point. |
Delete all spaces and tabs around point. |
kkiillll--rreeggiioonn | [1mkill-region[0m |
Kill the text between the point and _m_a_r_k (saved cursor posi- | Kill the text between the point and [4mmark[24m (saved cursor posi- |
tion). This text is referred to as the _r_e_g_i_o_n. | tion). This text is referred to as the [4mregion[24m. |
ccooppyy--rreeggiioonn--aass--kkiillll | [1mcopy-region-as-kill[0m |
Copy the text in the region to the kill buffer. |
Copy the text in the region to the kill buffer. |
ccooppyy--bbaacckkwwaarrdd--wwoorrdd | [1mcopy-backward-word[0m |
Copy the word before point to the kill buffer. The word bound- |
Copy the word before point to the kill buffer. The word bound- |
aries are the same as bbaacckkwwaarrdd--wwoorrdd. | aries are the same as [1mbackward-word[22m. |
ccooppyy--ffoorrwwaarrdd--wwoorrdd | [1mcopy-forward-word[0m |
Copy the word following point to the kill buffer. The word |
Copy the word following point to the kill buffer. The word |
boundaries are the same as ffoorrwwaarrdd--wwoorrdd. | boundaries are the same as [1mforward-word[22m. |
yyaannkk ((CC--yy)) | [1myank (C-y)[0m |
Yank the top of the kill ring into the buffer at point. |
Yank the top of the kill ring into the buffer at point. |
yyaannkk--ppoopp ((MM--yy)) | [1myank-pop (M-y)[0m |
Rotate the kill ring, and yank the new top. Only works follow- |
Rotate the kill ring, and yank the new top. Only works follow- |
ing yyaannkk or yyaannkk--ppoopp. | ing [1myank [22mor [1myank-pop[22m. |
|
|
NNuummeerriicc AArrgguummeennttss | [1mNumeric Arguments[0m |
ddiiggiitt--aarrgguummeenntt ((MM--00,, MM--11,, ......,, MM----)) | [1mdigit-argument (M-0, M-1, ..., M--)[0m |
Add this digit to the argument already accumulating, or start a |
Add this digit to the argument already accumulating, or start a |
new argument. M-- starts a negative argument. |
new argument. M-- starts a negative argument. |
uunniivveerrssaall--aarrgguummeenntt | [1muniversal-argument[0m |
This is another way to specify an argument. If this command is |
This is another way to specify an argument. If this command is |
followed by one or more digits, optionally with a leading minus |
followed by one or more digits, optionally with a leading minus |
sign, those digits define the argument. If the command is fol- |
sign, those digits define the argument. If the command is fol- |
lowed by digits, executing uunniivveerrssaall--aarrgguummeenntt again ends the | lowed by digits, executing [1muniversal-argument [22magain ends the nu- |
numeric argument, but is otherwise ignored. As a special case, | meric argument, but is otherwise ignored. As a special case, if |
if this command is immediately followed by a character that is | this command is immediately followed by a character that is nei- |
neither a digit or minus sign, the argument count for the next | ther a digit or minus sign, the argument count for the next com- |
command is multiplied by four. The argument count is initially | mand is multiplied by four. The argument count is initially |
one, so executing this function the first time makes the argu- |
one, so executing this function the first time makes the argu- |
ment count four, a second time makes the argument count sixteen, |
ment count four, a second time makes the argument count sixteen, |
and so on. |
and so on. |
|
|
CCoommpplleettiinngg | [1mCompleting[0m |
ccoommpplleettee ((TTAABB)) | [1mcomplete (TAB)[0m |
Attempt to perform completion on the text before point. The | Attempt to perform completion on the text before point. The ac- |
actual completion performed is application-specific. BBaasshh, for | tual completion performed is application-specific. [1mBash[22m, for |
instance, attempts completion treating the text as a variable |
instance, attempts completion treating the text as a variable |
(if the text begins with $$), username (if the text begins with | (if the text begins with [1m$[22m), username (if the text begins with |
~~), hostname (if the text begins with @@), or command (including | [1m~[22m), hostname (if the text begins with [1m@[22m), or command (including |
aliases and functions) in turn. If none of these produces a |
aliases and functions) in turn. If none of these produces a |
match, filename completion is attempted. GGddbb, on the other | match, filename completion is attempted. [1mGdb[22m, on the other |
hand, allows completion of program functions and variables, and |
hand, allows completion of program functions and variables, and |
only attempts filename completion under certain circumstances. |
only attempts filename completion under certain circumstances. |
ppoossssiibbllee--ccoommpplleettiioonnss ((MM--??)) | [1mpossible-completions (M-?)[0m |
List the possible completions of the text before point. When |
List the possible completions of the text before point. When |
displaying completions, readline sets the number of columns used |
displaying completions, readline sets the number of columns used |
for display to the value of ccoommpplleettiioonn--ddiissppllaayy--wwiiddtthh, the value | for display to the value of [1mcompletion-display-width[22m, the value |
of the environment variable CCOOLLUUMMNNSS, or the screen width, in | of the environment variable [1mCOLUMNS[22m, or the screen width, in |
that order. |
that order. |
iinnsseerrtt--ccoommpplleettiioonnss ((MM--**)) | [1minsert-completions (M-*)[0m |
Insert all completions of the text before point that would have |
Insert all completions of the text before point that would have |
been generated by ppoossssiibbllee--ccoommpplleettiioonnss. | been generated by [1mpossible-completions[22m. |
mmeennuu--ccoommpplleettee | [1mmenu-complete[0m |
Similar to ccoommpplleettee, but replaces the word to be completed with | Similar to [1mcomplete[22m, but replaces the word to be completed with |
a single match from the list of possible completions. Repeated |
a single match from the list of possible completions. Repeated |
execution of mmeennuu--ccoommpplleettee steps through the list of possible | execution of [1mmenu-complete [22msteps through the list of possible |
completions, inserting each match in turn. At the end of the |
completions, inserting each match in turn. At the end of the |
list of completions, the bell is rung (subject to the setting of |
list of completions, the bell is rung (subject to the setting of |
bbeellll--ssttyyllee) and the original text is restored. An argument of _n | [1mbell-style[22m) and the original text is restored. An argument of [4mn[0m |
moves _n positions forward in the list of matches; a negative | moves [4mn[24m positions forward in the list of matches; a negative ar- |
argument may be used to move backward through the list. This | gument may be used to move backward through the list. This com- |
command is intended to be bound to TTAABB, but is unbound by | mand is intended to be bound to [1mTAB[22m, but is unbound by default. |
default. | [1mmenu-complete-backward[0m |
mmeennuu--ccoommpplleettee--bbaacckkwwaarrdd | Identical to [1mmenu-complete[22m, but moves backward through the list |
Identical to mmeennuu--ccoommpplleettee, but moves backward through the list | of possible completions, as if [1mmenu-complete [22mhad been given a |
of possible completions, as if mmeennuu--ccoommpplleettee had been given a | |
negative argument. This command is unbound by default. |
negative argument. This command is unbound by default. |
ddeelleettee--cchhaarr--oorr--lliisstt | [1mdelete-char-or-list[0m |
Deletes the character under the cursor if not at the beginning | Deletes the character under the cursor if not at the beginning |
or end of the line (like ddeelleettee--cchhaarr). If at the end of the | or end of the line (like [1mdelete-char[22m). If at the end of the |
line, behaves identically to ppoossssiibbllee--ccoommpplleettiioonnss. | line, behaves identically to [1mpossible-completions[22m. |
|
|
KKeeyybbooaarrdd MMaaccrrooss | [1mKeyboard Macros[0m |
ssttaarrtt--kkbbdd--mmaaccrroo ((CC--xx (()) | [1mstart-kbd-macro (C-x ()[0m |
Begin saving the characters typed into the current keyboard | Begin saving the characters typed into the current keyboard |
macro. |
macro. |
eenndd--kkbbdd--mmaaccrroo ((CC--xx )))) | [1mend-kbd-macro (C-x ))[0m |
Stop saving the characters typed into the current keyboard macro |
Stop saving the characters typed into the current keyboard macro |
and store the definition. |
and store the definition. |
ccaallll--llaasstt--kkbbdd--mmaaccrroo ((CC--xx ee)) | [1mcall-last-kbd-macro (C-x e)[0m |
Re-execute the last keyboard macro defined, by making the char- | Re-execute the last keyboard macro defined, by making the char- |
acters in the macro appear as if typed at the keyboard. | acters in the macro appear as if typed at the keyboard. |
pprriinntt--llaasstt--kkbbdd--mmaaccrroo (()) Print the last keyboard macro defined in | [1mprint-last-kbd-macro ()[0m |
a format suitable for the _i_n_p_u_t_r_c file. | Print the last keyboard macro defined in a format suitable for |
| the [4minputrc[24m file. |
|
|
MMiisscceellllaanneeoouuss | [1mMiscellaneous[0m |
rree--rreeaadd--iinniitt--ffiillee ((CC--xx CC--rr)) | [1mre-read-init-file (C-x C-r)[0m |
Read in the contents of the _i_n_p_u_t_r_c file, and incorporate any | Read in the contents of the [4minputrc[24m file, and incorporate any |
bindings or variable assignments found there. |
bindings or variable assignments found there. |
aabboorrtt ((CC--gg)) | [1mabort (C-g)[0m |
Abort the current editing command and ring the terminal's bell |
Abort the current editing command and ring the terminal's bell |
(subject to the setting of bbeellll--ssttyyllee). | (subject to the setting of [1mbell-style[22m). |
ddoo--uuppppeerrccaassee--vveerrssiioonn ((MM--aa,, MM--bb,, MM--_x,, ......)) | [1mdo-lowercase-version (M-A, M-B, M-[4m[22mx[24m[1m, ...)[0m |
If the metafied character _x is lowercase, run the command that | If the metafied character [4mx[24m is uppercase, run the command that |
is bound to the corresponding uppercase character. | is bound to the corresponding metafied lowercase character. The |
pprreeffiixx--mmeettaa ((EESSCC)) | behavior is undefined if [4mx[24m is already lowercase. |
Metafy the next character typed. EESSCC ff is equivalent to MMeettaa--ff. | [1mprefix-meta (ESC)[0m |
uunnddoo ((CC--__,, CC--xx CC--uu)) | Metafy the next character typed. [1mESC f [22mis equivalent to [1mMeta-f[22m. |
| [1mundo (C-_, C-x C-u)[0m |
Incremental undo, separately remembered for each line. |
Incremental undo, separately remembered for each line. |
rreevveerrtt--lliinnee ((MM--rr)) | [1mrevert-line (M-r)[0m |
Undo all changes made to this line. This is like executing the |
Undo all changes made to this line. This is like executing the |
uunnddoo command enough times to return the line to its initial | [1mundo [22mcommand enough times to return the line to its initial |
state. |
state. |
ttiillddee--eexxppaanndd ((MM--&&)) | [1mtilde-expand (M-&)[0m |
Perform tilde expansion on the current word. |
Perform tilde expansion on the current word. |
sseett--mmaarrkk ((CC--@@,, MM--<<ssppaaccee>>)) | [1mset-mark (C-@, M-<space>)[0m |
Set the mark to the point. If a numeric argument is supplied, |
Set the mark to the point. If a numeric argument is supplied, |
the mark is set to that position. |
the mark is set to that position. |
eexxcchhaannggee--ppooiinntt--aanndd--mmaarrkk ((CC--xx CC--xx)) | [1mexchange-point-and-mark (C-x C-x)[0m |
Swap the point with the mark. The current cursor position is |
Swap the point with the mark. The current cursor position is |
set to the saved position, and the old cursor position is saved |
set to the saved position, and the old cursor position is saved |
as the mark. |
as the mark. |
cchhaarraacctteerr--sseeaarrcchh ((CC--]])) | [1mcharacter-search (C-])[0m |
A character is read and point is moved to the next occurrence of |
A character is read and point is moved to the next occurrence of |
that character. A negative count searches for previous occur- |
that character. A negative count searches for previous occur- |
rences. |
rences. |
cchhaarraacctteerr--sseeaarrcchh--bbaacckkwwaarrdd ((MM--CC--]])) | [1mcharacter-search-backward (M-C-])[0m |
A character is read and point is moved to the previous occur- |
A character is read and point is moved to the previous occur- |
rence of that character. A negative count searches for subse- |
rence of that character. A negative count searches for subse- |
quent occurrences. |
quent occurrences. |
sskkiipp--ccssii--sseeqquueennccee | [1mskip-csi-sequence[0m |
Read enough characters to consume a multi-key sequence such as |
Read enough characters to consume a multi-key sequence such as |
those defined for keys like Home and End. Such sequences begin |
those defined for keys like Home and End. Such sequences begin |
with a Control Sequence Indicator (CSI), usually ESC-[. If this |
with a Control Sequence Indicator (CSI), usually ESC-[. If this |
Line 754 EEDDIITTIINNGG CCOOMMMMAANNDDSS
|
Line 849 EEDDIITTIINNGG CCOOMMMMAANNDDSS
|
have no effect unless explicitly bound to a readline command, |
have no effect unless explicitly bound to a readline command, |
instead of inserting stray characters into the editing buffer. |
instead of inserting stray characters into the editing buffer. |
This is unbound by default, but usually bound to ESC-[. |
This is unbound by default, but usually bound to ESC-[. |
iinnsseerrtt--ccoommmmeenntt ((MM--##)) | [1minsert-comment (M-#)[0m |
Without a numeric argument, the value of the readline ccoomm-- | Without a numeric argument, the value of the readline [1mcom-[0m |
mmeenntt--bbeeggiinn variable is inserted at the beginning of the current | [1mment-begin [22mvariable is inserted at the beginning of the current |
line. If a numeric argument is supplied, this command acts as a |
line. If a numeric argument is supplied, this command acts as a |
toggle: if the characters at the beginning of the line do not | toggle: if the characters at the beginning of the line do not |
match the value of ccoommmmeenntt--bbeeggiinn, the value is inserted, other- | match the value of [1mcomment-begin[22m, the value is inserted, other- |
wise the characters in ccoommmmeenntt--bbeeggiinn are deleted from the begin- | wise the characters in [1mcomment-begin [22mare deleted from the begin- |
ning of the line. In either case, the line is accepted as if a |
ning of the line. In either case, the line is accepted as if a |
newline had been typed. The default value of ccoommmmeenntt--bbeeggiinn | newline had been typed. The default value of [1mcomment-begin[0m |
makes the current line a shell comment. If a numeric argument |
makes the current line a shell comment. If a numeric argument |
causes the comment character to be removed, the line will be | causes the comment character to be removed, the line will be ex- |
executed by the shell. | ecuted by the shell. |
dduummpp--ffuunnccttiioonnss | [1mdump-functions[0m |
Print all of the functions and their key bindings to the read- |
Print all of the functions and their key bindings to the read- |
line output stream. If a numeric argument is supplied, the out- |
line output stream. If a numeric argument is supplied, the out- |
put is formatted in such a way that it can be made part of an |
put is formatted in such a way that it can be made part of an |
_i_n_p_u_t_r_c file. | [4minputrc[24m file. |
dduummpp--vvaarriiaabblleess | [1mdump-variables[0m |
Print all of the settable variables and their values to the |
Print all of the settable variables and their values to the |
readline output stream. If a numeric argument is supplied, 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 |
output is formatted in such a way that it can be made part of an |
_i_n_p_u_t_r_c file. | [4minputrc[24m file. |
dduummpp--mmaaccrrooss | [1mdump-macros[0m |
Print all of the readline key sequences bound to macros and the |
Print all of the readline key sequences bound to macros and the |
strings they output. If a numeric argument is supplied, the |
strings they output. If a numeric argument is supplied, the |
output is formatted in such a way that it can be made part of an |
output is formatted in such a way that it can be made part of an |
_i_n_p_u_t_r_c file. | [4minputrc[24m file. |
eemmaaccss--eeddiittiinngg--mmooddee ((CC--ee)) | [1memacs-editing-mode (C-e)[0m |
When in vvii command mode, this causes a switch to eemmaaccss editing | When in [1mvi [22mcommand mode, this causes a switch to [1memacs [22mediting |
mode. |
mode. |
vvii--eeddiittiinngg--mmooddee ((MM--CC--jj)) | [1mvi-editing-mode (M-C-j)[0m |
When in eemmaaccss editing mode, this causes a switch to vvii editing | When in [1memacs [22mediting mode, this causes a switch to [1mvi [22mediting |
mode. |
mode. |
|
|
DDEEFFAAUULLTT KKEEYY BBIINNDDIINNGGSS | [1mDEFAULT KEY BINDINGS[0m |
The following is a list of the default emacs and vi bindings. Charac- |
The following is a list of the default emacs and vi bindings. Charac- |
ters with the eighth bit set are written as M-<character>, and are | ters with the eighth bit set are written as M-<character>, and are re- |
referred to as _m_e_t_a_f_i_e_d characters. The printable ASCII characters not | ferred to as [4mmetafied[24m characters. The printable ASCII characters not |
mentioned in the list of emacs standard bindings are bound to the |
mentioned in the list of emacs standard bindings are bound to the |
sseellff--iinnsseerrtt function, which just inserts the given character into the | [1mself-insert [22mfunction, which just inserts the given character into the |
input line. In vi insertion mode, all characters not specifically men- |
input line. In vi insertion mode, all characters not specifically men- |
tioned are bound to sseellff--iinnsseerrtt. Characters assigned to signal genera- | tioned are bound to [1mself-insert[22m. Characters assigned to signal genera- |
tion by _s_t_t_y(1) or the terminal driver, such as C-Z or C-C, retain that | tion by [4mstty[24m(1) or the terminal driver, such as C-Z or C-C, retain that |
function. Upper and lower case metafied characters are bound to the |
function. Upper and lower case metafied characters are bound to the |
same function in the emacs mode meta keymap. The remaining characters |
same function in the emacs mode meta keymap. The remaining characters |
are unbound, which causes readline to ring the bell (subject to the |
are unbound, which causes readline to ring the bell (subject to the |
setting of the bbeellll--ssttyyllee variable). | setting of the [1mbell-style [22mvariable). |
|
|
EEmmaaccss MMooddee | [1mEmacs Mode[0m |
Emacs Standard bindings |
Emacs Standard bindings |
|
|
"C-@" set-mark |
"C-@" set-mark |
Line 841 DDEEFFAAUULLTT KKEEYY BBIINNDDIINNGGS
|
Line 936 DDEEFFAAUULLTT KKEEYY BBIINNDDIINNGGS
|
"M-C-H" backward-kill-word |
"M-C-H" backward-kill-word |
"M-C-I" tab-insert |
"M-C-I" tab-insert |
"M-C-J" vi-editing-mode |
"M-C-J" vi-editing-mode |
|
"M-C-L" clear-display |
"M-C-M" vi-editing-mode |
"M-C-M" vi-editing-mode |
"M-C-R" revert-line |
"M-C-R" revert-line |
"M-C-Y" yank-nth-arg |
"M-C-Y" yank-nth-arg |
Line 894 DDEEFFAAUULLTT KKEEYY BBIINNDDIINNGGS
|
Line 990 DDEEFFAAUULLTT KKEEYY BBIINNDDIINNGGS
|
"C-XC-?" backward-kill-line |
"C-XC-?" backward-kill-line |
|
|
|
|
VVII MMooddee bbiinnddiinnggss | [1mVI Mode bindings[0m |
VI Insert Mode functions |
VI Insert Mode functions |
|
|
"C-D" vi-eof-maybe |
"C-D" vi-eof-maybe |
Line 996 DDEEFFAAUULLTT KKEEYY BBIINNDDIINNGGS
|
Line 1092 DDEEFFAAUULLTT KKEEYY BBIINNDDIINNGGS
|
"|" vi-column |
"|" vi-column |
"~" vi-change-case |
"~" vi-change-case |
|
|
SSEEEE AALLSSOO | [1mSEE ALSO[0m |
_T_h_e _G_n_u _R_e_a_d_l_i_n_e _L_i_b_r_a_r_y, Brian Fox and Chet Ramey | [4mThe[24m [4mGnu[24m [4mReadline[24m [4mLibrary[24m, Brian Fox and Chet Ramey |
_T_h_e _G_n_u _H_i_s_t_o_r_y _L_i_b_r_a_r_y, Brian Fox and Chet Ramey | [4mThe[24m [4mGnu[24m [4mHistory[24m [4mLibrary[24m, Brian Fox and Chet Ramey |
_b_a_s_h(1) | [4mbash[24m(1) |
|
|
FFIILLEESS | [1mFILES[0m |
_~_/_._i_n_p_u_t_r_c | [4m~/.inputrc[0m |
Individual rreeaaddlliinnee initialization file | Individual [1mreadline [22minitialization file |
|
|
AAUUTTHHOORRSS | [1mAUTHORS[0m |
Brian Fox, Free Software Foundation |
Brian Fox, Free Software Foundation |
bfox@gnu.org |
bfox@gnu.org |
|
|
Chet Ramey, Case Western Reserve University |
Chet Ramey, Case Western Reserve University |
chet.ramey@case.edu |
chet.ramey@case.edu |
|
|
BBUUGG RREEPPOORRTTSS | [1mBUG REPORTS[0m |
If you find a bug in rreeaaddlliinnee,, you should report it. But first, you | If you find a bug in [1mreadline, [22myou should report it. But first, you |
should make sure that it really is a bug, and that it appears in the |
should make sure that it really is a bug, and that it appears in the |
latest version of the rreeaaddlliinnee library that you have. | latest version of the [1mreadline [22mlibrary that you have. |
|
|
Once you have determined that a bug actually exists, mail a bug report |
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 | to [4mbug-readline[24m@[4mgnu.org[24m. If you have a fix, you are welcome to mail |
that as well! Suggestions and `philosophical' bug reports may be |
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 | mailed to [4mbug-readline[24m@[4mgnu.org[24m or posted to the Usenet newsgroup |
ggnnuu..bbaasshh..bbuugg. | [1mgnu.bash.bug[22m. |
|
|
Comments and bug reports concerning this manual page should be directed |
Comments and bug reports concerning this manual page should be directed |
to _c_h_e_t_._r_a_m_e_y_@_c_a_s_e_._e_d_u. | to [4mchet.ramey@case.edu[24m. |
|
|
BBUUGGSS | [1mBUGS[0m |
It's too big and too slow. |
It's too big and too slow. |
|
|
|
|
|
|
GNU Readline 6.3 2014 January 6 READLINE(3) | GNU Readline 8.1 2020 October 29 READLINE(3) |