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
|
This is rluserman.info, produced by makeinfo version 4.13 from | This is rluserman.info, produced by makeinfo version 6.7 from |
/usr/homes/chet/src/bash/readline-src/doc/rluserman.texi. | rluserman.texi. |
|
|
This manual describes the end user interface of the GNU Readline Library |
This manual describes the end user interface of the GNU Readline Library |
(version 6.3, 6 January 2014), a library which aids in the consistency | (version 8.1, 29 October 2020), a library which aids in the consistency |
of user interface across discrete programs which provide a command line |
of user interface across discrete programs which provide a command line |
interface. |
interface. |
|
|
Copyright (C) 1988-2014 Free Software Foundation, Inc. | Copyright (C) 1988-2020 Free Software Foundation, Inc. |
|
|
Permission is granted to copy, distribute and/or modify this |
Permission is granted to copy, distribute and/or modify this |
document under the terms of the GNU Free Documentation License, |
document under the terms of the GNU Free Documentation License, |
Line 15 interface.
|
Line 15 interface.
|
no Back-Cover Texts. A copy of the license is included in the |
no Back-Cover Texts. A copy of the license is included in the |
section entitled "GNU Free Documentation License". |
section entitled "GNU Free Documentation License". |
|
|
|
|
INFO-DIR-SECTION Libraries |
INFO-DIR-SECTION Libraries |
START-INFO-DIR-ENTRY |
START-INFO-DIR-ENTRY |
* RLuserman: (rluserman). The GNU readline library User's Manual. |
* RLuserman: (rluserman). The GNU readline library User's Manual. |
Line 30 GNU Readline Library
|
Line 29 GNU Readline Library
|
This document describes the end user interface of the GNU Readline |
This document describes the end user interface of the GNU Readline |
Library, a utility which aids in the consistency of user interface |
Library, a utility which aids in the consistency of user interface |
across discrete programs which provide a command line interface. The |
across discrete programs which provide a command line interface. The |
Readline home page is `http://www.gnu.org/software/readline/'. | Readline home page is <http://www.gnu.org/software/readline/>. |
|
|
* Menu: |
* Menu: |
|
|
Line 65 File: rluserman.info, Node: Introduction and Notation
|
Line 64 File: rluserman.info, Node: Introduction and Notation
|
The following paragraphs describe the notation used to represent |
The following paragraphs describe the notation used to represent |
keystrokes. |
keystrokes. |
|
|
The text `C-k' is read as `Control-K' and describes the character | The text 'C-k' is read as 'Control-K' and describes the character |
produced when the <k> key is pressed while the Control key is depressed. |
produced when the <k> key is pressed while the Control key is depressed. |
|
|
The text `M-k' is read as `Meta-K' and describes the character | The text 'M-k' is read as 'Meta-K' and describes the character |
produced when the Meta key (if you have one) is depressed, and the <k> |
produced when the Meta key (if you have one) is depressed, and the <k> |
key is pressed. The Meta key is labeled <ALT> on many keyboards. On |
key is pressed. The Meta key is labeled <ALT> on many keyboards. On |
keyboards with two keys labeled <ALT> (usually to either side of the |
keyboards with two keys labeled <ALT> (usually to either side of the |
Line 82 Meta key, the identical keystroke can be generated by
|
Line 81 Meta key, the identical keystroke can be generated by
|
_first_, and then typing <k>. Either process is known as "metafying" |
_first_, and then typing <k>. Either process is known as "metafying" |
the <k> key. |
the <k> key. |
|
|
The text `M-C-k' is read as `Meta-Control-k' and describes the | The text 'M-C-k' is read as 'Meta-Control-k' and describes the |
character produced by "metafying" `C-k'. | character produced by "metafying" 'C-k'. |
|
|
In addition, several keys have their own names. Specifically, | In addition, several keys have their own names. Specifically, <DEL>, |
<DEL>, <ESC>, <LFD>, <SPC>, <RET>, and <TAB> all stand for themselves | <ESC>, <LFD>, <SPC>, <RET>, and <TAB> all stand for themselves when seen |
when seen in this text, or in an init file (*note Readline Init File::). | in this text, or in an init file (*note Readline Init File::). If your |
If your keyboard lacks a <LFD> key, typing <C-j> will produce the | keyboard lacks a <LFD> key, typing <C-j> will produce the desired |
desired character. The <RET> key may be labeled <Return> or <Enter> on | character. The <RET> key may be labeled <Return> or <Enter> on some |
some keyboards. | keyboards. |
|
|
|
|
File: rluserman.info, Node: Readline Interaction, Next: Readline Init File, Prev: Introduction and Notation, Up: Command Line Editing |
File: rluserman.info, Node: Readline Interaction, Next: Readline Init File, Prev: Introduction and Notation, Up: Command Line Editing |
Line 128 character appears where the cursor was, and then the c
|
Line 127 character appears where the cursor was, and then the c
|
space to the right. If you mistype a character, you can use your erase |
space to the right. If you mistype a character, you can use your erase |
character to back up and delete the mistyped character. |
character to back up and delete the mistyped character. |
|
|
Sometimes you may mistype a character, and not notice the error | Sometimes you may mistype a character, and not notice the error until |
until you have typed several other characters. In that case, you can | you have typed several other characters. In that case, you can type |
type `C-b' to move the cursor to the left, and then correct your | 'C-b' to move the cursor to the left, and then correct your mistake. |
mistake. Afterwards, you can move the cursor to the right with `C-f'. | Afterwards, you can move the cursor to the right with 'C-f'. |
|
|
When you add text in the middle of a line, you will notice that |
When you add text in the middle of a line, you will notice that |
characters to the right of the cursor are `pushed over' to make room | characters to the right of the cursor are 'pushed over' to make room for |
for the text that you have inserted. Likewise, when you delete text | the text that you have inserted. Likewise, when you delete text behind |
behind the cursor, characters to the right of the cursor are `pulled | the cursor, characters to the right of the cursor are 'pulled back' to |
back' to fill in the blank space created by the removal of the text. A | fill in the blank space created by the removal of the text. A list of |
list of the bare essentials for editing the text of an input line | the bare essentials for editing the text of an input line follows. |
follows. | |
|
|
`C-b' | 'C-b' |
Move back one character. |
Move back one character. |
| 'C-f' |
`C-f' | |
Move forward one character. |
Move forward one character. |
|
|
<DEL> or <Backspace> |
<DEL> or <Backspace> |
Delete the character to the left of the cursor. |
Delete the character to the left of the cursor. |
| 'C-d' |
`C-d' | |
Delete the character underneath the cursor. |
Delete the character underneath the cursor. |
|
|
Printing characters |
Printing characters |
Insert the character into the line at the cursor. |
Insert the character into the line at the cursor. |
| 'C-_' or 'C-x C-u' |
`C-_' or `C-x C-u' | |
Undo the last editing command. You can undo all the way back to an |
Undo the last editing command. You can undo all the way back to an |
empty line. |
empty line. |
|
|
(Depending on your configuration, the <Backspace> key be set to delete |
(Depending on your configuration, the <Backspace> key be set to delete |
the character to the left of the cursor and the <DEL> key set to delete |
the character to the left of the cursor and the <DEL> key set to delete |
the character underneath the cursor, like `C-d', rather than the | the character underneath the cursor, like 'C-d', rather than the |
character to the left of the cursor.) |
character to the left of the cursor.) |
|
|
|
|
Line 172 File: rluserman.info, Node: Readline Movement Command
|
Line 165 File: rluserman.info, Node: Readline Movement Command
|
-------------------------------- |
-------------------------------- |
|
|
The above table describes the most basic keystrokes that you need in |
The above table describes the most basic keystrokes that you need in |
order to do editing of the input line. For your convenience, many | order to do editing of the input line. For your convenience, many other |
other commands have been added in addition to `C-b', `C-f', `C-d', and | commands have been added in addition to 'C-b', 'C-f', 'C-d', and <DEL>. |
<DEL>. Here are some commands for moving more rapidly about the line. | Here are some commands for moving more rapidly about the line. |
|
|
`C-a' | 'C-a' |
Move to the start of the line. |
Move to the start of the line. |
| 'C-e' |
`C-e' | |
Move to the end of the line. |
Move to the end of the line. |
| 'M-f' |
`M-f' | |
Move forward a word, where a word is composed of letters and |
Move forward a word, where a word is composed of letters and |
digits. |
digits. |
| 'M-b' |
`M-b' | |
Move backward a word. |
Move backward a word. |
| 'C-l' |
`C-l' | |
Clear the screen, reprinting the current line at the top. |
Clear the screen, reprinting the current line at the top. |
|
|
Notice how `C-f' moves forward a character, while `M-f' moves | Notice how 'C-f' moves forward a character, while 'M-f' moves forward |
forward a word. It is a loose convention that control keystrokes | a word. It is a loose convention that control keystrokes operate on |
operate on characters while meta keystrokes operate on words. | characters while meta keystrokes operate on words. |
|
|
|
|
File: rluserman.info, Node: Readline Killing Commands, Next: Readline Arguments, Prev: Readline Movement Commands, Up: Readline Interaction |
File: rluserman.info, Node: Readline Killing Commands, Next: Readline Arguments, Prev: Readline Movement Commands, Up: Readline Interaction |
Line 203 File: rluserman.info, Node: Readline Killing Commands
|
Line 192 File: rluserman.info, Node: Readline Killing Commands
|
------------------------------- |
------------------------------- |
|
|
"Killing" text means to delete the text from the line, but to save it |
"Killing" text means to delete the text from the line, but to save it |
away for later use, usually by "yanking" (re-inserting) it back into | away for later use, usually by "yanking" (re-inserting) it back into the |
the line. (`Cut' and `paste' are more recent jargon for `kill' and | line. ('Cut' and 'paste' are more recent jargon for 'kill' and 'yank'.) |
`yank'.) | |
|
|
If the description for a command says that it `kills' text, then you | If the description for a command says that it 'kills' text, then you |
can be sure that you can get the text back in a different (or the same) |
can be sure that you can get the text back in a different (or the same) |
place later. |
place later. |
|
|
When you use a kill command, the text is saved in a "kill-ring". | When you use a kill command, the text is saved in a "kill-ring". Any |
Any number of consecutive kills save all of the killed text together, so | number of consecutive kills save all of the killed text together, so |
that when you yank it back, you get it all. The kill ring is not line |
that when you yank it back, you get it all. The kill ring is not line |
specific; the text that you killed on a previously typed line is |
specific; the text that you killed on a previously typed line is |
available to be yanked back later, when you are typing another line. | available to be yanked back later, when you are typing another line. |
|
|
Here is the list of commands for killing text. |
Here is the list of commands for killing text. |
|
|
`C-k' | 'C-k' |
Kill the text from the current cursor position to the end of the |
Kill the text from the current cursor position to the end of the |
line. |
line. |
|
|
`M-d' | 'M-d' |
Kill from the cursor to the end of the current word, or, if between |
Kill from the cursor to the end of the current word, or, if between |
words, to the end of the next word. Word boundaries are the same |
words, to the end of the next word. Word boundaries are the same |
as those used by `M-f'. | as those used by 'M-f'. |
|
|
`M-<DEL>' | 'M-<DEL>' |
Kill from the cursor the start of the current word, or, if between |
Kill from the cursor the start of the current word, or, if between |
words, to the start of the previous word. Word boundaries are the |
words, to the start of the previous word. Word boundaries are the |
same as those used by `M-b'. | same as those used by 'M-b'. |
|
|
`C-w' | 'C-w' |
Kill from the cursor to the previous whitespace. This is | Kill from the cursor to the previous whitespace. This is different |
different than `M-<DEL>' because the word boundaries differ. | than 'M-<DEL>' because the word boundaries differ. |
|
|
|
|
Here is how to "yank" the text back into the line. Yanking means to |
Here is how to "yank" the text back into the line. Yanking means to |
copy the most-recently-killed text from the kill buffer. |
copy the most-recently-killed text from the kill buffer. |
|
|
`C-y' | 'C-y' |
Yank the most recently killed text back into the buffer at the |
Yank the most recently killed text back into the buffer at the |
cursor. |
cursor. |
|
|
`M-y' | 'M-y' |
Rotate the kill-ring, and yank the new top. You can only do this |
Rotate the kill-ring, and yank the new top. You can only do this |
if the prior command is `C-y' or `M-y'. | if the prior command is 'C-y' or 'M-y'. |
|
|
|
|
File: rluserman.info, Node: Readline Arguments, Next: Searching, Prev: Readline Killing Commands, Up: Readline Interaction |
File: rluserman.info, Node: Readline Arguments, Next: Searching, Prev: Readline Killing Commands, Up: Readline Interaction |
Line 260 argument acts as a repeat count, other times it is the
|
Line 247 argument acts as a repeat count, other times it is the
|
argument that is significant. If you pass a negative argument to a |
argument that is significant. If you pass a negative argument to a |
command which normally acts in a forward direction, that command will |
command which normally acts in a forward direction, that command will |
act in a backward direction. For example, to kill text back to the |
act in a backward direction. For example, to kill text back to the |
start of the line, you might type `M-- C-k'. | start of the line, you might type 'M-- C-k'. |
|
|
The general way to pass numeric arguments to a command is to type |
The general way to pass numeric arguments to a command is to type |
meta digits before the command. If the first `digit' typed is a minus | meta digits before the command. If the first 'digit' typed is a minus |
sign (`-'), then the sign of the argument will be negative. Once you | sign ('-'), then the sign of the argument will be negative. Once you |
have typed one meta digit to get the argument started, you can type the |
have typed one meta digit to get the argument started, you can type the |
remainder of the digits, and then the command. For example, to give | remainder of the digits, and then the command. For example, to give the |
the `C-d' command an argument of 10, you could type `M-1 0 C-d', which | 'C-d' command an argument of 10, you could type 'M-1 0 C-d', which will |
will delete the next ten characters on the input line. | delete the next ten characters on the input line. |
|
|
|
|
File: rluserman.info, Node: Searching, Prev: Readline Arguments, Up: Readline Interaction |
File: rluserman.info, Node: Searching, Prev: Readline Arguments, Up: Readline Interaction |
Line 276 File: rluserman.info, Node: Searching, Prev: Readlin
|
Line 263 File: rluserman.info, Node: Searching, Prev: Readlin
|
1.2.5 Searching for Commands in the History |
1.2.5 Searching for Commands in the History |
------------------------------------------- |
------------------------------------------- |
|
|
Readline provides commands for searching through the command history | Readline provides commands for searching through the command history for |
for lines containing a specified string. There are two search modes: | lines containing a specified string. There are two search modes: |
"incremental" and "non-incremental". |
"incremental" and "non-incremental". |
|
|
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, |
search string. As each character of the search string is typed, |
Readline displays the next entry from the history matching the string |
Readline displays the next entry from the history matching the string |
typed so far. An incremental search requires only as many characters | typed so far. An incremental search requires only as many characters as |
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 `C-r'. Typing `C-s' searches | history for a particular string, type 'C-r'. Typing 'C-s' searches |
forward through the history. The characters present in the value of | forward through the history. The characters present in the value of the |
the `isearch-terminators' variable are used to terminate an incremental | 'isearch-terminators' variable are used to terminate an incremental |
search. If that variable has not been assigned a value, the <ESC> and |
search. If that variable has not been assigned a value, the <ESC> and |
`C-J' characters will terminate an incremental search. `C-g' will | 'C-J' characters will terminate an incremental search. 'C-g' will abort |
abort an incremental search and restore the original line. When the | an incremental search and restore the original line. When the search is |
search is terminated, the history entry containing the search string | terminated, the history entry containing the search string becomes the |
becomes the current line. | current line. |
|
|
To find other matching entries in the history list, type `C-r' or | To find other matching entries in the history list, type 'C-r' or |
`C-s' as appropriate. This will search backward or forward in the | 'C-s' as appropriate. This will search backward or forward in the |
history for the next entry matching the search string typed so far. | history for the next entry matching the search string typed so far. Any |
Any other key sequence bound to a Readline command will terminate the | other key sequence bound to a Readline command will terminate the search |
search and execute that command. For instance, a <RET> will terminate | and execute that command. For instance, a <RET> will terminate the |
the search and accept the line, thereby executing the command from the | search and accept the line, thereby executing the command from the |
history list. A movement command will terminate the search, make the |
history list. A movement command will terminate the search, make the |
last line found the current line, and begin editing. |
last line found the current line, and begin editing. |
|
|
Readline remembers the last incremental search string. If two | Readline remembers the last incremental search string. If two 'C-r's |
`C-r's are typed without any intervening characters defining a new | are typed without any intervening characters defining a new search |
search string, any remembered search string is used. | string, any remembered search string is used. |
|
|
Non-incremental searches read the entire search string before |
Non-incremental searches read the entire search string before |
starting to search for matching history lines. The search string may be |
starting to search for matching history lines. The search string may be |
Line 317 File: rluserman.info, Node: Readline Init File, Next
|
Line 304 File: rluserman.info, Node: Readline Init File, Next
|
1.3 Readline Init File |
1.3 Readline Init File |
====================== |
====================== |
|
|
Although the Readline library comes with a set of Emacs-like | Although the Readline library comes with a set of Emacs-like keybindings |
keybindings installed by default, it is possible to use a different set | installed by default, it is possible to use a different set of |
of keybindings. Any user can customize programs that use Readline by | keybindings. Any user can customize programs that use Readline by |
putting commands in an "inputrc" file, conventionally in his home |
putting commands in an "inputrc" file, conventionally in his home |
directory. The name of this file is taken from the value of the |
directory. The name of this file is taken from the value of the |
environment variable `INPUTRC'. If that variable is unset, the default | environment variable 'INPUTRC'. If that variable is unset, the default |
is `~/.inputrc'. If that file does not exist or cannot be read, the | is '~/.inputrc'. If that file does not exist or cannot be read, the |
ultimate default is `/etc/inputrc'. | ultimate default is '/etc/inputrc'. |
|
|
When a program which uses the Readline library starts up, the init |
When a program which uses the Readline library starts up, the init |
file is read, and the key bindings are set. |
file is read, and the key bindings are set. |
|
|
In addition, the `C-x C-r' command re-reads this init file, thus | In addition, the 'C-x C-r' command re-reads this init file, thus |
incorporating any changes that you might have made to it. |
incorporating any changes that you might have made to it. |
|
|
* Menu: |
* Menu: |
Line 346 File: rluserman.info, Node: Readline Init File Syntax
|
Line 333 File: rluserman.info, Node: Readline Init File Syntax
|
1.3.1 Readline Init File Syntax |
1.3.1 Readline Init File Syntax |
------------------------------- |
------------------------------- |
|
|
There are only a few basic constructs allowed in the Readline init | There are only a few basic constructs allowed in the Readline init file. |
file. Blank lines are ignored. Lines beginning with a `#' are | Blank lines are ignored. Lines beginning with a '#' are comments. |
comments. Lines beginning with a `$' indicate conditional constructs | Lines beginning with a '$' indicate conditional constructs (*note |
(*note Conditional Init Constructs::). Other lines denote variable | Conditional Init Constructs::). Other lines denote variable settings |
settings and key bindings. | and key bindings. |
|
|
Variable Settings |
Variable Settings |
You can modify the run-time behavior of Readline by altering the |
You can modify the run-time behavior of Readline by altering the |
values of variables in Readline using the `set' command within the | values of variables in Readline using the 'set' command within the |
init file. The syntax is simple: |
init file. The syntax is simple: |
|
|
set VARIABLE VALUE |
set VARIABLE VALUE |
|
|
Here, for example, is how to change from the default Emacs-like | Here, for example, is how to change from the default Emacs-like key |
key binding to use `vi' line editing commands: | binding to use 'vi' line editing commands: |
|
|
set editing-mode vi |
set editing-mode vi |
|
|
Line 368 Variable Settings
|
Line 355 Variable Settings
|
without regard to case. Unrecognized variable names are ignored. |
without regard to case. Unrecognized variable names are ignored. |
|
|
Boolean variables (those that can be set to on or off) are set to |
Boolean variables (those that can be set to on or off) are set to |
on if the value is null or empty, ON (case-insensitive), or 1. | on if the value is null or empty, ON (case-insensitive), or 1. Any |
Any other value results in the variable being set to off. | other value results in the variable being set to off. |
|
|
A great deal of run-time behavior is changeable with the following |
A great deal of run-time behavior is changeable with the following |
variables. |
variables. |
|
|
`bell-style' | 'bell-style' |
Controls what happens when Readline wants to ring the | Controls what happens when Readline wants to ring the terminal |
terminal bell. If set to `none', Readline never rings the | bell. If set to 'none', Readline never rings the bell. If |
bell. If set to `visible', Readline uses a visible bell if | set to 'visible', Readline uses a visible bell if one is |
one is available. If set to `audible' (the default), | available. If set to 'audible' (the default), Readline |
Readline attempts to ring the terminal's bell. | attempts to ring the terminal's bell. |
|
|
`bind-tty-special-chars' | 'bind-tty-special-chars' |
If set to `on', Readline attempts to bind the control | If set to 'on' (the default), Readline attempts to bind the |
characters treated specially by the kernel's terminal driver | control characters treated specially by the kernel's terminal |
to their Readline equivalents. | driver to their Readline equivalents. |
|
|
`colored-stats' | 'blink-matching-paren' |
If set to `on', Readline displays possible completions using | If set to 'on', Readline attempts to briefly move the cursor |
| to an opening parenthesis when a closing parenthesis is |
| inserted. The default is 'off'. |
| |
| 'colored-completion-prefix' |
| If set to 'on', 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 'LS_COLORS' environment variable. The default is |
| 'off'. |
| |
| 'colored-stats' |
| If set to 'on', Readline displays possible completions using |
different colors to indicate their file type. The color |
different colors to indicate their file type. The color |
definitions are taken from the value of the `LS_COLORS' | definitions are taken from the value of the 'LS_COLORS' |
environment variable. The default is `off'. | environment variable. The default is 'off'. |
|
|
`comment-begin' | 'comment-begin' |
The string to insert at the beginning of the line when the |
The string to insert at the beginning of the line when the |
`insert-comment' command is executed. The default value is | 'insert-comment' command is executed. The default value is |
`"#"'. | '"#"'. |
|
|
`completion-display-width' | 'completion-display-width' |
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 |
when performing completion. The value is ignored if it is |
less than 0 or greater than the terminal screen width. A |
less than 0 or greater than the terminal screen width. A |
value of 0 will cause matches to be displayed one per line. |
value of 0 will cause matches to be displayed one per line. |
The default value is -1. |
The default value is -1. |
|
|
`completion-ignore-case' | 'completion-ignore-case' |
If set to `on', Readline performs filename matching and | If set to 'on', Readline performs filename matching and |
completion in a case-insensitive fashion. The default value |
completion in a case-insensitive fashion. The default value |
is `off'. | is 'off'. |
|
|
`completion-map-case' | 'completion-map-case' |
If set to `on', and COMPLETION-IGNORE-CASE is enabled, | If set to 'on', and COMPLETION-IGNORE-CASE is enabled, |
Readline treats hyphens (`-') and underscores (`_') as | Readline treats hyphens ('-') and underscores ('_') as |
equivalent when performing case-insensitive filename matching |
equivalent when performing case-insensitive filename matching |
and completion. | and completion. The default value is 'off'. |
|
|
`completion-prefix-display-length' | 'completion-prefix-display-length' |
The length in characters of the common prefix of a list of |
The length in characters of the common prefix of a list of |
possible completions that is displayed without modification. |
possible completions that is displayed without modification. |
When set to a value greater than zero, common prefixes longer |
When set to a value greater than zero, common prefixes longer |
than this value are replaced with an ellipsis when displaying |
than this value are replaced with an ellipsis when displaying |
possible completions. |
possible completions. |
|
|
`completion-query-items' | 'completion-query-items' |
The number of possible completions that determines when the |
The number of possible completions that determines when the |
user is asked whether the list of possibilities should be |
user is asked whether the list of possibilities should be |
displayed. If the number of possible completions is greater |
displayed. If the number of possible completions is greater |
than this value, Readline will ask the user whether or not he | than or equal to this value, Readline will ask whether or not |
wishes to view them; otherwise, they are simply listed. This | the user wishes to view them; otherwise, they are simply |
variable must be set to an integer value greater than or | listed. This variable must be set to an integer value greater |
equal to 0. A negative value means Readline should never ask. | than or equal to 0. A negative value means Readline should |
The default limit is `100'. | never ask. The default limit is '100'. |
|
|
`convert-meta' | 'convert-meta' |
If set to `on', Readline will convert characters with the | If set to 'on', Readline will convert characters with the |
eighth bit set to an ASCII key sequence by stripping the |
eighth bit set to an ASCII key sequence by stripping the |
eighth bit and prefixing an <ESC> character, converting them |
eighth bit and prefixing an <ESC> character, converting them |
to a meta-prefixed key sequence. The default value is `on'. | to a meta-prefixed key sequence. The default value is 'on', |
| but will be set to 'off' if the locale is one that contains |
| eight-bit characters. |
|
|
`disable-completion' | 'disable-completion' |
If set to `On', Readline will inhibit word completion. | If set to 'On', Readline will inhibit word completion. |
Completion characters will be inserted into the line as if | Completion characters will be inserted into the line as if |
they had been mapped to `self-insert'. The default is `off'. | they had been mapped to 'self-insert'. The default is 'off'. |
|
|
`editing-mode' | 'echo-control-characters' |
The `editing-mode' variable controls which default set of key | When set to 'on', on operating systems that indicate they |
| support it, readline echoes a character corresponding to a |
| signal generated from the keyboard. The default is 'on'. |
| |
| 'editing-mode' |
| The 'editing-mode' variable controls which default set of key |
bindings is used. By default, Readline starts up in Emacs |
bindings is used. By default, Readline starts up in Emacs |
editing mode, where the keystrokes are most similar to Emacs. |
editing mode, where the keystrokes are most similar to Emacs. |
This variable can be set to either `emacs' or `vi'. | This variable can be set to either 'emacs' or 'vi'. |
|
|
`echo-control-characters' | 'emacs-mode-string' |
When set to `on', on operating systems that indicate they | If the SHOW-MODE-IN-PROMPT variable is enabled, this string is |
support it, readline echoes a character corresponding to a | displayed immediately before the last line of the primary |
signal generated from the keyboard. The default is `on'. | 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. The default is '@'. |
|
|
`enable-keypad' | 'enable-bracketed-paste' |
When set to `on', Readline will try to enable the application | When set to 'On', 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. The default is 'On'. |
| |
| 'enable-keypad' |
| When set to 'on', Readline will try to enable the application |
keypad when it is called. Some systems need this to enable |
keypad when it is called. Some systems need this to enable |
the arrow keys. The default is `off'. | the arrow keys. The default is 'off'. |
|
|
`enable-meta-key' | 'enable-meta-key' |
When set to `on', Readline will try to enable any meta | When set to 'on', Readline will try to enable any meta |
modifier key the terminal claims to support when it is | modifier key the terminal claims to support when it is called. |
called. On many terminals, the meta key is used to send | On many terminals, the meta key is used to send eight-bit |
eight-bit characters. The default is `on'. | characters. The default is 'on'. |
|
|
`expand-tilde' | 'expand-tilde' |
If set to `on', tilde expansion is performed when Readline | If set to 'on', tilde expansion is performed when Readline |
attempts word completion. The default is `off'. | attempts word completion. The default is 'off'. |
|
|
`history-preserve-point' | 'history-preserve-point' |
If set to `on', the history code attempts to place the point | If set to 'on', the history code attempts to place the point |
(the current cursor position) at the same location on each |
(the current cursor position) at the same location on each |
history line retrieved with `previous-history' or | history line retrieved with 'previous-history' or |
`next-history'. The default is `off'. | 'next-history'. The default is 'off'. |
|
|
`history-size' | 'history-size' |
Set the maximum number of history entries saved in the | Set the maximum number of history entries saved in the history |
history list. If set to zero, any existing history entries | list. If set to zero, any existing history entries are |
are deleted and no new entries are saved. If set to a value | deleted and no new entries are saved. If set to a value less |
less than zero, the number of history entries is not limited. | than zero, the number of history entries is not limited. By |
By default, the number of history entries is not limited. | default, the number of history entries is not limited. If an |
| attempt is made to set HISTORY-SIZE to a non-numeric value, |
| the maximum number of history entries will be set to 500. |
|
|
`horizontal-scroll-mode' | 'horizontal-scroll-mode' |
This variable can be set to either `on' or `off'. Setting it | This variable can be set to either 'on' or 'off'. Setting it |
to `on' means that the text of the lines being edited will | to 'on' means that the text of the lines being edited will |
scroll horizontally on a single screen line when they are |
scroll horizontally on a single screen line when they are |
longer than the width of the screen, instead of wrapping onto |
longer than the width of the screen, instead of wrapping onto |
a new screen line. By default, this variable is set to `off'. | a new screen line. This variable is automatically set to 'on' |
| for terminals of height 1. By default, this variable is set |
| to 'off'. |
|
|
`input-meta' | 'input-meta' |
If set to `on', Readline will enable eight-bit input (it will | If set to 'on', Readline will enable eight-bit input (it will |
not clear the eighth bit in the characters it reads), |
not clear the eighth bit in the characters it reads), |
regardless of what the terminal claims it can support. The |
regardless of what the terminal claims it can support. The |
default value is `off'. The name `meta-flag' is a synonym | default value is 'off', but Readline will set it to 'on' if |
for this variable. | the locale contains eight-bit characters. The name |
| 'meta-flag' is a synonym for this variable. |
|
|
`isearch-terminators' | 'isearch-terminators' |
The string of characters that should terminate an incremental |
The string of characters that should terminate an incremental |
search without subsequently executing the character as a |
search without subsequently executing the character as a |
command (*note Searching::). If this variable has not been |
command (*note Searching::). If this variable has not been |
given a value, the characters <ESC> and `C-J' will terminate | given a value, the characters <ESC> and 'C-J' will terminate |
an incremental search. |
an incremental search. |
|
|
`keymap' | 'keymap' |
Sets Readline's idea of the current keymap for key binding |
Sets Readline's idea of the current keymap for key binding |
commands. Acceptable `keymap' names are `emacs', | commands. Built-in 'keymap' names are 'emacs', |
`emacs-standard', `emacs-meta', `emacs-ctlx', `vi', `vi-move', | 'emacs-standard', 'emacs-meta', 'emacs-ctlx', 'vi', 'vi-move', |
`vi-command', and `vi-insert'. `vi' is equivalent to | 'vi-command', and 'vi-insert'. 'vi' is equivalent to |
`vi-command'; `emacs' is equivalent to `emacs-standard'. The | 'vi-command' ('vi-move' is also a synonym); 'emacs' is |
default value is `emacs'. The value of the `editing-mode' | equivalent to 'emacs-standard'. Applications may add |
variable also affects the default keymap. | additional names. The default value is 'emacs'. The value of |
| the 'editing-mode' variable also affects the default keymap. |
|
|
`keyseq-timeout' | 'keyseq-timeout' |
Specifies the duration Readline will wait for a character | Specifies the duration Readline will wait for a character when |
when reading an ambiguous key sequence (one that can form a | reading an ambiguous key sequence (one that can form a |
complete key sequence using the input read so far, or can | complete key sequence using the input read so far, or can take |
take additional input to complete a longer key sequence). If | additional input to complete a longer key sequence). If no |
no input is received within the timeout, Readline will use | input is received within the timeout, Readline will use the |
the shorter but complete key sequence. Readline uses this | shorter but complete key sequence. Readline uses this value |
value to determine whether or not input is available on the | to determine whether or not input is available on the current |
current input source (`rl_instream' by default). The value | input source ('rl_instream' by default). The value is |
is specified in milliseconds, so a value of 1000 means that | specified in milliseconds, so a value of 1000 means that |
Readline will wait one second for additional input. If this |
Readline will wait one second for additional input. If this |
variable is set to a value less than or equal to zero, or to a |
variable is set to a value less than or equal to zero, or to a |
non-numeric value, Readline will wait until another key is |
non-numeric value, Readline will wait until another key is |
pressed to decide which key sequence to complete. The | pressed to decide which key sequence to complete. The default |
default value is `500'. | value is '500'. |
|
|
`mark-directories' | 'mark-directories' |
If set to `on', completed directory names have a slash | If set to 'on', completed directory names have a slash |
appended. The default is `on'. | appended. The default is 'on'. |
|
|
`mark-modified-lines' | 'mark-modified-lines' |
This variable, when set to `on', causes Readline to display an | This variable, when set to 'on', causes Readline to display an |
asterisk (`*') at the start of history lines which have been | asterisk ('*') at the start of history lines which have been |
modified. This variable is `off' by default. | modified. This variable is 'off' by default. |
|
|
`mark-symlinked-directories' | 'mark-symlinked-directories' |
If set to `on', completed names which are symbolic links to | If set to 'on', completed names which are symbolic links to |
directories have a slash appended (subject to the value of |
directories have a slash appended (subject to the value of |
`mark-directories'). The default is `off'. | 'mark-directories'). The default is 'off'. |
|
|
`match-hidden-files' | 'match-hidden-files' |
This variable, when set to `on', causes Readline to match | This variable, when set to 'on', causes Readline to match |
files whose names begin with a `.' (hidden files) when | files whose names begin with a '.' (hidden files) when |
performing filename completion. If set to `off', the leading | performing filename completion. If set to 'off', the leading |
`.' must be supplied by the user in the filename to be | '.' must be supplied by the user in the filename to be |
completed. This variable is `on' by default. | completed. This variable is 'on' by default. |
|
|
`menu-complete-display-prefix' | 'menu-complete-display-prefix' |
If set to `on', menu completion displays the common prefix of | If set to 'on', menu completion displays the common prefix of |
the list of possible completions (which may be empty) before |
the list of possible completions (which may be empty) before |
cycling through the list. The default is `off'. | cycling through the list. The default is 'off'. |
|
|
`output-meta' | 'output-meta' |
If set to `on', Readline will display characters with the | If set to 'on', 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. The default is `off'. | sequence. The default is 'off', but Readline will set it to |
| 'on' if the locale contains eight-bit characters. |
|
|
`page-completions' | 'page-completions' |
If set to `on', Readline uses an internal `more'-like pager | If set to 'on', Readline uses an internal 'more'-like pager to |
to display a screenful of possible completions at a time. | display a screenful of possible completions at a time. This |
This variable is `on' by default. | variable is 'on' by default. |
|
|
`print-completions-horizontally' | 'print-completions-horizontally' |
If set to `on', Readline will display completions with matches | If set to 'on', Readline will display completions with matches |
sorted horizontally in alphabetical order, rather than down |
sorted horizontally in alphabetical order, rather than down |
the screen. The default is `off'. | the screen. The default is 'off'. |
|
|
`revert-all-at-newline' | 'revert-all-at-newline' |
If set to `on', Readline will undo all changes to history | If set to 'on', Readline will undo all changes to history |
lines before returning when `accept-line' is executed. By | lines before returning when 'accept-line' is executed. By |
default, history lines may be modified and retain individual |
default, history lines may be modified and retain individual |
undo lists across calls to `readline'. The default is `off'. | undo lists across calls to 'readline'. The default is 'off'. |
|
|
`show-all-if-ambiguous' | 'show-all-if-ambiguous' |
This alters the default behavior of the completion functions. |
This alters the default behavior of the completion functions. |
If set to `on', words which have more than one possible | If set to 'on', words which have more than one possible |
completion cause the matches to be listed immediately instead |
completion cause the matches to be listed immediately instead |
of ringing the bell. The default value is `off'. | of ringing the bell. The default value is 'off'. |
|
|
`show-all-if-unmodified' | 'show-all-if-unmodified' |
This alters the default behavior of the completion functions |
This alters the default behavior of the completion functions |
in a fashion similar to SHOW-ALL-IF-AMBIGUOUS. If set to |
in a fashion similar to SHOW-ALL-IF-AMBIGUOUS. If set to |
`on', words which have more than one possible completion | 'on', words which have more than one possible completion |
without any possible partial completion (the possible |
without any possible partial completion (the possible |
completions don't share a common prefix) cause the matches to |
completions don't share a common prefix) cause the matches to |
be listed immediately instead of ringing the bell. The |
be listed immediately instead of ringing the bell. The |
default value is `off'. | default value is 'off'. |
|
|
`show-mode-in-prompt' | 'show-mode-in-prompt' |
If set to `on', add a character to the beginning of the prompt | If set to 'on', add a string to the beginning of the prompt |
indicating the editing mode: emacs (`@'), vi command (`:'), | indicating the editing mode: emacs, vi command, or vi |
or vi insertion (`+'). The default value is `off'. | insertion. The mode strings are user-settable (e.g., |
| EMACS-MODE-STRING). The default value is 'off'. |
|
|
`skip-completed-text' | 'skip-completed-text' |
If set to `on', this alters the default completion behavior | If set to 'on', this alters the default completion behavior |
when inserting a single match into the line. It's only | when inserting a single match into the line. It's only active |
active when performing completion in the middle of a word. | when performing completion in the middle of a word. If |
If enabled, readline does not insert characters from the | enabled, readline does not insert characters from the |
completion that match characters after point in the word | completion that match characters after point in the word being |
being completed, so portions of the word following the cursor | completed, so portions of the word following the cursor are |
are not duplicated. For instance, if this is enabled, | not duplicated. For instance, if this is enabled, attempting |
attempting completion when the cursor is after the `e' in | completion when the cursor is after the 'e' in 'Makefile' will |
`Makefile' will result in `Makefile' rather than | result in 'Makefile' rather than 'Makefilefile', assuming |
`Makefilefile', assuming there is a single possible | there is a single possible completion. The default value is |
completion. The default value is `off'. | 'off'. |
|
|
`visible-stats' | 'vi-cmd-mode-string' |
If set to `on', a character denoting a file's type is | If the SHOW-MODE-IN-PROMPT variable is enabled, this string is |
appended to the filename when listing possible completions. | displayed immediately before the last line of the primary |
The default is `off'. | 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 control sequence into the mode string. The |
| default is '(cmd)'. |
|
|
|
'vi-ins-mode-string' |
|
If the SHOW-MODE-IN-PROMPT 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 control sequence into the mode string. The |
|
default is '(ins)'. |
|
|
|
'visible-stats' |
|
If set to 'on', a character denoting a file's type is appended |
|
to the filename when listing possible completions. The |
|
default is 'off'. |
|
|
Key Bindings |
Key Bindings |
The syntax for controlling key bindings in the init file is | The syntax for controlling key bindings in the init file is simple. |
simple. First you need to find the name of the command that you | First you need to find the name of the command that you want to |
want to change. The following sections contain tables of the | change. The following sections contain tables of the command name, |
command name, the default keybinding, if any, and a short | the default keybinding, if any, and a short description of what the |
description of what the command does. | command does. |
|
|
Once you know the name of the command, simply place on a line in |
Once you know the name of the command, simply place on a line in |
the init file the name of the key you wish to bind the command to, |
the init file the name of the key you wish to bind the command to, |
Line 628 Key Bindings
|
Line 676 Key Bindings
|
part of the key name. The name of the key can be expressed in |
part of the key name. The name of the key can be expressed in |
different ways, depending on what you find most comfortable. |
different ways, depending on what you find most comfortable. |
|
|
In addition to command names, readline allows keys to be bound to | In addition to command names, readline allows keys to be bound to a |
a string that is inserted when the key is pressed (a MACRO). | string that is inserted when the key is pressed (a MACRO). |
|
|
KEYNAME: FUNCTION-NAME or MACRO | KEYNAME: FUNCTION-NAME or MACRO |
KEYNAME is the name of a key spelled out in English. For |
KEYNAME is the name of a key spelled out in English. For |
example: |
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 | In the example above, 'C-u' is bound to the function |
`universal-argument', `M-DEL' is bound to the function | 'universal-argument', 'M-DEL' is bound to the function |
`backward-kill-word', and `C-o' is bound to run the macro | 'backward-kill-word', and 'C-o' is bound to run the macro |
expressed on the right hand side (that is, to insert the text |
expressed on the right hand side (that is, to insert the text |
`> output' into the line). | '> output' into the line). |
|
|
A number of symbolic character names are recognized while |
A number of symbolic character names are recognized while |
processing this key binding syntax: DEL, ESC, ESCAPE, LFD, |
processing this key binding syntax: DEL, ESC, ESCAPE, LFD, |
NEWLINE, RET, RETURN, RUBOUT, SPACE, SPC, and TAB. |
NEWLINE, RET, RETURN, RUBOUT, SPACE, SPC, and TAB. |
|
|
"KEYSEQ": FUNCTION-NAME or MACRO | "KEYSEQ": FUNCTION-NAME or MACRO |
KEYSEQ differs from KEYNAME above in that strings denoting an |
KEYSEQ differs from KEYNAME above in that strings denoting an |
entire key sequence can be specified, by placing the key |
entire key sequence can be specified, by placing the key |
sequence in double quotes. Some GNU Emacs style key escapes |
sequence in double quotes. Some GNU Emacs style key escapes |
Line 659 Key Bindings
|
Line 707 Key Bindings
|
"\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 the above example, `C-u' is again bound to the function | In the above example, 'C-u' is again bound to the function |
`universal-argument' (just as it was in the first example), | 'universal-argument' (just as it was in the first example), |
`C-x C-r' is bound to the function `re-read-init-file', and | ''C-x' 'C-r'' is bound to the function 're-read-init-file', |
`<ESC> <[> <1> <1> <~>' is bound to insert the text `Function | and '<ESC> <[> <1> <1> <~>' is bound to insert the text |
Key 1'. | 'Function Key 1'. |
|
|
|
|
The following GNU Emacs style escape sequences are available when |
The following GNU Emacs style escape sequences are available when |
specifying key sequences: |
specifying key sequences: |
|
|
`\C-' | '\C-' |
control prefix |
control prefix |
| '\M-' |
`\M-' | |
meta prefix |
meta prefix |
| '\e' |
`\e' | |
an escape character |
an escape character |
| '\\' |
`\\' | |
backslash |
backslash |
| '\"' |
`\"' | |
<">, a double quotation mark |
<">, a double quotation mark |
| '\'' |
`\'' | |
<'>, a single quote or apostrophe |
<'>, a single quote or apostrophe |
|
|
In addition to the GNU Emacs style escape sequences, a second set |
In addition to the GNU Emacs style escape sequences, a second set |
of backslash escapes is available: |
of backslash escapes is available: |
|
|
`\a' | '\a' |
alert (bell) |
alert (bell) |
| '\b' |
`\b' | |
backspace |
backspace |
| '\d' |
`\d' | |
delete |
delete |
| '\f' |
`\f' | |
form feed |
form feed |
| '\n' |
`\n' | |
newline |
newline |
| '\r' |
`\r' | |
carriage return |
carriage return |
| '\t' |
`\t' | |
horizontal tab |
horizontal tab |
| '\v' |
`\v' | |
vertical tab |
vertical tab |
| '\NNN' |
`\NNN' | |
the eight-bit character whose value is the octal value NNN |
the eight-bit character whose value is the octal value NNN |
(one to three digits) |
(one to three digits) |
| '\xHH' |
`\xHH' | |
the eight-bit character whose value is the hexadecimal value |
the eight-bit character whose value is the hexadecimal value |
HH (one or two hex digits) |
HH (one or two hex digits) |
|
|
Line 726 Key Bindings
|
Line 759 Key Bindings
|
used to indicate a macro definition. Unquoted text is assumed to |
used to indicate a macro definition. Unquoted text is assumed to |
be a function name. In the macro body, the backslash escapes |
be a function name. In the macro body, the backslash escapes |
described above are expanded. Backslash will quote any other |
described above are expanded. Backslash will quote any other |
character in the macro text, including `"' and `''. For example, | character in the macro text, including '"' and '''. For example, |
the following binding will make `C-x \' insert a single `\' into | the following binding will make ''C-x' \' insert a single '\' into |
the line: |
the line: |
"\C-x\\": "\\" |
"\C-x\\": "\\" |
|
|
|
|
|
|
File: rluserman.info, Node: Conditional Init Constructs, Next: Sample Init File, Prev: Readline Init File Syntax, Up: Readline Init File |
File: rluserman.info, Node: Conditional Init Constructs, Next: Sample Init File, Prev: Readline Init File Syntax, Up: Readline Init File |
|
|
Line 739 File: rluserman.info, Node: Conditional Init Construc
|
Line 771 File: rluserman.info, Node: Conditional Init Construc
|
--------------------------------- |
--------------------------------- |
|
|
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 |
and variable settings to be performed as the result of tests. There | variable settings to be performed as the result of tests. There are |
are four parser directives used. | four parser directives used. |
|
|
`$if' | '$if' |
The `$if' construct allows bindings to be made based on the | The '$if' construct allows bindings to be made based on the editing |
editing mode, the terminal being used, or the application using | mode, the terminal being used, or the application using Readline. |
Readline. The text of the test extends to the end of the line; no | The text of the test, after any comparison operator, extends to the |
characters are required to isolate it. | end of the line; unless otherwise noted, no characters are required |
| to isolate it. |
|
|
`mode' | 'mode' |
The `mode=' form of the `$if' directive is used to test | The 'mode=' form of the '$if' directive 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 |
used in conjunction with the `set keymap' command, for | in conjunction with the 'set keymap' command, for instance, to |
instance, to set bindings in the `emacs-standard' and | set bindings in the 'emacs-standard' and 'emacs-ctlx' keymaps |
`emacs-ctlx' keymaps only if Readline is starting out in | only if Readline is starting out in 'emacs' mode. |
`emacs' mode. | |
|
|
`term' | 'term' |
The `term=' form may be used to include terminal-specific key | The 'term=' form may be used to include terminal-specific key |
bindings, perhaps to bind the key sequences output by the |
bindings, perhaps to bind the key sequences output by the |
terminal's function keys. The word on the right side of the |
terminal's function keys. The word on the right side of the |
`=' is tested against both the full name of the terminal and | '=' is tested against both the full name of the terminal and |
the portion of the terminal name before the first `-'. This | the portion of the terminal name before the first '-'. This |
allows `sun' to match both `sun' and `sun-cmd', for instance. | allows 'sun' to match both 'sun' and 'sun-cmd', for instance. |
|
|
`application' | 'version' |
| The 'version' test may be used to perform comparisons against |
| specific Readline versions. The 'version' expands to the |
| current Readline version. The set of comparison operators |
| includes '=' (and '=='), '!=', '<=', '>=', '<', and '>'. 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., '7.1'). If the minor |
| version is omitted, it is assumed to be '0'. The operator may |
| be separated from the string 'version' and from the version |
| number argument by whitespace. The following example sets a |
| variable if the Readline version being used is 7.0 or newer: |
| $if version >= 7.0 |
| set show-mode-in-prompt on |
| $endif |
| |
| 'application' |
The APPLICATION construct is used to include |
The APPLICATION construct is used to include |
application-specific settings. Each program using the |
application-specific settings. Each program using the |
Readline library sets the APPLICATION NAME, and you can test |
Readline library sets the APPLICATION NAME, and you can test |
Line 778 are four parser directives used.
|
Line 826 are four parser directives used.
|
"\C-xq": "\eb\"\ef\"" |
"\C-xq": "\eb\"\ef\"" |
$endif |
$endif |
|
|
`$endif' | 'variable' |
This command, as seen in the previous example, terminates an `$if' | The VARIABLE construct provides simple equality tests for |
| Readline variables and values. The permitted comparison |
| operators are '=', '==', and '!='. 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 |
| ON and OFF. The following example is equivalent to the |
| 'mode=emacs' test described above: |
| $if editing-mode == emacs |
| set show-mode-in-prompt on |
| $endif |
| |
| '$endif' |
| This command, as seen in the previous example, terminates an '$if' |
command. |
command. |
|
|
`$else' | '$else' |
Commands in this branch of the `$if' directive are executed if the | Commands in this branch of the '$if' directive are executed if the |
test fails. |
test fails. |
|
|
`$include' | '$include' |
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 following |
commands and bindings from that file. For example, the following |
directive reads from `/etc/inputrc': | directive reads from '/etc/inputrc': |
$include /etc/inputrc |
$include /etc/inputrc |
|
|
|
|
Line 801 File: rluserman.info, Node: Sample Init File, Prev:
|
Line 863 File: rluserman.info, Node: Sample Init File, Prev:
|
Here is an example of an INPUTRC file. This illustrates key binding, |
Here is an example of an INPUTRC file. This illustrates key binding, |
variable assignment, and conditional syntax. |
variable assignment, and conditional syntax. |
|
|
|
|
# This file controls the behaviour of line input editing for |
# This file controls the behaviour of line input editing for |
# programs that use the GNU Readline library. Existing |
# programs that use the GNU Readline library. Existing |
# programs include FTP, Bash, and GDB. |
# programs include FTP, Bash, and GDB. |
Line 891 variable assignment, and conditional syntax.
|
Line 952 variable assignment, and conditional syntax.
|
# rather than as meta-prefixed characters |
# rather than as meta-prefixed characters |
set output-meta on |
set output-meta on |
|
|
# if there are more than 150 possible completions for | # if there are 150 or more possible completions for a word, |
# a word, ask the user if he wants to see all of them | # ask whether or not the user wants to see all of them |
set completion-query-items 150 |
set completion-query-items 150 |
|
|
# For FTP |
# For FTP |
Line 919 File: rluserman.info, Node: Bindable Readline Command
|
Line 980 File: rluserman.info, Node: Bindable Readline Command
|
* Keyboard Macros:: Saving and re-executing typed characters |
* Keyboard Macros:: Saving and re-executing typed characters |
* Miscellaneous Commands:: Other miscellaneous commands. |
* Miscellaneous Commands:: Other miscellaneous commands. |
|
|
This section describes Readline commands that may be bound to key | This section describes Readline commands that may be bound to key |
sequences. Command names without an accompanying key sequence are |
sequences. Command names without an accompanying key sequence are |
unbound by default. |
unbound by default. |
|
|
In the following descriptions, "point" refers to the current cursor |
In the following descriptions, "point" refers to the current cursor |
position, and "mark" refers to a cursor position saved by the | position, and "mark" refers to a cursor position saved by the 'set-mark' |
`set-mark' command. The text between the point and mark is referred to | command. The text between the point and mark is referred to as the |
as the "region". | "region". |
|
|
|
|
File: rluserman.info, Node: Commands For Moving, Next: Commands For History, Up: Bindable Readline Commands |
File: rluserman.info, Node: Commands For Moving, Next: Commands For History, Up: Bindable Readline Commands |
Line 934 File: rluserman.info, Node: Commands For Moving, Nex
|
Line 995 File: rluserman.info, Node: Commands For Moving, Nex
|
1.4.1 Commands For Moving |
1.4.1 Commands For Moving |
------------------------- |
------------------------- |
|
|
`beginning-of-line (C-a)' | 'beginning-of-line (C-a)' |
Move to the start of the current line. |
Move to the start of the current line. |
|
|
`end-of-line (C-e)' | 'end-of-line (C-e)' |
Move to the end of the line. |
Move to the end of the line. |
|
|
`forward-char (C-f)' | 'forward-char (C-f)' |
Move forward a character. |
Move forward a character. |
|
|
`backward-char (C-b)' | 'backward-char (C-b)' |
Move back a character. |
Move back a character. |
|
|
`forward-word (M-f)' | 'forward-word (M-f)' |
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 |
letters and digits. |
letters and digits. |
|
|
`backward-word (M-b)' | 'backward-word (M-b)' |
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 letters and digits. |
composed of letters and digits. |
|
|
`clear-screen (C-l)' | 'previous-screen-line ()' |
Clear the screen and redraw the current line, leaving the current | 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. |
| |
| '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. |
| |
| '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. |
| |
| 'clear-screen (C-l)' |
| Clear the screen, then redraw the current line, leaving the current |
line at the top of the screen. |
line at the top of the screen. |
|
|
`redraw-current-line ()' | 'redraw-current-line ()' |
Refresh the current line. By default, this is unbound. |
Refresh the current line. By default, this is unbound. |
|
|
|
|
|
|
File: rluserman.info, Node: Commands For History, Next: Commands For Text, Prev: Commands For Moving, Up: Bindable Readline Commands |
File: rluserman.info, Node: Commands For History, Next: Commands For Text, Prev: Commands For Moving, Up: Bindable Readline Commands |
|
|
1.4.2 Commands For Manipulating The History |
1.4.2 Commands For Manipulating The History |
------------------------------------------- |
------------------------------------------- |
|
|
`accept-line (Newline or Return)' | 'accept-line (Newline or Return)' |
Accept the line regardless of where the cursor is. If this line is |
Accept the line regardless of where the cursor is. If this line is |
non-empty, it may be added to the history list for future recall |
non-empty, it may be added to the history list for future recall |
with `add_history()'. If this line is a modified history line, | with 'add_history()'. If this line is a modified history line, the |
the history line is restored to its original state. | history line is restored to its original state. |
|
|
`previous-history (C-p)' | 'previous-history (C-p)' |
Move `back' through the history list, fetching the previous | Move 'back' through the history list, fetching the previous |
command. |
command. |
|
|
`next-history (C-n)' | 'next-history (C-n)' |
Move `forward' through the history list, fetching the next command. | Move 'forward' through the history list, fetching the next command. |
|
|
`beginning-of-history (M-<)' | 'beginning-of-history (M-<)' |
Move to the first line in the history. |
Move to the first line in the history. |
|
|
`end-of-history (M->)' | 'end-of-history (M->)' |
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. |
|
|
`reverse-search-history (C-r)' | 'reverse-search-history (C-r)' |
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 search. |
through the history as necessary. This is an incremental search. |
|
This command sets the region to the matched text and activates the |
|
mark. |
|
|
`forward-search-history (C-s)' | 'forward-search-history (C-s)' |
Search forward starting at the current line and moving `down' | Search forward starting at the current line and moving 'down' |
through the the history as necessary. This is an incremental | through the history as necessary. This is an incremental search. |
search. | This command sets the region to the matched text and activates the |
| mark. |
|
|
`non-incremental-reverse-search-history (M-p)' | 'non-incremental-reverse-search-history (M-p)' |
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 using a non-incremental search | through the history as necessary using a non-incremental search for |
for a string supplied by the user. | a string supplied by the user. The search string may match |
| anywhere in a history line. |
|
|
`non-incremental-forward-search-history (M-n)' | 'non-incremental-forward-search-history (M-n)' |
Search forward starting at the current line and moving `down' | Search forward starting at the current line and moving 'down' |
through the the history as necessary using a non-incremental search | through the history as necessary using a non-incremental search for |
for a string supplied by the user. | a string supplied by the user. The search string may match |
| anywhere in a history line. |
|
|
`history-search-forward ()' | 'history-search-forward ()' |
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. By default, this command is unbound. |
non-incremental search. By default, this command is unbound. |
|
|
`history-search-backward ()' | 'history-search-backward ()' |
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 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. By default, this command is unbound. |
non-incremental search. By default, this command is unbound. |
|
|
`history-substr-search-forward ()' | 'history-substring-search-forward ()' |
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 |
string may match anywhere in a history line. This is a |
non-incremental search. By default, this command is unbound. |
non-incremental search. By default, this command is unbound. |
|
|
`history-substr-search-backward ()' | 'history-substring-search-backward ()' |
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 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 |
string may match anywhere in a history line. This is a |
non-incremental search. By default, this command is unbound. |
non-incremental search. By default, this command is unbound. |
|
|
`yank-nth-arg (M-C-y)' | 'yank-nth-arg (M-C-y)' |
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 N, |
insert the Nth word from the previous command (the words in the |
insert the Nth word from the previous command (the words in the |
previous command begin with word 0). A negative argument inserts |
previous command begin with word 0). A negative argument inserts |
the Nth word from the end of the previous command. Once the |
the Nth word from the end of the previous command. Once the |
argument N is computed, the argument is extracted as if the `!N' | argument N is computed, the argument is extracted as if the '!N' |
history expansion had been specified. |
history expansion had been specified. |
|
|
`yank-last-arg (M-. or M-_)' | 'yank-last-arg (M-. or M-_)' |
Insert last argument to the previous command (the last word of the |
Insert last argument to the previous command (the last word of the |
previous history entry). With a numeric argument, behave exactly |
previous history entry). With a numeric argument, behave exactly |
like `yank-nth-arg'. Successive calls to `yank-last-arg' move | like 'yank-nth-arg'. Successive calls to 'yank-last-arg' move back |
back through the history list, inserting the last word (or the | through the history list, inserting the last word (or the word |
word specified by the argument to the first call) of each line in | specified by the argument to the first call) of each line in turn. |
turn. Any numeric argument supplied to these successive calls | Any numeric argument supplied to these successive calls determines |
determines the direction to move through the history. A negative | the direction to move through the history. A negative argument |
argument switches the direction through the history (back or | switches the direction through the history (back or forward). The |
forward). The history expansion facilities are used to extract | history expansion facilities are used to extract the last argument, |
the last argument, as if the `!$' history expansion had been | as if the '!$' history expansion had been specified. |
specified. | |
|
|
|
'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. |
|
|
|
|
File: rluserman.info, Node: Commands For Text, Next: Commands For Killing, Prev: Commands For History, Up: Bindable Readline Commands |
File: rluserman.info, Node: Commands For Text, Next: Commands For Killing, Prev: Commands For History, Up: Bindable Readline Commands |
Line 1060 File: rluserman.info, Node: Commands For Text, Next:
|
Line 1149 File: rluserman.info, Node: Commands For Text, Next:
|
1.4.3 Commands For Changing Text |
1.4.3 Commands For Changing Text |
-------------------------------- |
-------------------------------- |
|
|
`end-of-file (usually C-d)' | 'end-of-file (usually C-d)' |
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 characters on | 'stty'. If this character is read when there are no characters on |
the line, and point is at the beginning of the line, Readline |
the line, and point is at the beginning of the line, Readline |
interprets it as the end of input and returns EOF. |
interprets it as the end of input and returns EOF. |
|
|
`delete-char (C-d)' | 'delete-char (C-d)' |
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 EOF character, as `C-d' commonly is, see | same character as the tty EOF character, as 'C-d' commonly is, see |
above for the effects. |
above for the effects. |
|
|
`backward-delete-char (Rubout)' | 'backward-delete-char (Rubout)' |
Delete the character behind the cursor. A numeric argument means |
Delete the character behind the cursor. A numeric argument means |
to kill the characters instead of deleting them. |
to kill the characters instead of deleting them. |
|
|
`forward-backward-delete-char ()' | 'forward-backward-delete-char ()' |
Delete the character under the cursor, unless the cursor is at the |
Delete the character under the cursor, unless the cursor is at the |
end of the line, in which case the character behind the cursor is |
end of the line, in which case the character behind the cursor is |
deleted. By default, this is not bound to a key. |
deleted. By default, this is not bound to a key. |
|
|
`quoted-insert (C-q or C-v)' | 'quoted-insert (C-q or C-v)' |
Add the next character typed to the line verbatim. This is how to |
Add the next character typed to the line verbatim. This is how to |
insert key sequences like `C-q', for example. | insert key sequences like 'C-q', for example. |
|
|
`tab-insert (M-<TAB>)' | 'tab-insert (M-<TAB>)' |
Insert a tab character. |
Insert a tab character. |
|
|
`self-insert (a, b, A, 1, !, ...)' | 'self-insert (a, b, A, 1, !, ...)' |
Insert yourself. |
Insert yourself. |
|
|
`transpose-chars (C-t)' | 'bracketed-paste-begin ()' |
| This function is intended to be bound to the "bracketed paste" |
| escape sequence sent by some terminals, and such a binding is |
| assigned by default. It allows Readline to insert the pasted text |
| as a single unit without treating each character as if it had been |
| read from the keyboard. The characters are inserted as if each one |
| was bound to 'self-insert' instead of executing any editing |
| commands. |
| |
| Bracketed paste sets the region (the characters between point and |
| the mark) to the inserted text. It uses the concept of an _active |
| mark_: when the mark is active, Readline redisplay uses the |
| terminal's standout mode to denote the region. |
| |
| 'transpose-chars (C-t)' |
Drag the character before the cursor forward over the character at |
Drag the character before the cursor forward over the character at |
the cursor, moving the cursor forward as well. If the insertion |
the cursor, moving the cursor forward as well. If the insertion |
point is at the end of the line, then this transposes the last two |
point is at the end of the line, then this transposes the last two |
characters of the line. Negative arguments have no effect. |
characters of the line. Negative arguments have no effect. |
|
|
`transpose-words (M-t)' | 'transpose-words (M-t)' |
Drag the word before point past the word after point, moving point |
Drag the word before point past the word after point, moving point |
past that word as well. If the insertion point is at the end of |
past that word as well. If the insertion point is at the end of |
the line, this transposes the last two words on the line. |
the line, this transposes the last two words on the line. |
|
|
`upcase-word (M-u)' | 'upcase-word (M-u)' |
Uppercase the current (or following) word. With a negative |
Uppercase the current (or following) word. With a negative |
argument, uppercase the previous word, but do not move the cursor. |
argument, uppercase the previous word, but do not move the cursor. |
|
|
`downcase-word (M-l)' | 'downcase-word (M-l)' |
Lowercase the current (or following) word. With a negative |
Lowercase the current (or following) word. With a negative |
argument, lowercase the previous word, but do not move the cursor. |
argument, lowercase the previous word, but do not move the cursor. |
|
|
`capitalize-word (M-c)' | 'capitalize-word (M-c)' |
Capitalize the current (or following) word. With a negative |
Capitalize the current (or following) word. With a negative |
argument, capitalize the previous word, but do not move the cursor. |
argument, capitalize the previous word, but do not move the cursor. |
|
|
`overwrite-mode ()' | 'overwrite-mode ()' |
Toggle overwrite mode. With an explicit positive numeric argument, |
Toggle overwrite mode. With an explicit positive numeric argument, |
switches to overwrite mode. With an explicit non-positive numeric |
switches to overwrite mode. With an explicit non-positive numeric |
argument, switches to insert mode. This command affects only |
argument, switches to insert mode. This command affects only |
`emacs' mode; `vi' mode does overwrite differently. Each call to | 'emacs' mode; 'vi' mode does overwrite differently. Each call to |
`readline()' starts in insert mode. | 'readline()' starts in insert mode. |
|
|
In overwrite mode, characters bound to `self-insert' replace the | In overwrite mode, characters bound to 'self-insert' replace the |
text at point rather than pushing the text to the right. |
text at point rather than pushing the text to the right. |
Characters bound to `backward-delete-char' replace the character | Characters bound to 'backward-delete-char' replace the character |
before point with a space. |
before point with a space. |
|
|
By default, this command is unbound. |
By default, this command is unbound. |
|
|
|
|
|
|
File: rluserman.info, Node: Commands For Killing, Next: Numeric Arguments, Prev: Commands For Text, Up: Bindable Readline Commands |
File: rluserman.info, Node: Commands For Killing, Next: Numeric Arguments, Prev: Commands For Text, Up: Bindable Readline Commands |
|
|
1.4.4 Killing And Yanking |
1.4.4 Killing And Yanking |
------------------------- |
------------------------- |
|
|
`kill-line (C-k)' | 'kill-line (C-k)' |
Kill the text from point to the end of the line. | Kill the text from point to the end of the line. With a negative |
| numeric argument, kill backward from the cursor to the beginning of |
| the current line. |
|
|
`backward-kill-line (C-x Rubout)' | 'backward-kill-line (C-x Rubout)' |
Kill backward to the beginning of the line. | Kill backward from the cursor to the beginning of the current line. |
| With a negative numeric argument, kill forward from the cursor to |
| the end of the current line. |
|
|
`unix-line-discard (C-u)' | 'unix-line-discard (C-u)' |
Kill backward from the cursor to the beginning of the current line. |
Kill backward from the cursor to the beginning of the current line. |
|
|
`kill-whole-line ()' | '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. |
By default, this is unbound. |
By default, this is unbound. |
|
|
`kill-word (M-d)' | 'kill-word (M-d)' |
Kill from point to the end of the current word, or if between |
Kill from point to the end of the current word, or if between |
words, to the end of the next word. Word boundaries are the same |
words, to the end of the next word. Word boundaries are the same |
as `forward-word'. | as 'forward-word'. |
|
|
`backward-kill-word (M-<DEL>)' | 'backward-kill-word (M-<DEL>)' |
Kill the word behind point. Word boundaries are the same as |
Kill the word behind point. Word boundaries are the same as |
`backward-word'. | 'backward-word'. |
|
|
`unix-word-rubout (C-w)' | 'shell-transpose-words (M-C-t)' |
| Drag the word before point past the word after point, moving point |
| past that word as well. If the insertion point is at the end of |
| the line, this transposes the last two words on the line. Word |
| boundaries are the same as 'shell-forward-word' and |
| 'shell-backward-word'. |
| |
| 'unix-word-rubout (C-w)' |
Kill the word behind point, using white space as a word boundary. |
Kill the word behind point, using white space as a word boundary. |
The killed text is saved on the kill-ring. |
The killed text is saved on the kill-ring. |
|
|
`unix-filename-rubout ()' | 'unix-filename-rubout ()' |
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 the |
character as the word boundaries. The killed text is saved on the |
kill-ring. |
kill-ring. |
|
|
`delete-horizontal-space ()' | 'delete-horizontal-space ()' |
Delete all spaces and tabs around point. By default, this is |
Delete all spaces and tabs around point. By default, this is |
unbound. |
unbound. |
|
|
`kill-region ()' | 'kill-region ()' |
Kill the text in the current region. By default, this command is |
Kill the text in the current region. By default, this command is |
unbound. |
unbound. |
|
|
`copy-region-as-kill ()' | 'copy-region-as-kill ()' |
Copy the text in the region to the kill buffer, so it can be yanked |
Copy the text in the region to the kill buffer, so it can be yanked |
right away. By default, this command is unbound. |
right away. By default, this command is unbound. |
|
|
`copy-backward-word ()' | 'copy-backward-word ()' |
Copy the word before point to the kill buffer. The word | Copy the word before point to the kill buffer. The word boundaries |
boundaries are the same as `backward-word'. By default, this | are the same as 'backward-word'. By default, this command is |
command is unbound. | unbound. |
|
|
`copy-forward-word ()' | 'copy-forward-word ()' |
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 `forward-word'. By default, this | boundaries are the same as 'forward-word'. By default, this |
command is unbound. |
command is unbound. |
|
|
`yank (C-y)' | 'yank (C-y)' |
Yank the top of the kill ring into the buffer at point. |
Yank the top of the kill ring into the buffer at point. |
|
|
`yank-pop (M-y)' | 'yank-pop (M-y)' |
Rotate the kill-ring, and yank the new top. You can only do this |
Rotate the kill-ring, and yank the new top. You can only do this |
if the prior command is `yank' or `yank-pop'. | if the prior command is 'yank' or 'yank-pop'. |
|
|
|
|
File: rluserman.info, Node: Numeric Arguments, Next: Commands For Completion, Prev: Commands For Killing, Up: Bindable Readline Commands |
File: rluserman.info, Node: Numeric Arguments, Next: Commands For Completion, Prev: Commands For Killing, Up: Bindable Readline Commands |
Line 1200 File: rluserman.info, Node: Numeric Arguments, Next:
|
Line 1313 File: rluserman.info, Node: Numeric Arguments, Next:
|
1.4.5 Specifying Numeric Arguments |
1.4.5 Specifying Numeric Arguments |
---------------------------------- |
---------------------------------- |
|
|
`digit-argument (M-0, M-1, ... M--)' | 'digit-argument (M-0, M-1, ... M--)' |
Add this digit to the argument already accumulating, or start a new |
Add this digit to the argument already accumulating, or start a new |
argument. `M--' starts a negative argument. | argument. 'M--' starts a negative argument. |
|
|
`universal-argument ()' | 'universal-argument ()' |
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 | sign, those digits define the argument. If the command is followed |
followed by digits, executing `universal-argument' again ends the | by digits, executing 'universal-argument' again ends the numeric |
numeric argument, but is otherwise ignored. As a special case, if | argument, but is otherwise ignored. As a special case, if this |
this command is immediately followed by a character that is | command is immediately followed by a character that is neither a |
neither a digit or minus sign, the argument count for the next | digit nor minus sign, the argument count for the next command is |
command is multiplied by four. The argument count is initially | multiplied by four. The argument count is initially one, so |
one, so executing this function the first time makes the argument | executing this function the first time makes the argument count |
count four, a second time makes the argument count sixteen, and so | four, a second time makes the argument count sixteen, and so on. |
on. By default, this is not bound to a key. | By default, this is not bound to a key. |
|
|
|
|
File: rluserman.info, Node: Commands For Completion, Next: Keyboard Macros, Prev: Numeric Arguments, Up: Bindable Readline Commands |
File: rluserman.info, Node: Commands For Completion, Next: Keyboard Macros, Prev: Numeric Arguments, Up: Bindable Readline Commands |
Line 1223 File: rluserman.info, Node: Commands For Completion,
|
Line 1336 File: rluserman.info, Node: Commands For Completion,
|
1.4.6 Letting Readline Type For You |
1.4.6 Letting Readline Type For You |
----------------------------------- |
----------------------------------- |
|
|
`complete (<TAB>)' | 'complete (<TAB>)' |
Attempt to perform completion on the text before point. The | Attempt to perform completion on the text before point. The actual |
actual completion performed is application-specific. The default | completion performed is application-specific. The default is |
is filename completion. | filename completion. |
|
|
`possible-completions (M-?)' | 'possible-completions (M-?)' |
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 `completion-display-width', the value | for display to the value of 'completion-display-width', the value |
of the environment variable `COLUMNS', or the screen width, in | of the environment variable 'COLUMNS', or the screen width, in that |
that order. | order. |
|
|
`insert-completions (M-*)' | 'insert-completions (M-*)' |
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 `possible-completions'. | been generated by 'possible-completions'. |
|
|
`menu-complete ()' | 'menu-complete ()' |
Similar to `complete', but replaces the word to be completed with | Similar to 'complete', but replaces the word to be completed with a |
a single match from the list of possible completions. Repeated | single match from the list of possible completions. Repeated |
execution of `menu-complete' steps through the list of possible | execution of 'menu-complete' steps through the list of possible |
completions, inserting each match in turn. At the end of the list |
completions, inserting each match in turn. At the end of the list |
of completions, the bell is rung (subject to the setting of |
of completions, the bell is rung (subject to the setting of |
`bell-style') and the original text is restored. An argument of N | 'bell-style') and the original text is restored. An argument of N |
moves N positions forward in the list of matches; a negative |
moves N positions forward in the list of matches; a negative |
argument may be used to move backward through the list. This |
argument may be used to move backward through the list. This |
command is intended to be bound to <TAB>, but is unbound by |
command is intended to be bound to <TAB>, but is unbound by |
default. |
default. |
|
|
`menu-complete-backward ()' | 'menu-complete-backward ()' |
Identical to `menu-complete', but moves backward through the list | Identical to 'menu-complete', but moves backward through the list |
of possible completions, as if `menu-complete' had been given a | of possible completions, as if 'menu-complete' had been given a |
negative argument. |
negative argument. |
|
|
`delete-char-or-list ()' | 'delete-char-or-list ()' |
Deletes the character under the cursor if not at the beginning or |
Deletes the character under the cursor if not at the beginning or |
end of the line (like `delete-char'). If at the end of the line, | end of the line (like 'delete-char'). If at the end of the line, |
behaves identically to `possible-completions'. This command is | behaves identically to 'possible-completions'. This command is |
unbound by default. |
unbound by default. |
|
|
|
|
|
|
File: rluserman.info, Node: Keyboard Macros, Next: Miscellaneous Commands, Prev: Commands For Completion, Up: Bindable Readline Commands |
File: rluserman.info, Node: Keyboard Macros, Next: Miscellaneous Commands, Prev: Commands For Completion, Up: Bindable Readline Commands |
|
|
1.4.7 Keyboard Macros |
1.4.7 Keyboard Macros |
--------------------- |
--------------------- |
|
|
`start-kbd-macro (C-x ()' | 'start-kbd-macro (C-x ()' |
Begin saving the characters typed into the current keyboard macro. |
Begin saving the characters typed into the current keyboard macro. |
|
|
`end-kbd-macro (C-x ))' | 'end-kbd-macro (C-x ))' |
Stop saving the characters typed into the current keyboard macro |
Stop saving the characters typed into the current keyboard macro |
and save the definition. |
and save the definition. |
|
|
`call-last-kbd-macro (C-x e)' | 'call-last-kbd-macro (C-x e)' |
Re-execute the last keyboard macro defined, by making the |
Re-execute the last keyboard macro defined, by making the |
characters in the macro appear as if typed at the keyboard. |
characters in the macro appear as if typed at the keyboard. |
|
|
`print-last-kbd-macro ()' | 'print-last-kbd-macro ()' |
Print the last keboard macro defined in a format suitable for the |
Print the last keboard macro defined in a format suitable for the |
INPUTRC file. |
INPUTRC file. |
|
|
|
|
|
|
File: rluserman.info, Node: Miscellaneous Commands, Prev: Keyboard Macros, Up: Bindable Readline Commands |
File: rluserman.info, Node: Miscellaneous Commands, Prev: Keyboard Macros, Up: Bindable Readline Commands |
|
|
1.4.8 Some Miscellaneous Commands |
1.4.8 Some Miscellaneous Commands |
--------------------------------- |
--------------------------------- |
|
|
`re-read-init-file (C-x C-r)' | 're-read-init-file (C-x C-r)' |
Read in the contents of the INPUTRC file, and incorporate any |
Read in the contents of the INPUTRC file, and incorporate any |
bindings or variable assignments found there. |
bindings or variable assignments found there. |
|
|
`abort (C-g)' | 'abort (C-g)' |
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 `bell-style'). | (subject to the setting of 'bell-style'). |
|
|
`do-uppercase-version (M-a, M-b, M-X, ...)' | 'do-lowercase-version (M-A, M-B, M-X, ...)' |
If the metafied character X is lowercase, run the command that is | If the metafied character X is upper case, run the command that is |
bound to the corresponding uppercase character. | bound to the corresponding metafied lower case character. The |
| behavior is undefined if X is already lower case. |
|
|
`prefix-meta (<ESC>)' | 'prefix-meta (<ESC>)' |
Metafy the next character typed. This is for keyboards without a |
Metafy the next character typed. This is for keyboards without a |
meta key. Typing `<ESC> f' is equivalent to typing `M-f'. | meta key. Typing '<ESC> f' is equivalent to typing 'M-f'. |
|
|
`undo (C-_ or C-x C-u)' | 'undo (C-_ or C-x C-u)' |
Incremental undo, separately remembered for each line. |
Incremental undo, separately remembered for each line. |
|
|
`revert-line (M-r)' | 'revert-line (M-r)' |
Undo all changes made to this line. This is like executing the |
Undo all changes made to this line. This is like executing the |
`undo' command enough times to get back to the beginning. | 'undo' command enough times to get back to the beginning. |
|
|
`tilde-expand (M-~)' | 'tilde-expand (M-~)' |
Perform tilde expansion on the current word. |
Perform tilde expansion on the current word. |
|
|
`set-mark (C-@)' | 'set-mark (C-@)' |
Set the mark to the point. If a numeric argument is supplied, the |
Set the mark to the point. If a numeric argument is supplied, the |
mark is set to that position. |
mark is set to that position. |
|
|
`exchange-point-and-mark (C-x C-x)' | 'exchange-point-and-mark (C-x C-x)' |
Swap the point with the mark. The current cursor position is set |
Swap the point with the mark. The current cursor position is set |
to the saved position, and the old cursor position is saved as the |
to the saved position, and the old cursor position is saved as the |
mark. |
mark. |
|
|
`character-search (C-])' | 'character-search (C-])' |
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 |
that character. A negative count searches for previous |
occurrences. |
occurrences. |
|
|
`character-search-backward (M-C-])' | 'character-search-backward (M-C-])' |
A character is read and point is moved to the previous occurrence |
A character is read and point is moved to the previous occurrence |
of that character. A negative count searches for subsequent |
of that character. A negative count searches for subsequent |
occurrences. |
occurrences. |
|
|
`skip-csi-sequence ()' | 'skip-csi-sequence ()' |
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 |
sequence is bound to "\e[", keys producing such sequences will | sequence is bound to "\e[", keys producing such sequences will have |
have no effect unless explicitly bound to a readline command, | no effect unless explicitly bound to a readline command, instead of |
instead of inserting stray characters into the editing buffer. | inserting stray characters into the editing buffer. This is |
This is unbound by default, but usually bound to ESC-[. | unbound by default, but usually bound to ESC-[. |
|
|
`insert-comment (M-#)' | 'insert-comment (M-#)' |
Without a numeric argument, the value of the `comment-begin' | Without a numeric argument, the value of the 'comment-begin' |
variable is inserted at the beginning of the current line. If a |
variable is inserted at the beginning of the current line. If a |
numeric argument is supplied, this command acts as a toggle: if | numeric argument is supplied, this command acts as a toggle: if the |
the characters at the beginning of the line do not match the value | characters at the beginning of the line do not match the value of |
of `comment-begin', the value is inserted, otherwise the | 'comment-begin', the value is inserted, otherwise the characters in |
characters in `comment-begin' are deleted from the beginning of | 'comment-begin' are deleted from the beginning of the line. In |
the line. In either case, the line is accepted as if a newline | either case, the line is accepted as if a newline had been typed. |
had been typed. | |
|
|
`dump-functions ()' | 'dump-functions ()' |
Print all of the functions and their key bindings to the Readline |
Print all of the functions and their key bindings to the Readline |
output stream. If a numeric argument is supplied, the output is |
output stream. If a numeric argument is supplied, the output is |
formatted in such a way that it can be made part of an INPUTRC |
formatted in such a way that it can be made part of an INPUTRC |
file. This command is unbound by default. |
file. This command is unbound by default. |
|
|
`dump-variables ()' | 'dump-variables ()' |
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 |
INPUTRC file. This command is unbound by default. |
INPUTRC file. This command is unbound by default. |
|
|
`dump-macros ()' | 'dump-macros ()' |
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 |
output is formatted in such a way that it can be made part of an | is formatted in such a way that it can be made part of an INPUTRC |
INPUTRC file. This command is unbound by default. | file. This command is unbound by default. |
|
|
`emacs-editing-mode (C-e)' | 'emacs-editing-mode (C-e)' |
When in `vi' command mode, this causes a switch to `emacs' editing | When in 'vi' command mode, this causes a switch to 'emacs' editing |
mode. |
mode. |
|
|
`vi-editing-mode (M-C-j)' | 'vi-editing-mode (M-C-j)' |
When in `emacs' editing mode, this causes a switch to `vi' editing | When in 'emacs' editing mode, this causes a switch to 'vi' editing |
mode. |
mode. |
|
|
|
|
|
|
File: rluserman.info, Node: Readline vi Mode, Prev: Bindable Readline Commands, Up: Command Line Editing |
File: rluserman.info, Node: Readline vi Mode, Prev: Bindable Readline Commands, Up: Command Line Editing |
|
|
1.5 Readline vi Mode |
1.5 Readline vi Mode |
==================== |
==================== |
|
|
While the Readline library does not have a full set of `vi' editing | While the Readline library does not have a full set of 'vi' editing |
functions, it does contain enough to allow simple editing of the line. |
functions, it does contain enough to allow simple editing of the line. |
The Readline `vi' mode behaves as specified in the POSIX standard. | The Readline 'vi' mode behaves as specified in the POSIX standard. |
|
|
In order to switch interactively between `emacs' and `vi' editing | In order to switch interactively between 'emacs' and 'vi' editing |
modes, use the command `M-C-j' (bound to emacs-editing-mode when in | modes, use the command 'M-C-j' (bound to emacs-editing-mode when in 'vi' |
`vi' mode and to vi-editing-mode in `emacs' mode). The Readline | mode and to vi-editing-mode in 'emacs' mode). The Readline default is |
default is `emacs' mode. | 'emacs' mode. |
|
|
When you enter a line in `vi' mode, you are already placed in | When you enter a line in 'vi' mode, you are already placed in |
`insertion' mode, as if you had typed an `i'. Pressing <ESC> switches | 'insertion' mode, as if you had typed an 'i'. Pressing <ESC> switches |
you into `command' mode, where you can edit the text of the line with | you into 'command' mode, where you can edit the text of the line with |
the standard `vi' movement keys, move to previous history lines with | the standard 'vi' movement keys, move to previous history lines with 'k' |
`k' and subsequent lines with `j', and so forth. | and subsequent lines with 'j', and so forth. |
|
|
|
|
File: rluserman.info, Node: GNU Free Documentation License, Prev: Command Line Editing, Up: Top |
File: rluserman.info, Node: GNU Free Documentation License, Prev: Command Line Editing, Up: Top |
Line 1412 Appendix A GNU Free Documentation License
|
Line 1522 Appendix A GNU Free Documentation License
|
Version 1.3, 3 November 2008 |
Version 1.3, 3 November 2008 |
|
|
Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. |
Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. |
`http://fsf.org/' | <http://fsf.org/> |
|
|
Everyone is permitted to copy and distribute verbatim copies |
Everyone is permitted to copy and distribute verbatim copies |
of this license document, but changing it is not allowed. |
of this license document, but changing it is not allowed. |
Line 1437 Appendix A GNU Free Documentation License
|
Line 1547 Appendix A GNU Free Documentation License
|
free program should come with manuals providing the same freedoms |
free program should come with manuals providing the same freedoms |
that the software does. But this License is not limited to |
that the software does. But this License is not limited to |
software manuals; it can be used for any textual work, regardless |
software manuals; it can be used for any textual work, regardless |
of subject matter or whether it is published as a printed book. | of subject matter or whether it is published as a printed book. We |
We recommend this License principally for works whose purpose is | recommend this License principally for works whose purpose is |
instruction or reference. |
instruction or reference. |
|
|
1. APPLICABILITY AND DEFINITIONS |
1. APPLICABILITY AND DEFINITIONS |
|
|
This License applies to any manual or other work, in any medium, |
This License applies to any manual or other work, in any medium, |
that contains a notice placed by the copyright holder saying it | that contains a notice placed by the copyright holder saying it can |
can be distributed under the terms of this License. Such a notice | be distributed under the terms of this License. Such a notice |
grants a world-wide, royalty-free license, unlimited in duration, |
grants a world-wide, royalty-free license, unlimited in duration, |
to use that work under the conditions stated herein. The |
to use that work under the conditions stated herein. The |
"Document", below, refers to any such manual or work. Any member |
"Document", below, refers to any such manual or work. Any member |
of the public is a licensee, and is addressed as "you". You | of the public is a licensee, and is addressed as "you". You accept |
accept the license if you copy, modify or distribute the work in a | the license if you copy, modify or distribute the work in a way |
way requiring permission under copyright law. | requiring permission under copyright law. |
|
|
A "Modified Version" of the Document means any work containing the |
A "Modified Version" of the Document means any work containing the |
Document or a portion of it, either copied verbatim, or with |
Document or a portion of it, either copied verbatim, or with |
Line 1469 Appendix A GNU Free Documentation License
|
Line 1579 Appendix A GNU Free Documentation License
|
regarding them. |
regarding them. |
|
|
The "Invariant Sections" are certain Secondary Sections whose |
The "Invariant Sections" are certain Secondary Sections whose |
titles are designated, as being those of Invariant Sections, in | titles are designated, as being those of Invariant Sections, in the |
the notice that says that the Document is released under this | notice that says that the Document is released under this License. |
License. If a section does not fit the above definition of | If a section does not fit the above definition of Secondary then it |
Secondary then it is not allowed to be designated as Invariant. | is not allowed to be designated as Invariant. The Document may |
The Document may contain zero Invariant Sections. If the Document | contain zero Invariant Sections. If the Document does not identify |
does not identify any Invariant Sections then there are none. | any Invariant Sections then there are none. |
|
|
The "Cover Texts" are certain short passages of text that are |
The "Cover Texts" are certain short passages of text that are |
listed, as Front-Cover Texts or Back-Cover Texts, in the notice |
listed, as Front-Cover Texts or Back-Cover Texts, in the notice |
Line 1485 Appendix A GNU Free Documentation License
|
Line 1595 Appendix A GNU Free Documentation License
|
A "Transparent" copy of the Document means a machine-readable copy, |
A "Transparent" copy of the Document means a machine-readable copy, |
represented in a format whose specification is available to the |
represented in a format whose specification is available to the |
general public, that is suitable for revising the document |
general public, that is suitable for revising the document |
straightforwardly with generic text editors or (for images | straightforwardly with generic text editors or (for images composed |
composed of pixels) generic paint programs or (for drawings) some | of pixels) generic paint programs or (for drawings) some widely |
widely available drawing editor, and that is suitable for input to | available drawing editor, and that is suitable for input to text |
text formatters or for automatic translation to a variety of | formatters or for automatic translation to a variety of formats |
formats suitable for input to text formatters. A copy made in an | suitable for input to text formatters. A copy made in an otherwise |
otherwise Transparent file format whose markup, or absence of | Transparent file format whose markup, or absence of markup, has |
markup, has been arranged to thwart or discourage subsequent | been arranged to thwart or discourage subsequent modification by |
modification by readers is not Transparent. An image format is | readers is not Transparent. An image format is not Transparent if |
not Transparent if used for any substantial amount of text. A | used for any substantial amount of text. A copy that is not |
copy that is not "Transparent" is called "Opaque". | "Transparent" is called "Opaque". |
|
|
Examples of suitable formats for Transparent copies include plain |
Examples of suitable formats for Transparent copies include plain |
ASCII without markup, Texinfo input format, LaTeX input format, |
ASCII without markup, Texinfo input format, LaTeX input format, |
SGML or XML using a publicly available DTD, and | SGML or XML using a publicly available DTD, and standard-conforming |
standard-conforming simple HTML, PostScript or PDF designed for | simple HTML, PostScript or PDF designed for human modification. |
human modification. Examples of transparent image formats include | Examples of transparent image formats include PNG, XCF and JPG. |
PNG, XCF and JPG. Opaque formats include proprietary formats that | Opaque formats include proprietary formats that can be read and |
can be read and edited only by proprietary word processors, SGML or | edited only by proprietary word processors, SGML or XML for which |
XML for which the DTD and/or processing tools are not generally | the DTD and/or processing tools are not generally available, and |
available, and the machine-generated HTML, PostScript or PDF | the machine-generated HTML, PostScript or PDF produced by some word |
produced by some word processors for output purposes only. | processors for output purposes only. |
|
|
The "Title Page" means, for a printed book, the title page itself, |
The "Title Page" means, for a printed book, the title page itself, |
plus such following pages as are needed to hold, legibly, the |
plus such following pages as are needed to hold, legibly, the |
Line 1543 Appendix A GNU Free Documentation License
|
Line 1653 Appendix A GNU Free Documentation License
|
may not use technical measures to obstruct or control the reading |
may not use technical measures to obstruct or control the reading |
or further copying of the copies you make or distribute. However, |
or further copying of the copies you make or distribute. However, |
you may accept compensation in exchange for copies. If you |
you may accept compensation in exchange for copies. If you |
distribute a large enough number of copies you must also follow | distribute a large enough number of copies you must also follow the |
the conditions in section 3. | conditions in section 3. |
|
|
You may also lend copies, under the same conditions stated above, |
You may also lend copies, under the same conditions stated above, |
and you may publicly display copies. |
and you may publicly display copies. |
Line 1558 Appendix A GNU Free Documentation License
|
Line 1668 Appendix A GNU Free Documentation License
|
these Cover Texts: Front-Cover Texts on the front cover, and |
these Cover Texts: Front-Cover Texts on the front cover, and |
Back-Cover Texts on the back cover. Both covers must also clearly |
Back-Cover Texts on the back cover. Both covers must also clearly |
and legibly identify you as the publisher of these copies. The |
and legibly identify you as the publisher of these copies. The |
front cover must present the full title with all words of the | front cover must present the full title with all words of the title |
title equally prominent and visible. You may add other material | equally prominent and visible. You may add other material on the |
on the covers in addition. Copying with changes limited to the | covers in addition. Copying with changes limited to the covers, as |
covers, as long as they preserve the title of the Document and | long as they preserve the title of the Document and satisfy these |
satisfy these conditions, can be treated as verbatim copying in | conditions, can be treated as verbatim copying in other respects. |
other respects. | |
|
|
If the required texts for either cover are too voluminous to fit |
If the required texts for either cover are too voluminous to fit |
legibly, you should put the first ones listed (as many as fit |
legibly, you should put the first ones listed (as many as fit |
Line 1571 Appendix A GNU Free Documentation License
|
Line 1680 Appendix A GNU Free Documentation License
|
adjacent pages. |
adjacent pages. |
|
|
If you publish or distribute Opaque copies of the Document |
If you publish or distribute Opaque copies of the Document |
numbering more than 100, you must either include a | numbering more than 100, you must either include a machine-readable |
machine-readable Transparent copy along with each Opaque copy, or | Transparent copy along with each Opaque copy, or state in or with |
state in or with each Opaque copy a computer-network location from | each Opaque copy a computer-network location from which the general |
which the general network-using public has access to download | network-using public has access to download using public-standard |
using public-standard network protocols a complete Transparent | network protocols a complete Transparent copy of the Document, free |
copy of the Document, free of added material. If you use the | of added material. If you use the latter option, you must take |
latter option, you must take reasonably prudent steps, when you | reasonably prudent steps, when you begin distribution of Opaque |
begin distribution of Opaque copies in quantity, to ensure that | copies in quantity, to ensure that this Transparent copy will |
this Transparent copy will remain thus accessible at the stated | remain thus accessible at the stated location until at least one |
location until at least one year after the last time you | year after the last time you distribute an Opaque copy (directly or |
distribute an Opaque copy (directly or through your agents or | through your agents or retailers) of that edition to the public. |
retailers) of that edition to the public. | |
|
|
It is requested, but not required, that you contact the authors of |
It is requested, but not required, that you contact the authors of |
the Document well before redistributing any large number of | the Document well before redistributing any large number of copies, |
copies, to give them a chance to provide you with an updated | to give them a chance to provide you with an updated version of the |
version of the Document. | Document. |
|
|
4. MODIFICATIONS |
4. MODIFICATIONS |
|
|
You may copy and distribute a Modified Version of the Document |
You may copy and distribute a Modified Version of the Document |
under the conditions of sections 2 and 3 above, provided that you |
under the conditions of sections 2 and 3 above, provided that you |
release the Modified Version under precisely this License, with | release the Modified Version under precisely this License, with the |
the Modified Version filling the role of the Document, thus | Modified Version filling the role of the Document, thus licensing |
licensing distribution and modification of the Modified Version to | distribution and modification of the Modified Version to whoever |
whoever possesses a copy of it. In addition, you must do these | possesses a copy of it. In addition, you must do these things in |
things in the Modified Version: | the Modified Version: |
|
|
A. Use in the Title Page (and on the covers, if any) a title |
A. Use in the Title Page (and on the covers, if any) a title |
distinct from that of the Document, and from those of | distinct from that of the Document, and from those of previous |
previous versions (which should, if there were any, be listed | versions (which should, if there were any, be listed in the |
in the History section of the Document). You may use the | History section of the Document). You may use the same title |
same title as a previous version if the original publisher of | as a previous version if the original publisher of that |
that version gives permission. | version gives permission. |
|
|
B. List on the Title Page, as authors, one or more persons or |
B. List on the Title Page, as authors, one or more persons or |
entities responsible for authorship of the modifications in |
entities responsible for authorship of the modifications in |
Line 1634 Appendix A GNU Free Documentation License
|
Line 1742 Appendix A GNU Free Documentation License
|
|
|
I. Preserve the section Entitled "History", Preserve its Title, |
I. Preserve the section Entitled "History", Preserve its Title, |
and add to it an item stating at least the title, year, new |
and add to it an item stating at least the title, year, new |
authors, and publisher of the Modified Version as given on | authors, and publisher of the Modified Version as given on the |
the Title Page. If there is no section Entitled "History" in | Title Page. If there is no section Entitled "History" in the |
the Document, create one stating the title, year, authors, | Document, create one stating the title, year, authors, and |
and publisher of the Document as given on its Title Page, | publisher of the Document as given on its Title Page, then add |
then add an item describing the Modified Version as stated in | an item describing the Modified Version as stated in the |
the previous sentence. | previous sentence. |
|
|
J. Preserve the network location, if any, given in the Document |
J. Preserve the network location, if any, given in the Document |
for public access to a Transparent copy of the Document, and |
for public access to a Transparent copy of the Document, and |
likewise the network locations given in the Document for |
likewise the network locations given in the Document for |
previous versions it was based on. These may be placed in | previous versions it was based on. These may be placed in the |
the "History" section. You may omit a network location for a | "History" section. You may omit a network location for a work |
work that was published at least four years before the | that was published at least four years before the Document |
Document itself, or if the original publisher of the version | itself, or if the original publisher of the version it refers |
it refers to gives permission. | to gives permission. |
|
|
K. For any section Entitled "Acknowledgements" or "Dedications", |
K. For any section Entitled "Acknowledgements" or "Dedications", |
Preserve the Title of the section, and preserve in the | Preserve the Title of the section, and preserve in the section |
section all the substance and tone of each of the contributor | all the substance and tone of each of the contributor |
acknowledgements and/or dedications given therein. |
acknowledgements and/or dedications given therein. |
|
|
L. Preserve all the Invariant Sections of the Document, | L. Preserve all the Invariant Sections of the Document, unaltered |
unaltered in their text and in their titles. Section numbers | in their text and in their titles. Section numbers or the |
or the equivalent are not considered part of the section | equivalent are not considered part of the section titles. |
titles. | |
|
|
M. Delete any section Entitled "Endorsements". Such a section |
M. Delete any section Entitled "Endorsements". Such a section |
may not be included in the Modified Version. |
may not be included in the Modified Version. |
Line 1671 Appendix A GNU Free Documentation License
|
Line 1778 Appendix A GNU Free Documentation License
|
|
|
If the Modified Version includes new front-matter sections or |
If the Modified Version includes new front-matter sections or |
appendices that qualify as Secondary Sections and contain no |
appendices that qualify as Secondary Sections and contain no |
material copied from the Document, you may at your option | material copied from the Document, you may at your option designate |
designate some or all of these sections as invariant. To do this, | some or all of these sections as invariant. To do this, add their |
add their titles to the list of Invariant Sections in the Modified | titles to the list of Invariant Sections in the Modified Version's |
Version's license notice. These titles must be distinct from any | license notice. These titles must be distinct from any other |
other section titles. | section titles. |
|
|
You may add a section Entitled "Endorsements", provided it contains |
You may add a section Entitled "Endorsements", provided it contains |
nothing but endorsements of your Modified Version by various |
nothing but endorsements of your Modified Version by various |
Line 1684 Appendix A GNU Free Documentation License
|
Line 1791 Appendix A GNU Free Documentation License
|
definition of a standard. |
definition of a standard. |
|
|
You may add a passage of up to five words as a Front-Cover Text, |
You may add a passage of up to five words as a Front-Cover Text, |
and a passage of up to 25 words as a Back-Cover Text, to the end | and a passage of up to 25 words as a Back-Cover Text, to the end of |
of the list of Cover Texts in the Modified Version. Only one | the list of Cover Texts in the Modified Version. Only one passage |
passage of Front-Cover Text and one of Back-Cover Text may be | of Front-Cover Text and one of Back-Cover Text may be added by (or |
added by (or through arrangements made by) any one entity. If the | through arrangements made by) any one entity. If the Document |
Document already includes a cover text for the same cover, | already includes a cover text for the same cover, previously added |
previously added by you or by arrangement made by the same entity | by you or by arrangement made by the same entity you are acting on |
you are acting on behalf of, you may not add another; but you may | behalf of, you may not add another; but you may replace the old |
replace the old one, on explicit permission from the previous | one, on explicit permission from the previous publisher that added |
publisher that added the old one. | the old one. |
|
|
The author(s) and publisher(s) of the Document do not by this |
The author(s) and publisher(s) of the Document do not by this |
License give permission to use their names for publicity for or to |
License give permission to use their names for publicity for or to |
Line 1702 Appendix A GNU Free Documentation License
|
Line 1809 Appendix A GNU Free Documentation License
|
|
|
You may combine the Document with other documents released under |
You may combine the Document with other documents released under |
this License, under the terms defined in section 4 above for |
this License, under the terms defined in section 4 above for |
modified versions, provided that you include in the combination | modified versions, provided that you include in the combination all |
all of the Invariant Sections of all of the original documents, | of the Invariant Sections of all of the original documents, |
unmodified, and list them all as Invariant Sections of your |
unmodified, and list them all as Invariant Sections of your |
combined work in its license notice, and that you preserve all |
combined work in its license notice, and that you preserve all |
their Warranty Disclaimers. |
their Warranty Disclaimers. |
Line 1730 Appendix A GNU Free Documentation License
|
Line 1837 Appendix A GNU Free Documentation License
|
documents released under this License, and replace the individual |
documents released under this License, and replace the individual |
copies of this License in the various documents with a single copy |
copies of this License in the various documents with a single copy |
that is included in the collection, provided that you follow the |
that is included in the collection, provided that you follow the |
rules of this License for verbatim copying of each of the | rules of this License for verbatim copying of each of the documents |
documents in all other respects. | in all other respects. |
|
|
You may extract a single document from such a collection, and |
You may extract a single document from such a collection, and |
distribute it individually under this License, provided you insert |
distribute it individually under this License, provided you insert |
a copy of this License into the extracted document, and follow | a copy of this License into the extracted document, and follow this |
this License in all other respects regarding verbatim copying of | License in all other respects regarding verbatim copying of that |
that document. | document. |
|
|
7. AGGREGATION WITH INDEPENDENT WORKS |
7. AGGREGATION WITH INDEPENDENT WORKS |
|
|
A compilation of the Document or its derivatives with other |
A compilation of the Document or its derivatives with other |
separate and independent documents or works, in or on a volume of | separate and independent documents or works, in or on a volume of a |
a storage or distribution medium, is called an "aggregate" if the | storage or distribution medium, is called an "aggregate" if the |
copyright resulting from the compilation is not used to limit the |
copyright resulting from the compilation is not used to limit the |
legal rights of the compilation's users beyond what the individual |
legal rights of the compilation's users beyond what the individual |
works permit. When the Document is included in an aggregate, this |
works permit. When the Document is included in an aggregate, this |
Line 1788 Appendix A GNU Free Documentation License
|
Line 1895 Appendix A GNU Free Documentation License
|
|
|
However, if you cease all violation of this License, then your |
However, if you cease all violation of this License, then your |
license from a particular copyright holder is reinstated (a) |
license from a particular copyright holder is reinstated (a) |
provisionally, unless and until the copyright holder explicitly | provisionally, unless and until the copyright holder explicitly and |
and finally terminates your license, and (b) permanently, if the | finally terminates your license, and (b) permanently, if the |
copyright holder fails to notify you of the violation by some |
copyright holder fails to notify you of the violation by some |
reasonable means prior to 60 days after the cessation. |
reasonable means prior to 60 days after the cessation. |
|
|
Line 1801 Appendix A GNU Free Documentation License
|
Line 1908 Appendix A GNU Free Documentation License
|
after your receipt of the notice. |
after your receipt of the notice. |
|
|
Termination of your rights under this section does not terminate |
Termination of your rights under this section does not terminate |
the licenses of parties who have received copies or rights from | the licenses of parties who have received copies or rights from you |
you under this License. If your rights have been terminated and | under this License. If your rights have been terminated and not |
not permanently reinstated, receipt of a copy of some or all of | permanently reinstated, receipt of a copy of some or all of the |
the same material does not give you any rights to use it. | same material does not give you any rights to use it. |
|
|
10. FUTURE REVISIONS OF THIS LICENSE | 10. FUTURE REVISIONS OF THIS LICENSE |
|
|
The Free Software Foundation may publish new, revised versions of |
The Free Software Foundation may publish new, revised versions of |
the GNU Free Documentation License from time to time. Such new |
the GNU Free Documentation License from time to time. Such new |
versions will be similar in spirit to the present version, but may |
versions will be similar in spirit to the present version, but may |
differ in detail to address new problems or concerns. See |
differ in detail to address new problems or concerns. See |
`http://www.gnu.org/copyleft/'. | <http://www.gnu.org/copyleft/>. |
|
|
Each version of the License is given a distinguishing version |
Each version of the License is given a distinguishing version |
number. If the Document specifies that a particular numbered |
number. If the Document specifies that a particular numbered |
version of this License "or any later version" applies to it, you |
version of this License "or any later version" applies to it, you |
have the option of following the terms and conditions either of |
have the option of following the terms and conditions either of |
that specified version or of any later version that has been |
that specified version or of any later version that has been |
published (not as a draft) by the Free Software Foundation. If | published (not as a draft) by the Free Software Foundation. If the |
the Document does not specify a version number of this License, | Document does not specify a version number of this License, you may |
you may choose any version ever published (not as a draft) by the | choose any version ever published (not as a draft) by the Free |
Free Software Foundation. If the Document specifies that a proxy | Software Foundation. If the Document specifies that a proxy can |
can decide which future versions of this License can be used, that | decide which future versions of this License can be used, that |
proxy's public statement of acceptance of a version permanently |
proxy's public statement of acceptance of a version permanently |
authorizes you to choose that version for the Document. |
authorizes you to choose that version for the Document. |
|
|
11. RELICENSING | 11. RELICENSING |
|
|
"Massive Multiauthor Collaboration Site" (or "MMC Site") means any |
"Massive Multiauthor Collaboration Site" (or "MMC Site") means any |
World Wide Web server that publishes copyrightable works and also |
World Wide Web server that publishes copyrightable works and also |
Line 1857 Appendix A GNU Free Documentation License
|
Line 1964 Appendix A GNU Free Documentation License
|
site under CC-BY-SA on the same site at any time before August 1, |
site under CC-BY-SA on the same site at any time before August 1, |
2009, provided the MMC is eligible for relicensing. |
2009, provided the MMC is eligible for relicensing. |
|
|
|
|
ADDENDUM: How to use this License for your documents |
ADDENDUM: How to use this License for your documents |
==================================================== |
==================================================== |
|
|
Line 1874 notices just after the title page:
|
Line 1980 notices just after the title page:
|
Free Documentation License''. |
Free Documentation License''. |
|
|
If you have Invariant Sections, Front-Cover Texts and Back-Cover |
If you have Invariant Sections, Front-Cover Texts and Back-Cover |
Texts, replace the "with...Texts." line with this: | Texts, replace the "with...Texts." line with this: |
|
|
with the Invariant Sections being LIST THEIR TITLES, with |
with the Invariant Sections being LIST THEIR TITLES, with |
the Front-Cover Texts being LIST, and with the Back-Cover Texts |
the Front-Cover Texts being LIST, and with the Back-Cover Texts |
Line 1885 combination of the three, merge those two alternatives
|
Line 1991 combination of the three, merge those two alternatives
|
situation. |
situation. |
|
|
If your document contains nontrivial examples of program code, we |
If your document contains nontrivial examples of program code, we |
recommend releasing these examples in parallel under your choice of | recommend releasing these examples in parallel under your choice of free |
free software license, such as the GNU General Public License, to | software license, such as the GNU General Public License, to permit |
permit their use in free software. | their use in free software. |
|
|
|
|
|
|
Tag Table: |
Tag Table: |
Node: Top950 | Node: Top907 |
Node: Command Line Editing1472 | Node: Command Line Editing1429 |
Node: Introduction and Notation2126 | Node: Introduction and Notation2083 |
Node: Readline Interaction3750 | Node: Readline Interaction3708 |
Node: Readline Bare Essentials4943 | Node: Readline Bare Essentials4901 |
Node: Readline Movement Commands6734 | Node: Readline Movement Commands6686 |
Node: Readline Killing Commands7701 | Node: Readline Killing Commands7648 |
Node: Readline Arguments9623 | Node: Readline Arguments9568 |
Node: Searching10669 | Node: Searching10614 |
Node: Readline Init File12822 | Node: Readline Init File12768 |
Node: Readline Init File Syntax13977 | Node: Readline Init File Syntax13923 |
Node: Conditional Init Constructs30683 | Node: Conditional Init Constructs34182 |
Node: Sample Init File33218 | Node: Sample Init File38380 |
Node: Bindable Readline Commands36338 | Node: Bindable Readline Commands41506 |
Node: Commands For Moving37397 | Node: Commands For Moving42562 |
Node: Commands For History38260 | Node: Commands For History44322 |
Node: Commands For Text42416 | Node: Commands For Text49086 |
Node: Commands For Killing45400 | Node: Commands For Killing52790 |
Node: Numeric Arguments47544 | Node: Numeric Arguments55505 |
Node: Commands For Completion48685 | Node: Commands For Completion56646 |
Node: Keyboard Macros50656 | Node: Keyboard Macros58616 |
Node: Miscellaneous Commands51346 | Node: Miscellaneous Commands59305 |
Node: Readline vi Mode55204 | Node: Readline vi Mode63228 |
Node: GNU Free Documentation License56118 | Node: GNU Free Documentation License64142 |
|
|
End Tag Table |
End Tag Table |
|
|
|
|
|
Local Variables: |
|
coding: utf-8 |
|
End: |