version 1.1.1.1, 2014/07/30 08:16:45
|
version 1.1.1.2, 2021/03/17 01:01:01
|
Line 6
|
Line 6
|
.\" Case Western Reserve University |
.\" Case Western Reserve University |
.\" chet.ramey@case.edu |
.\" chet.ramey@case.edu |
.\" |
.\" |
.\" Last Change: Mon Jan 6 16:34:55 EST 2014 | .\" Last Change: Tue Mar 24 09:27:30 EDT 2020 |
.\" |
.\" |
.TH READLINE 3 "2014 January 6" "GNU Readline 6.3" | .TH READLINE 3 "2020 October 29" "GNU Readline 8.1" |
.\" |
.\" |
.\" File Name macro. This used to be `.PN', for Path Name, |
.\" File Name macro. This used to be `.PN', for Path Name, |
.\" but Sun doesn't seem to like that very much. |
.\" but Sun doesn't seem to like that very much. |
Line 34 readline \- get a line from a user with editing
|
Line 34 readline \- get a line from a user with editing
|
\fBreadline\fP (\fIconst char *prompt\fP); |
\fBreadline\fP (\fIconst char *prompt\fP); |
.fi |
.fi |
.SH COPYRIGHT |
.SH COPYRIGHT |
.if n Readline is Copyright (C) 1989\-2011 Free Software Foundation, Inc. | .if n Readline is Copyright (C) 1989\-2020 Free Software Foundation, Inc. |
.if t Readline is Copyright \(co 1989\-2011 Free Software Foundation, Inc. | .if t Readline is Copyright \(co 1989\-2020 Free Software Foundation, Inc. |
.SH DESCRIPTION |
.SH DESCRIPTION |
.LP |
.LP |
.B readline |
.B readline |
Line 78 treated as a newline.
|
Line 78 treated as a newline.
|
.LP |
.LP |
An Emacs-style notation is used to denote |
An Emacs-style notation is used to denote |
keystrokes. Control keys are denoted by C\-\fIkey\fR, e.g., C\-n |
keystrokes. Control keys are denoted by C\-\fIkey\fR, e.g., C\-n |
means Control\-N. Similarly, | means Control\-N. Similarly, |
.I meta |
.I meta |
keys are denoted by M\-\fIkey\fR, so M\-x means Meta\-X. (On keyboards |
keys are denoted by M\-\fIkey\fR, so M\-x means Meta\-X. (On keyboards |
without a | without a |
.I meta |
.I meta |
key, M\-\fIx\fP means ESC \fIx\fP, i.e., press the Escape key |
key, M\-\fIx\fP means ESC \fIx\fP, i.e., press the Escape key |
then the |
then the |
Line 98 Readline commands may be given numeric
|
Line 98 Readline commands may be given numeric
|
which normally act as a repeat count. Sometimes, however, it is the |
which normally act as a repeat count. Sometimes, however, it is the |
sign of the argument that is significant. Passing a negative argument |
sign of the argument that is significant. Passing a negative argument |
to a command that acts in the forward direction (e.g., \fBkill\-line\fP) |
to a command that acts in the forward direction (e.g., \fBkill\-line\fP) |
causes that command to act in a backward direction. Commands whose | causes that command to act in a backward direction. |
behavior with arguments deviates from this are noted. | Commands whose behavior with arguments deviates from this are noted |
| below. |
.PP |
.PP |
When a command is described as \fIkilling\fP text, the text |
When a command is described as \fIkilling\fP text, the text |
deleted is saved for possible future retrieval |
deleted is saved for possible future retrieval |
(\fIyanking\fP). The killed text is saved in a |
(\fIyanking\fP). The killed text is saved in a |
\fIkill ring\fP. Consecutive kills cause the text to be |
\fIkill ring\fP. Consecutive kills cause the text to be |
accumulated into one unit, which can be yanked all at once. | accumulated into one unit, which can be yanked all at once. |
Commands which do not kill text separate the chunks of text |
Commands which do not kill text separate the chunks of text |
on the kill ring. |
on the kill ring. |
.SH INITIALIZATION FILE |
.SH INITIALIZATION FILE |
Line 138 or
|
Line 139 or
|
C\-Meta\-u: universal\-argument |
C\-Meta\-u: universal\-argument |
.RE |
.RE |
.sp |
.sp |
into the | into the |
.I inputrc |
.I inputrc |
would make M\-C\-u execute the readline command |
would make M\-C\-u execute the readline command |
.IR universal\-argument . |
.IR universal\-argument . |
Line 162 In addition to command names, readline allows keys to
|
Line 163 In addition to command names, readline allows keys to
|
to a string that is inserted when the key is pressed (a \fImacro\fP). |
to a string that is inserted when the key is pressed (a \fImacro\fP). |
.PP |
.PP |
.SS Key Bindings |
.SS Key Bindings |
.PP |
|
The syntax for controlling key bindings in the |
The syntax for controlling key bindings in the |
.I inputrc |
.I inputrc |
file is simple. All that is required is the name of the |
file is simple. All that is required is the name of the |
command or the text of a macro and a key sequence to which |
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: | it should be bound. The name may be specified in one of two ways: |
as a symbolic key name, possibly with \fIMeta\-\fP or \fIControl\-\fP |
as a symbolic key name, possibly with \fIMeta\-\fP or \fIControl\-\fP |
prefixes, or as a key sequence. |
prefixes, or as a key sequence. |
The name and key sequence are separated by a colon. There can be no |
The name and key sequence are separated by a colon. There can be no |
Line 225 is again bound to the function
|
Line 225 is again bound to the function
|
.I "C-x C-r" |
.I "C-x C-r" |
is bound to the function |
is bound to the function |
.BR re\-read\-init\-file , |
.BR re\-read\-init\-file , |
and | and |
.I "ESC [ 1 1 ~" |
.I "ESC [ 1 1 ~" |
is bound to insert the text |
is bound to insert the text |
.if t \f(CWFunction Key 1\fP. |
.if t \f(CWFunction Key 1\fP. |
Line 317 similar mechanisms. The
|
Line 317 similar mechanisms. The
|
file may be edited and re-read if a program does not provide |
file may be edited and re-read if a program does not provide |
any other means to incorporate new bindings. |
any other means to incorporate new bindings. |
.SS Variables |
.SS Variables |
.PP |
|
Readline has variables that can be used to further customize its |
Readline has variables that can be used to further customize its |
behavior. A variable may be set in the |
behavior. A variable may be set in the |
.I inputrc |
.I inputrc |
Line 347 If set to \fBnone\fP, readline never rings the bell.
|
Line 346 If set to \fBnone\fP, readline never rings the bell.
|
If set to \fBaudible\fP, readline attempts to ring the terminal's bell. |
If set to \fBaudible\fP, readline attempts to ring the terminal's bell. |
.TP |
.TP |
.B bind\-tty\-special\-chars (On) |
.B bind\-tty\-special\-chars (On) |
If set to \fBOn\fP, readline attempts to bind the control characters | If set to \fBOn\fP (the default), readline attempts to bind the control |
treated specially by the kernel's terminal driver to their readline | characters treated specially by the kernel's terminal driver to their |
equivalents. | readline equivalents. |
.TP |
.TP |
|
.B blink\-matching\-paren (Off) |
|
If set to \fBOn\fP, readline attempts to briefly move the cursor to an |
|
opening parenthesis when a closing parenthesis is inserted. |
|
.TP |
|
.B colored\-completion\-prefix (Off) |
|
If set to \fBOn\fP, when listing completions, readline displays the |
|
common prefix of the set of possible completions using a different color. |
|
The color definitions are taken from the value of the \fBLS_COLORS\fP |
|
environment variable. |
|
.TP |
.B colored\-stats (Off) |
.B colored\-stats (Off) |
If set to \fBOn\fP, readline displays possible completions using different |
If set to \fBOn\fP, readline displays possible completions using different |
colors to indicate their file type. | colors to indicate their file type. |
The color definitions are taken from the value of the \fBLS_COLORS\fP |
The color definitions are taken from the value of the \fBLS_COLORS\fP |
environment variable. |
environment variable. |
.TP |
.TP |
Line 367 in emacs mode and to
|
Line 376 in emacs mode and to
|
.B # |
.B # |
in vi command mode. |
in vi command mode. |
.TP |
.TP |
.B completion\-display\-width (-1) | .B completion\-display\-width (\-1) |
The number of screen columns used to display possible matches |
The number of screen columns used to display possible matches |
when performing completion. |
when performing completion. |
The value is ignored if it is less than 0 or greater than the terminal |
The value is ignored if it is less than 0 or greater than the terminal |
screen width. |
screen width. |
A value of 0 will cause matches to be displayed one per line. |
A value of 0 will cause matches to be displayed one per line. |
The default value is -1. | The default value is \-1. |
.TP |
.TP |
.B completion\-ignore\-case (Off) |
.B completion\-ignore\-case (Off) |
If set to \fBOn\fP, readline performs filename matching and completion |
If set to \fBOn\fP, readline performs filename matching and completion |
Line 394 replaced with an ellipsis when displaying possible com
|
Line 403 replaced with an ellipsis when displaying possible com
|
This determines when the user is queried about viewing |
This determines when the user is queried about viewing |
the number of possible completions |
the number of possible completions |
generated by the \fBpossible\-completions\fP command. |
generated by the \fBpossible\-completions\fP command. |
It may be set to any integer value greater than or equal to | It may be set to any integer value greater than or equal to zero. |
zero. If the number of possible completions is greater than | If the number of possible completions is greater than |
or equal to the value of this variable, the user is asked whether | or equal to the value of this variable, |
or not he wishes to view them; otherwise they are simply listed | readline will ask whether or not the user wishes to view them; |
| otherwise they are simply listed |
on the terminal. A negative value causes readline to never ask. |
on the terminal. A negative value causes readline to never ask. |
.TP |
.TP |
.B convert\-meta (On) |
.B convert\-meta (On) |
Line 405 If set to \fBOn\fP, readline will convert characters w
|
Line 415 If set to \fBOn\fP, readline will convert characters w
|
eighth bit set to an ASCII key sequence |
eighth bit set to an ASCII key sequence |
by stripping the eighth bit and prefixing it with an |
by stripping the eighth bit and prefixing it with an |
escape character (in effect, using escape as the \fImeta prefix\fP). |
escape character (in effect, using escape as the \fImeta prefix\fP). |
|
The default is \fIOn\fP, but readline will set it to \fIOff\fP if the |
|
locale contains eight-bit characters. |
.TP |
.TP |
.B disable\-completion (Off) |
.B disable\-completion (Off) |
If set to \fBOn\fP, readline will inhibit word completion. Completion |
If set to \fBOn\fP, 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 \fBself-insert\fP. |
mapped to \fBself-insert\fP. |
.TP |
.TP |
|
.B echo\-control\-characters (On) |
|
When set to \fBOn\fP, on operating systems that indicate they support it, |
|
readline echoes a character corresponding to a signal generated from the |
|
keyboard. |
|
.TP |
.B editing\-mode (emacs) |
.B editing\-mode (emacs) |
Controls whether readline begins with a set of key bindings similar |
Controls whether readline begins with a set of key bindings similar |
to \fIEmacs\fP or \fIvi\fP. |
to \fIEmacs\fP or \fIvi\fP. |
Line 420 can be set to either
|
Line 437 can be set to either
|
or |
or |
.BR vi . |
.BR vi . |
.TP |
.TP |
.B echo\-control\-characters (On) | .B emacs\-mode\-string (@) |
When set to \fBOn\fP, on operating systems that indicate they support it, | If the \fIshow\-mode\-in\-prompt\fP variable is enabled, |
readline echoes a character corresponding to a signal generated from the | this string is displayed immediately before the last line of the primary |
keyboard. | 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 \e1 and \e2 escapes to begin and end sequences of |
| non-printing characters, which can be used to embed a terminal control |
| sequence into the mode string. |
.TP |
.TP |
|
.B enable\-bracketed\-paste (On) |
|
When set to \fBOn\fP, 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 character as if |
|
it had been read from the keyboard. This can prevent pasted characters |
|
from being interpreted as editing commands. |
|
.TP |
.B enable\-keypad (Off) |
.B enable\-keypad (Off) |
When set to \fBOn\fP, readline will try to enable the application |
When set to \fBOn\fP, readline will try to enable the application |
keypad when it is called. Some systems need this to enable the |
keypad when it is called. Some systems need this to enable the |
Line 444 If set to \fBOn\fP, the history code attempts to place
|
Line 473 If set to \fBOn\fP, the history code attempts to place
|
same location on each history line retrieved with \fBprevious-history\fP |
same location on each history line retrieved with \fBprevious-history\fP |
or \fBnext-history\fP. |
or \fBnext-history\fP. |
.TP |
.TP |
.B history\-size (0) | .B history\-size (unset) |
Set the maximum number of history entries saved in the history list. |
Set the maximum number of history entries saved in the history list. |
If set to zero, any existing history entries are deleted and no new entries |
If set to zero, any existing history entries are deleted and no new entries |
are saved. |
are saved. |
If set to a value less than zero, the number of history entries is not |
If set to a value less than zero, the number of history entries is not |
limited. |
limited. |
By default, the number of history entries is not limited. |
By default, the number of history entries is not limited. |
|
If an attempt is made to set \fIhistory\-size\fP to a non-numeric value, |
|
the maximum number of history entries will be set to 500. |
.TP |
.TP |
.B horizontal\-scroll\-mode (Off) |
.B horizontal\-scroll\-mode (Off) |
When set to \fBOn\fP, makes readline use a single line for display, |
When set to \fBOn\fP, 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 new line. |
becomes longer than the screen width rather than wrapping to a new line. |
|
This setting is automatically enabled for terminals of height 1. |
.TP |
.TP |
.B input\-meta (Off) |
.B input\-meta (Off) |
If set to \fBOn\fP, readline will enable eight-bit input (that is, |
If set to \fBOn\fP, readline will enable eight-bit input (that is, |
Line 463 it will not clear the eighth bit in the characters it
|
Line 495 it will not clear the eighth bit in the characters it
|
regardless of what the terminal claims it can support. The name |
regardless of what the terminal claims it can support. The name |
.B meta\-flag |
.B meta\-flag |
is a synonym for this variable. |
is a synonym for this variable. |
|
The default is \fIOff\fP, but readline will set it to \fIOn\fP if the |
|
locale contains eight-bit characters. |
.TP |
.TP |
.B isearch\-terminators (``C\-[ C\-J'') |
.B isearch\-terminators (``C\-[ C\-J'') |
The string of characters that should terminate an incremental |
The string of characters that should terminate an incremental |
Line 510 have a slash appended (subject to the value of
|
Line 544 have a slash appended (subject to the value of
|
.TP |
.TP |
.B match\-hidden\-files (On) |
.B match\-hidden\-files (On) |
This variable, when set to \fBOn\fP, causes readline to match files whose |
This variable, when set to \fBOn\fP, causes readline to match files whose |
names begin with a `.' (hidden files) when performing filename | names begin with a `.' (hidden files) when performing filename |
completion. |
completion. |
If set to \fBOff\fP, the leading `.' must be |
If set to \fBOff\fP, the leading `.' must be |
supplied by the user in the filename to be completed. |
supplied by the user in the filename to be completed. |
Line 524 the list.
|
Line 558 the list.
|
If set to \fBOn\fP, readline will display characters with the |
If set to \fBOn\fP, readline will display characters with the |
eighth bit set directly rather than as a meta-prefixed escape |
eighth bit set directly rather than as a meta-prefixed escape |
sequence. |
sequence. |
|
The default is \fIOff\fP, but readline will set it to \fIOn\fP if the |
|
locale contains eight-bit characters. |
.TP |
.TP |
.B page\-completions (On) |
.B page\-completions (On) |
If set to \fBOn\fP, readline uses an internal \fImore\fP-like pager |
If set to \fBOn\fP, readline uses an internal \fImore\fP-like pager |
Line 557 a common prefix) cause the matches to be listed immedi
|
Line 593 a common prefix) cause the matches to be listed immedi
|
of ringing the bell. |
of ringing the bell. |
.TP |
.TP |
.B show\-mode\-in\-prompt (Off) |
.B show\-mode\-in\-prompt (Off) |
If set to \fBOn\fP, add a character to the beginning of the prompt | If set to \fBOn\fP, add a string to the beginning of the prompt |
indicating the editing mode: emacs (@), vi command (:) or vi | indicating the editing mode: emacs, vi command, or vi insertion. |
insertion (+). | The mode strings are user-settable (e.g., \fIemacs\-mode\-string\fP). |
.TP |
.TP |
.B skip\-completed\-text (Off) |
.B skip\-completed\-text (Off) |
If set to \fBOn\fP, this alters the default completion behavior when |
If set to \fBOn\fP, this alters the default completion behavior when |
Line 569 does not insert characters from the completion that ma
|
Line 605 does not insert characters from the completion that ma
|
after point in the word being completed, so portions of the word |
after point in the word being completed, so portions of the word |
following the cursor are not duplicated. |
following the cursor are not duplicated. |
.TP |
.TP |
|
.B vi\-cmd\-mode\-string ((cmd)) |
|
If the \fIshow\-mode\-in\-prompt\fP variable is enabled, |
|
this string is displayed immediately before the last line of the primary |
|
prompt when vi editing mode is active and in command mode. |
|
The value is expanded like a |
|
key binding, so the standard set of meta- and control prefixes and |
|
backslash escape sequences is available. |
|
Use the \e1 and \e2 escapes to begin and end sequences of |
|
non-printing characters, which can be used to embed a terminal control |
|
sequence into the mode string. |
|
.TP |
|
.B vi\-ins\-mode\-string ((ins)) |
|
If the \fIshow\-mode\-in\-prompt\fP 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 \e1 and \e2 escapes to begin and end sequences of |
|
non-printing characters, which can be used to embed a terminal control |
|
sequence into the mode string. |
|
.TP |
.B visible\-stats (Off) |
.B visible\-stats (Off) |
If set to \fBOn\fP, a character denoting a file's type as reported |
If set to \fBOn\fP, a character denoting a file's type as reported |
by \fIstat\fP(2) is appended to the filename when listing possible |
by \fIstat\fP(2) is appended to the filename when listing possible |
completions. |
completions. |
.PD |
.PD |
.SS Conditional Constructs |
.SS Conditional Constructs |
.PP |
|
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 |
compilation features of the C preprocessor which allows key |
bindings and variable settings to be performed as the result |
bindings and variable settings to be performed as the result |
of tests. There are four parser directives used. |
of tests. There are four parser directives used. |
.IP \fB$if\fP |
.IP \fB$if\fP |
The | The |
.B $if |
.B $if |
construct allows bindings to be made based on the |
construct allows bindings to be made based on the |
editing mode, the terminal being used, or the application using |
editing 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 characters are required to isolate it. |
.RS |
.RS |
.IP \fBmode\fP |
.IP \fBmode\fP |
The \fBmode=\fP form of the \fB$if\fP directive is used to test |
The \fBmode=\fP form of the \fB$if\fP directive is used to test |
Line 608 to match both
|
Line 666 to match both
|
and |
and |
.IR sun\-cmd , |
.IR sun\-cmd , |
for instance. |
for instance. |
|
.IP \fBversion\fP |
|
The \fBversion\fP test may be used to perform comparisons against |
|
specific readline versions. |
|
The \fBversion\fP expands to the current readline version. |
|
The set of comparison operators includes |
|
.BR = , |
|
(and |
|
.BR == ), |
|
.BR != , |
|
.BR <= , |
|
.BR >= , |
|
.BR < , |
|
and |
|
.BR > . |
|
The version number supplied on the right side of the operator consists |
|
of a major version number, an optional decimal point, and an optional |
|
minor version (e.g., \fB7.1\fP). If the minor version is omitted, it |
|
is assumed to be \fB0\fP. |
|
The operator may be separated from the string \fBversion\fP |
|
and from the version number argument by whitespace. |
.IP \fBapplication\fP |
.IP \fBapplication\fP |
The \fBapplication\fP construct is used to include |
The \fBapplication\fP construct is used to include |
application-specific settings. Each program using the readline |
application-specific settings. Each program using the readline |
Line 625 key sequence that quotes the current or previous word
|
Line 703 key sequence that quotes the current or previous word
|
\fB$endif\fP |
\fB$endif\fP |
.fi |
.fi |
.RE |
.RE |
|
.IP \fIvariable\fP |
|
The \fIvariable\fP construct provides simple equality tests for readline |
|
variables and values. |
|
The permitted comparison operators are \fI=\fP, \fI==\fP, and \fI!=\fP. |
|
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 variables may be tested. Boolean variables must be |
|
tested against the values \fIon\fP and \fIoff\fP. |
.RE |
.RE |
.IP \fB$endif\fP |
.IP \fB$endif\fP |
This command, as seen in the previous example, terminates an |
This command, as seen in the previous example, terminates an |
Line 643 would read \fI/etc/inputrc\fP:
|
Line 730 would read \fI/etc/inputrc\fP:
|
.fi |
.fi |
.RE |
.RE |
.SH SEARCHING |
.SH SEARCHING |
.PP |
|
Readline provides commands for searching through the command history |
Readline provides commands for searching through the command history |
for lines containing a specified string. |
for lines containing a specified string. |
There are two search modes: |
There are two search modes: |
Line 683 Non-incremental searches read the entire search string
|
Line 769 Non-incremental searches read the entire search string
|
to search for matching history lines. The search string may be |
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. |
typed by the user or be part of the contents of the current line. |
.SH EDITING COMMANDS |
.SH EDITING COMMANDS |
.PP |
|
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. |
key sequences to which they are bound. |
Command names without an accompanying key sequence are unbound by default. |
Command names without an accompanying key sequence are unbound by default. |
Line 693 position, and \fImark\fP refers to a cursor position s
|
Line 778 position, and \fImark\fP refers to a cursor position s
|
\fBset\-mark\fP command. |
\fBset\-mark\fP command. |
The text between the point and mark is referred to as the \fIregion\fP. |
The text between the point and mark is referred to as the \fIregion\fP. |
.SS Commands for Moving |
.SS Commands for Moving |
.PP |
|
.PD 0 |
.PD 0 |
.TP |
.TP |
.B beginning\-of\-line (C\-a) |
.B beginning\-of\-line (C\-a) |
Line 716 alphanumeric characters (letters and digits).
|
Line 800 alphanumeric characters (letters and digits).
|
Move back to the start of the current or previous word. Words are |
Move back to the start of the current or previous word. Words are |
composed of alphanumeric characters (letters and digits). |
composed of alphanumeric characters (letters and digits). |
.TP |
.TP |
|
.B previous\-screen\-line |
|
Attempt to move point to the same physical screen column on the previous |
|
physical screen line. This will not have the desired effect if the current |
|
Readline line does not take up more than one physical line or if point is not |
|
greater than the length of the prompt plus the screen width. |
|
.TP |
|
.B next\-screen\-line |
|
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. |
|
.TP |
|
.B clear\-display (M\-C\-l) |
|
Clear the screen and, if possible, the terminal's scrollback buffer, |
|
then redraw the current line, |
|
leaving the current line at the top of the screen. |
|
.TP |
.B clear\-screen (C\-l) |
.B clear\-screen (C\-l) |
Clear the screen leaving the current line at the top of the screen. | Clear the screen, |
| then redraw the current line, |
| leaving the current line at the top of the screen. |
With an argument, refresh the current line without clearing the |
With an argument, refresh the current line without clearing the |
screen. |
screen. |
.TP |
.TP |
Line 725 screen.
|
Line 829 screen.
|
Refresh the current line. |
Refresh the current line. |
.PD |
.PD |
.SS Commands for Manipulating the History |
.SS Commands for Manipulating the History |
.PP |
|
.PD 0 |
.PD 0 |
.TP |
.TP |
.B accept\-line (Newline, Return) |
.B accept\-line (Newline, Return) |
Line 816 the direction to move through the history. A negative
|
Line 919 the direction to move through the history. A negative
|
the direction through the history (back or forward). |
the direction through the history (back or forward). |
The history expansion facilities are used to extract the last argument, |
The history expansion facilities are used to extract the last argument, |
as if the "!$" history expansion had been specified. |
as if the "!$" history expansion had been specified. |
|
.TP |
|
.B |
|
operate\-and\-get\-next (C\-o) |
|
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 argument, if supplied, specifies the history entry to use instead |
|
of the current line. |
.PD |
.PD |
.SS Commands for Changing Text |
.SS Commands for Changing Text |
.PP |
|
.PD 0 |
.PD 0 |
.TP |
.TP |
.B \fIend\-of\-file\fP (usually C\-d) |
.B \fIend\-of\-file\fP (usually C\-d) |
Line 887 switches to overwrite mode. With an explicit non-posi
|
Line 998 switches to overwrite mode. With an explicit non-posi
|
argument, switches to insert mode. This command affects only |
argument, switches to insert mode. This command affects only |
\fBemacs\fP mode; \fBvi\fP mode does overwrite differently. |
\fBemacs\fP mode; \fBvi\fP mode does overwrite differently. |
Each call to \fIreadline()\fP starts in insert mode. |
Each call to \fIreadline()\fP starts in insert mode. |
In overwrite mode, characters bound to \fBself\-insert\fP replace | In overwrite mode, characters bound to \fBself\-insert\fP replace |
the text at point rather than pushing the text to the right. |
the text at point rather than pushing the text to the right. |
Characters bound to \fBbackward\-delete\-char\fP replace the character |
Characters bound to \fBbackward\-delete\-char\fP replace the character |
before point with a space. By default, this command is unbound. |
before point with a space. By default, this command is unbound. |
.PD |
.PD |
.SS Killing and Yanking |
.SS Killing and Yanking |
.PP |
|
.PD 0 |
.PD 0 |
.TP |
.TP |
.B kill\-line (C\-k) |
.B kill\-line (C\-k) |
Line 910 The killed text is saved on the kill-ring.
|
Line 1020 The killed text is saved on the kill-ring.
|
.B kill\-whole\-line |
.B kill\-whole\-line |
Kill all characters on the current line, no matter where point is. |
Kill all characters on the current line, no matter where point is. |
.TP |
.TP |
.B kill\-word (M\-d) | .B kill\-word (M\-d) |
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 same as |
words, to the end of the next word. Word boundaries are the same as |
those used by \fBforward\-word\fP. |
those used by \fBforward\-word\fP. |
Line 956 or
|
Line 1066 or
|
.BR yank\-pop . |
.BR yank\-pop . |
.PD |
.PD |
.SS Numeric Arguments |
.SS Numeric Arguments |
.PP |
|
.PD 0 |
.PD 0 |
.TP |
.TP |
.B digit\-argument (M\-0, M\-1, ..., M\-\-) |
.B digit\-argument (M\-0, M\-1, ..., M\-\-) |
Line 978 first time makes the argument count four, a second tim
|
Line 1087 first time makes the argument count four, a second tim
|
argument count sixteen, and so on. |
argument count sixteen, and so on. |
.PD |
.PD |
.SS Completing |
.SS Completing |
.PP |
|
.PD 0 |
.PD 0 |
.TP |
.TP |
.B complete (TAB) |
.B complete (TAB) |
Line 1035 If at the end of the line, behaves identically to
|
Line 1143 If at the end of the line, behaves identically to
|
\fBpossible-completions\fP. |
\fBpossible-completions\fP. |
.PD |
.PD |
.SS Keyboard Macros |
.SS Keyboard Macros |
.PP |
|
.PD 0 |
.PD 0 |
.TP |
.TP |
.B start\-kbd\-macro (C\-x (\^) |
.B start\-kbd\-macro (C\-x (\^) |
Line 1048 and store the definition.
|
Line 1155 and store the definition.
|
.B call\-last\-kbd\-macro (C\-x e) |
.B call\-last\-kbd\-macro (C\-x e) |
Re-execute the last keyboard macro defined, by making the characters |
Re-execute the last keyboard macro defined, by making the characters |
in the macro appear as if typed at the keyboard. |
in the macro appear as if typed at the keyboard. |
|
.TP |
.B print\-last\-kbd\-macro () |
.B print\-last\-kbd\-macro () |
Print the last keyboard macro defined in a format suitable for the |
Print the last keyboard macro defined in a format suitable for the |
\fIinputrc\fP file. |
\fIinputrc\fP file. |
.PD |
.PD |
.SS Miscellaneous |
.SS Miscellaneous |
.PP |
|
.PD 0 |
.PD 0 |
.TP |
.TP |
.B re\-read\-init\-file (C\-x C\-r) |
.B re\-read\-init\-file (C\-x C\-r) |
Line 1065 Abort the current editing command and
|
Line 1172 Abort the current editing command and
|
ring the terminal's bell (subject to the setting of |
ring the terminal's bell (subject to the setting of |
.BR bell\-style ). |
.BR bell\-style ). |
.TP |
.TP |
.B do\-uppercase\-version (M\-a, M\-b, M\-\fIx\fP, ...) | .B do\-lowercase\-version (M\-A, M\-B, M\-\fIx\fP, ...) |
If the metafied character \fIx\fP is lowercase, run the command | If the metafied character \fIx\fP is uppercase, run the command |
that is bound to the corresponding uppercase character. | that is bound to the corresponding metafied lowercase character. |
| The behavior is undefined if \fIx\fP is already lowercase. |
.TP |
.TP |
.B prefix\-meta (ESC) |
.B prefix\-meta (ESC) |
Metafy the next character typed. |
Metafy the next character typed. |
Line 1117 but usually bound to ESC\-[.
|
Line 1225 but usually bound to ESC\-[.
|
Without a numeric argument, the value of the readline |
Without a numeric argument, the value of the readline |
.B comment\-begin |
.B comment\-begin |
variable is inserted at the beginning of the current line. |
variable is inserted at the beginning of the current line. |
If a numeric argument is supplied, this command acts as a toggle: if | If a numeric argument is supplied, this command acts as a toggle: if |
the characters at the beginning of the line do not match the value |
the characters at the beginning of the line do not match the value |
of \fBcomment\-begin\fP, the value is inserted, otherwise |
of \fBcomment\-begin\fP, the value is inserted, otherwise |
the characters in \fBcomment-begin\fP are deleted from the beginning of |
the characters in \fBcomment-begin\fP are deleted from the beginning of |
Line 1228 Emacs Meta bindings
|
Line 1336 Emacs Meta bindings
|
"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 1432 Comments and bug reports concerning
|
Line 1541 Comments and bug reports concerning
|
this manual page should be directed to |
this manual page should be directed to |
.IR chet.ramey@case.edu . |
.IR chet.ramey@case.edu . |
.SH BUGS |
.SH BUGS |
.PP |
|
It's too big and too slow. |
It's too big and too slow. |