diff options
Diffstat (limited to 'gnu/lib/libreadline/doc/rluser.texinfo')
| -rw-r--r-- | gnu/lib/libreadline/doc/rluser.texinfo | 523 |
1 files changed, 415 insertions, 108 deletions
diff --git a/gnu/lib/libreadline/doc/rluser.texinfo b/gnu/lib/libreadline/doc/rluser.texinfo index 553c88e..36a65b8 100644 --- a/gnu/lib/libreadline/doc/rluser.texinfo +++ b/gnu/lib/libreadline/doc/rluser.texinfo @@ -5,14 +5,14 @@ @ignore This file documents the end user interface to the GNU command line -editing feautres. It is to be an appendix to manuals for programs which +editing features. It is to be an appendix to manuals for programs which use these features. There is a document entitled "readline.texinfo" which contains both end-user and programmer documentation for the GNU Readline Library. Copyright (C) 1988 Free Software Foundation, Inc. -Authored by Brian Fox. +Authored by Brian Fox and Chet Ramey. Permission is granted to process this file through Tex and print the results, provided the printed document carries copying permission notice @@ -39,18 +39,23 @@ into another language, under the above conditions for modified versions. @node Command Line Editing @chapter Command Line Editing -This text describes GNU's command line editing interface. +This chapter describes the basic features of the GNU +command line editing interface. @menu * Introduction and Notation:: Notation used in this text. * Readline Interaction:: The minimum set of commands for editing a line. * Readline Init File:: Customizing Readline from a user's view. +* Bindable Readline Commands:: A description of most of the Readline commands + available for binding +* Readline vi Mode:: A short description of how to make Readline + behave line the vi editor. @end menu @node Introduction and Notation @section Introduction to Line Editing -The following paragraphs describe the notation we use to represent +The following paragraphs describe the notation used to represent keystrokes. The text @key{C-k} is read as `Control-K' and describes the character @@ -97,19 +102,19 @@ regardless of the location of the cursor within the line. In order to enter characters into the line, simply type them. The typed character appears where the cursor was, and then the cursor moves one -space to the right. If you mistype a character, you can use @key{DEL} to -back up, and delete the mistyped character. +space to the right. If you mistype a character, you can use your +erase character to back up and delete the mistyped character. Sometimes you may miss typing a character that you wanted to type, and not notice your error until you have typed several other characters. In that case, you can type @key{C-b} to move the cursor to the left, and then -correct your mistake. Aftwerwards, you can move the cursor to the right +correct your mistake. Afterwards, you can move the cursor to the right with @key{C-f}. When you add text in the middle of a line, you will notice that characters -to the right of the cursor get `pushed over' to make room for the text +to the right of the cursor are `pushed over' to make room for the text that you have inserted. Likewise, when you delete text behind the cursor, -characters to the right of the cursor get `pulled back' to fill in the +characters to the right of the cursor are `pulled back' to fill in the blank space created by the removal of the text. A list of the basic bare essentials for editing the text of an input line follows. @@ -123,7 +128,7 @@ Delete the character to the left of the cursor. @item @key{C-d} Delete the character underneath the cursor. @item @w{Printing characters} -Insert itself into the line at the cursor. +Insert the character into the line at the cursor. @item @key{C-_} Undo the last thing that you did. You can undo all the way back to an empty line. @@ -160,11 +165,19 @@ operate on characters while meta keystrokes operate on words. @subsection Readline Killing Commands @dfn{Killing} text means to delete the text from the line, but to save -it away for later use, usually by @dfn{yanking} it back into the line. +it away for later use, usually by @dfn{yanking} (re-inserting) +it back into the line. 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) place later. +When you use a kill command, the text is saved in a @dfn{kill-ring}. +Any 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 specific; the text that you killed on a previously +typed line is available to be yanked back later, when you are typing +another line. + Here is the list of commands for killing text. @table @key @@ -186,7 +199,7 @@ Kill from the cursor to the previous whitespace. This is different than @end table And, here is how to @dfn{yank} the text back into the line. Yanking -is +means to copy the most-recently-killed text from the kill buffer. @table @key @item C-y @@ -197,13 +210,6 @@ Rotate the kill-ring, and yank the new top. You can only do this if the prior command is @key{C-y} or @key{M-y}. @end table -When you use a kill command, the text is saved in a @dfn{kill-ring}. -Any number of consecutive kills save all of the killed text together, so -that when you yank it back, you get it in one clean sweep. The kill -ring is not line specific; the text that you killed on a previously -typed line is available to be yanked back later, when you are typing -another line. - @node Readline Arguments @subsection Readline Arguments @@ -226,81 +232,155 @@ the @key{C-d} command an argument of 10, you could type @key{M-1 0 C-d}. @section Readline Init File Although the Readline library comes with a set of Emacs-like -keybindings, it is possible that you would like to use a different set +keybindings installed by default, +it is possible that you would like to use a different set of keybindings. You can customize programs that use Readline by putting commands in an @dfn{init} file in your home directory. The name of this -file is @file{~/.inputrc}. +file is taken from the value of the shell variable @code{INPUTRC}. If +that variable is unset, the default is @file{~/.inputrc}. When a program which uses the Readline library starts up, the -@file{~/.inputrc} file is read, and the keybindings are set. +init file is read, and the key bindings are set. In addition, the @code{C-x C-r} command re-reads this init file, thus incorporating any changes that you might have made to it. @menu -* Readline Init Syntax:: Syntax for the commands in @file{~/.inputrc}. -* Readline Vi Mode:: Switching to @code{vi} mode in Readline. +* Readline Init Syntax:: Syntax for the commands in the inputrc file. +* Conditional Init Constructs:: Conditional key bindings in the inputrc file. @end menu @node Readline Init Syntax @subsection Readline Init Syntax -There are only four constructs allowed in the @file{~/.inputrc} -file: +There are only a few basic constructs allowed in the +Readline init file. Blank lines are ignored. +Lines beginning with a @key{#} are comments. +Lines beginning with a @key{$} indicate conditional +constructs (@pxref{Conditional Init Constructs}). Other lines +denote variable settings and key bindings. @table @asis @item Variable Settings -You can change the state of a few variables in Readline. You do this by +You can change the state of a few variables in Readline by using the @code{set} command within the init file. Here is how you -would specify that you wish to use Vi line editing commands: +would specify that you wish to use @code{vi} line editing commands: @example set editing-mode vi @end example -Right now, there are only a few variables which can be set; so few in -fact, that we just iterate them here: +Right now, there are only a few variables which can be set; +so few, in fact, that we just list them here: @table @code @item editing-mode @vindex editing-mode The @code{editing-mode} variable controls which editing mode you are -using. By default, GNU Readline starts up in Emacs editing mode, where -the keystrokes are most similar to Emacs. This variable can either be -set to @code{emacs} or @code{vi}. +using. By default, Readline starts up in Emacs editing mode, where +the keystrokes are most similar to Emacs. This variable can be +set to either @code{emacs} or @code{vi}. @item horizontal-scroll-mode @vindex horizontal-scroll-mode -This variable can either be set to @code{On} or @code{Off}. Setting it +This variable can be set to either @code{On} or @code{Off}. Setting it to @code{On} means that the text of the lines that you edit will scroll -horizontally on a single screen line when they are larger than the width +horizontally on a single screen line when they are longer than the width of the screen, instead of wrapping onto a new screen line. By default, this variable is set to @code{Off}. @item mark-modified-lines @vindex mark-modified-lines -This variable when set to @code{On}, says to display an asterisk -(@samp{*}) at the starts of history lines which have been modified. -This variable is off by default. - -@item prefer-visible-bell -@vindex prefer-visible-bell -If this variable is set to @code{On} it means to use a visible bell if -one is available, rather than simply ringing the terminal bell. By -default, the value is @code{Off}. +This variable, when set to @code{On}, says to display an asterisk +(@samp{*}) at the start of history lines which have been modified. +This variable is @code{off} by default. + +@item bell-style +@vindex bell-style +Controls what happens when Readline wants to ring the terminal bell. +If set to @code{none}, Readline never rings the bell. If set to +@code{visible}, Readline uses a visible bell if one is available. +If set to @code{audible} (the default), Readline attempts to ring +the terminal's bell. + +@item comment-begin +@vindex comment-begin +The string to insert at the beginning of the line when the +@code{vi-comment} command is executed. The default value +is @code{"#"}. + +@item meta-flag +@vindex meta-flag +If set to @code{on}, Readline will enable eight-bit input (it +will not strip the eighth bit from the characters it reads), +regardless of what the terminal claims it can support. The +default value is @code{off}. + +@item convert-meta +@vindex convert-meta +If set to @code{on}, Readline will convert characters with the +eigth bit set to an ASCII key sequence by stripping the eigth +bit and prepending an @key{ESC} character, converting them to a +meta-prefixed key sequence. The default value is @code{on}. + +@item output-meta +@vindex output-meta +If set to @code{on}, Readline will display characters with the +eighth bit set directly rather than as a meta-prefixed escape +sequence. The default is @code{off}. + +@item completion-query-items +@vindex completion-query-items +The number of possible completions that determines when the user is +asked whether he wants to see the list of possibilities. If the +number of possible completions is greater than this value, +Readline will ask the user whether or not he wishes to view +them; otherwise, they are simply listed. The default limit is +@code{100}. + +@item keymap +@vindex keymap +Sets Readline's idea of the current keymap for key binding commands. +Acceptable @code{keymap} names are +@code{emacs}, +@code{emacs-standard}, +@code{emacs-meta}, +@code{emacs-ctlx}, +@code{vi}, +@code{vi-move}, +@code{vi-command}, and +@code{vi-insert}. +@code{vi} is equivalent to @code{vi-command}; @code{emacs} is +equivalent to @code{emacs-standard}. The default value is @code{emacs}. +The value of the @code{editing-mode} variable also affects the +default keymap. + +@item show-all-if-ambiguous +@vindex show-all-if-ambiguous +This alters the default behavior of the completion functions. If +set to @code{on}, +words which have more than one possible completion cause the +matches to be listed immediately instead of ringing the bell. +The default value is @code{off}. + +@item expand-tilde +@vindex expand-tilde +If set to @code{on}, tilde expansion is performed when Readline +attempts word completion. The default is @code{off}. + @end table @item Key Bindings -The syntax for controlling keybindings in the @file{~/.inputrc} file is -simple. First you have to know the @i{name} of the command that you +The syntax for controlling key bindings in the init file is +simple. First you have to know the name of the command that you want to change. The following pages contain tables of the command name, the default keybinding, and a short description of what the command does. Once you know the name of the command, simply place the name of the key you wish to bind the command to, a colon, and then the name of the -command on a line in the @file{~/.inputrc} file. The name of the key +command on a line in the init file. The name of the key can be expressed in different ways, depending on which is most comfortable for you. @@ -319,10 +399,11 @@ expressed on the right hand side (that is, to insert the text @samp{>&output} into the line). @item @w{"@var{keyseq}": @var{function-name} or @var{macro}} -@var{keyseq} differs from @var{keyname} above in that strings denoting -an entire key sequence can be specified. Simply place the key sequence -in double quotes. GNU Emacs style key escapes can be used, as in the -following example: +@var{keyseq} differs from @var{keyname} above in that strings +denoting an entire key sequence can be specified, by placing +the key sequence in double quotes. Some GNU Emacs style key +escapes can be used, as in the following example, but the +special character names are not recognized. @example "\C-u": universal-argument @@ -334,9 +415,97 @@ In the above example, @samp{C-u} is bound to the function @code{universal-argument} (just as it was in the first example), @samp{C-x C-r} is bound to the function @code{re-read-init-file}, and @samp{ESC [ 1 1 ~} is bound to insert the text @samp{Function Key 1}. +The following escape sequences are available when specifying key +sequences: +@table @code +@item @kbd{\C-} +control prefix +@item @kbd{\M-} +meta prefix +@item @kbd{\e} +an escape character +@item @kbd{\\} +backslash +@item @kbd{\"} +@key{"} +@item @kbd{\'} +@key{'} @end table + +When entering the text of a macro, single or double quotes should +be used to indicate a macro definition. Unquoted text +is assumed to be a function name. Backslash +will quote any character in the macro text, including @key{"} +and @key{'}. +For example, the following binding will make @kbd{C-x \} +insert a single @key{\} into the line: +@example +"\C-x\\": "\\" +@end example + @end table +@end table + +@node Conditional Init Constructs +@subsection Conditional Init Constructs + +Readline implements a facility similar in spirit to the conditional +compilation features of the C preprocessor which allows key +bindings and variable settings to be performed as the result +of tests. There are three parser directives used. + +@ftable @code +@item $if +The @code{$if} construct allows bindings to be made based on the +editing mode, the terminal being used, or the application using +Readline. The text of the test extends to the end of the line; +no characters are required to isolate it. + +@table @code +@item mode +The @code{mode=} form of the @code{$if} directive is used to test +whether Readline is in @code{emacs} or @code{vi} mode. +This may be used in conjunction +with the @samp{set keymap} command, for instance, to set bindings in +the @code{emacs-standard} and @code{emacs-ctlx} keymaps only if +Readline is starting out in @code{emacs} mode. + +@item term +The @code{term=} form may be used to include terminal-specific +key bindings, perhaps to bind the key sequences output by the +terminal's function keys. The word on the right side of the +@samp{=} is tested against the full name of the terminal and the +portion of the terminal name before the first @samp{-}. This +allows @var{sun} to match both @var{sun} and @var{sun-cmd}, +for instance. + +@item application +The @var{application} construct is used to include +application-specific settings. Each program using the Readline +library sets the @var{application name}, and you can test for it. +This could be used to bind key sequences to functions useful for +a specific program. For instance, the following command adds a +key sequence that quotes the current or previous word in Bash: +@example +$if bash +# Quote the current or previous word +"\C-xq": "\eb\"\ef\"" +$endif +@end example +@end table + +@item $endif +This command, as you saw in the previous example, terminates an +@code{$if} command. + +@item $else +Commands in this branch of the @code{$if} directive are executed if +the test fails. +@end ftable + +@node Bindable Readline Commands +@section Bindable Readline Commands @menu * Commands For Moving:: Moving about the line. @@ -345,11 +514,12 @@ In the above example, @samp{C-u} is bound to the function * Commands For Killing:: Commands for killing and yanking. * Numeric Arguments:: Specifying numeric arguments, repeat counts. * Commands For Completion:: Getting Readline to do the typing for you. -* Miscellaneous Commands:: Other miscillaneous commands. +* Keyboard Macros:: Saving and re-executing typed characters +* Miscellaneous Commands:: Other miscellaneous commands. @end menu @node Commands For Moving -@subsubsection Commands For Moving +@subsection Commands For Moving @ftable @code @item beginning-of-line (C-a) Move to the start of the current line. @@ -364,24 +534,38 @@ Move forward a character. Move back a character. @item forward-word (M-f) -Move forward to the end of the next word. +Move forward to the end of the next word. Words are composed of +letters and digits. @item backward-word (M-b) -Move back to the start of this, or the previous, word. +Move back to the start of this, or the previous, word. Words are +composed of letters and digits. @item clear-screen (C-l) -Clear the screen leaving the current line at the top of the screen. +Clear the screen and redraw the current line, +leaving the current line at the top of the screen. + +@item redraw-current-line () +Refresh the current line. By default, this is unbound. @end ftable @node Commands For History -@subsubsection Commands For Manipulating The History +@subsection Commands For Manipulating The History @ftable @code @item accept-line (Newline, Return) +@ifset BashFeatures +Accept the line regardless of where the cursor is. If this line is +non-empty, add it to the history list according to the setting of +the @code{HISTCONTROL} variable. If this line was a history +line, then restore the history line to its original state. +@end ifset +@ifclear BashFeatures Accept the line regardless of where the cursor is. If this line is non-empty, add it to the history list. If this line was a history line, then restore the history line to its original state. +@end ifclear @item previous-history (C-p) Move `up' through the history list. @@ -393,7 +577,7 @@ Move `down' through the history list. Move to the first line in the history. @item end-of-history (M->) -Move to the end of the input history, i.e., the line you are entering! +Move to the end of the input history, i.e., the line you are entering. @item reverse-search-history (C-r) Search backward starting at the current line and moving `up' through @@ -401,17 +585,44 @@ the history as necessary. This is an incremental search. @item forward-search-history (C-s) Search forward starting at the current line and moving `down' through -the the history as neccessary. +the the history as necessary. This is an incremental search. + +@item non-incremental-reverse-search-history (M-p) +Search backward starting at the current line and moving `up' +through the history as necessary using a non-incremental search +for a string supplied by the user. + +@item non-incremental-forward-search-history (M-n) +Search forward starting at the current line and moving `down' +through the the history as necessary using a non-incremental search +for a string supplied by the user. + +@item history-search-forward () +Search forward through the history for the string of characters +between the start of the current line and the current point. This +is a non-incremental search. By default, this command is unbound. + +@item history-search-backward () +Search backward through the history for the string of characters +between the start of the current line and the current point. This +is a non-incremental search. By default, this command is unbound. + +@item yank-nth-arg (M-C-y) +Insert the first argument to the previous command (usually +the second word on the previous line). With an argument @var{n}, +insert the @var{n}th word from the previous command (the words +in the previous command begin with word 0). A negative argument +inserts the @var{n}th word from the end of the previous command. @end ftable @node Commands For Text -@subsubsection Commands For Changing Text +@subsection Commands For Changing Text @ftable @code @item delete-char (C-d) Delete the character under the cursor. If the cursor is at the -beginning of the line, and there are no characters in the line, and +beginning of the line, there are no characters in the line, and the last character typed was not C-d, then return EOF. @item backward-delete-char (Rubout) @@ -420,7 +631,7 @@ the characters instead of deleting them. @item quoted-insert (C-q, C-v) Add the next character that you type to the line verbatim. This is -how to insert things like C-q for example. +how to insert key sequences like @key{C-q}, for example. @item tab-insert (M-TAB) Insert a tab character. @@ -429,9 +640,12 @@ Insert a tab character. Insert yourself. @item transpose-chars (C-t) -Drag the character before point forward over the character at point. -Point moves forward as well. If point is at the end of the line, then -transpose the two characters before point. Negative args don't work. +Drag the character before the cursor forward over +the character at 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 characters of the line. +Negative argumentss don't work. @item transpose-words (M-t) Drag the word behind the cursor past the word in front of the cursor @@ -439,47 +653,56 @@ moving the cursor over that word as well. @item upcase-word (M-u) Uppercase the current (or following) word. With a negative argument, -do the previous word, but do not move point. +do the previous word, but do not move the cursor. @item downcase-word (M-l) Lowercase the current (or following) word. With a negative argument, -do the previous word, but do not move point. +do the previous word, but do not move the cursor. @item capitalize-word (M-c) -Uppercase the current (or following) word. With a negative argument, -do the previous word, but do not move point. +Capitalize the current (or following) word. With a negative argument, +do the previous word, but do not move the cursor. @end ftable @node Commands For Killing -@subsubsection Killing And Yanking +@subsection Killing And Yanking @ftable @code @item kill-line (C-k) Kill the text from the current cursor position to the end of the line. -@item backward-kill-line () -Kill backward to the beginning of the line. This is normally unbound. +@item backward-kill-line (C-x Rubout) +Kill backward to the beginning of the line. + +@item unix-line-discard (C-u) +Kill backward from the cursor to the beginning of the current line. +Save the killed text on the kill-ring. + +@item kill-whole-line () +Kill all characters on the current line, no matter where the +cursor is. By default, this is unbound. @item kill-word (M-d) Kill from the cursor to the end of the current word, or if between -words, to the end of the next word. +words, to the end of the next word. Word boundaries are the same +as @code{forward-word}. @item backward-kill-word (M-DEL) -Kill the word behind the cursor. - -@item unix-line-discard (C-u) -Do what C-u used to do in Unix line input. We save the killed text on -the kill-ring, though. +Kill the word behind the cursor. Word boundaries are the same +as @code{backward-word}. @item unix-word-rubout (C-w) -Do what C-w used to do in Unix line input. The killed text is saved -on the kill-ring. This is different than backward-kill-word because -the word boundaries differ. +Kill the word behind the cursor, using white space as a word +boundary. The killed text is saved on the kill-ring. + +@item delete-horizontal-space () +Delete all spaces and tabs around point. By default, this is unbound. @item 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 the current +cursor position. @item yank-pop (M-y) Rotate the kill-ring, and yank the new top. You can only do this if @@ -487,7 +710,7 @@ the prior command is yank or yank-pop. @end ftable @node Numeric Arguments -@subsubsection Specifying Numeric Arguments +@subsection Specifying Numeric Arguments @ftable @code @item digit-argument (M-0, M-1, ... M--) @@ -495,64 +718,148 @@ Add this digit to the argument already accumulating, or start a new argument. M-- starts a negative argument. @item universal-argument () -Do what C-u does in emacs. By default, this is not bound. +Each time this is executed, the argument count is multiplied by four. +The argument count is initially one, so executing this function the +first time makes the argument count four. By default, this is not +bound to a key. @end ftable - @node Commands For Completion -@subsubsection Letting Readline Type For You +@subsection Letting Readline Type For You @ftable @code @item complete (TAB) -Attempt to do completion on the text before point. This is +Attempt to do completion on the text before the cursor. This is implementation defined. Generally, if you are typing a filename argument, you can do filename completion; if you are typing a command, you can do command completion, if you are typing in a symbol to GDB, you can do symbol name completion, if you are typing in a variable to Bash, -you can do variable name completion... +you can do variable name completion, and so on. +@ifset BashFeatures +See the Bash manual page for a complete list of available completion +functions. +@end ifset @item possible-completions (M-?) -List the possible completions of the text before point. +List the possible completions of the text before the cursor. + +@item insert-completions () +Insert all completions of the text before point that would have +been generated by @code{possible-completions}. By default, this +is not bound to a key. + +@end ftable + +@node Keyboard Macros +@subsection Keyboard Macros +@ftable @code + +@item start-kbd-macro (C-x () +Begin saving the characters typed into the current keyboard macro. + +@item end-kbd-macro (C-x )) +Stop saving the characters typed into the current keyboard macro +and save the definition. + +@item call-last-kbd-macro (C-x e) +Re-execute the last keyboard macro defined, by making the characters +in the macro appear as if typed at the keyboard. + @end ftable @node Miscellaneous Commands -@subsubsection Some Miscellaneous Commands +@subsection Some Miscellaneous Commands @ftable @code @item re-read-init-file (C-x C-r) -Read in the contents of your @file{~/.inputrc} file, and incorporate -any bindings found there. +Read in the contents of your init file, and incorporate +any bindings or variable assignments found there. @item abort (C-g) -Ding! Stops things. +Abort the current editing command and +ring the terminal's bell (subject to the setting of +@code{bell-style}). @item do-uppercase-version (M-a, M-b, ...) -Run the command that is bound to your uppercase brother. +Run the command that is bound to the corresoponding uppercase +character. @item prefix-meta (ESC) Make the next character that you type be metafied. This is for people without a meta key. Typing @samp{ESC f} is equivalent to typing @samp{M-f}. -@item undo (C-_) +@item undo (C-_, C-x C-u) Incremental undo, separately remembered for each line. @item revert-line (M-r) -Undo all changes made to this line. This is like typing the `undo' +Undo all changes made to this line. This is like typing the @code{undo} command enough times to get back to the beginning. -@end ftable -@node Readline Vi Mode -@subsection Readline Vi Mode +@item tilde-expand (M-~) +Perform tilde expansion on the current word. + +@item dump-functions () +Print all of the functions and their key bindings to the +readline output stream. If a numeric argument is supplied, +the output is formatted in such a way that it can be made part +of an @var{inputrc} file. -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. +@ifset BashFeatures +@item display-shell-version (C-x C-v) +Display version information about the current instance of Bash. -In order to switch interactively between Emacs and Vi editing modes, use -the command M-C-j (toggle-editing-mode). +@item shell-expand-line (M-C-e) +Expand the line the way the shell does when it reads it. This +performs alias and history expansion as well as all of the shell +word expansions. + +@item history-expand-line (M-^) +Perform history expansion on the current line. + +@item insert-last-argument (M-., M-_) +Insert the last argument to the previous command (the last word on +the previous line). With an argument @var{n}, +insert the @var{n}th word from the previous command (the words +in the previous command begin with word 0). A negative argument +inserts the @var{n}th word from the end of the previous command. + +@item operate-and-get-next (C-o) +Accept the current line for execution and fetch the next line +relative to the current line from the history for editing. Any +argument is ignored. + +@item emacs-editing-mode (C-e) +When in @code{vi} editing mode, this causes a switch back to +emacs editing mode, as if the command @code{set -o emacs} had +been executed. + +@end ifset + +@end ftable -When you enter a line in Vi mode, you are already placed in `insertion' -mode, as if you had typed an `i'. Pressing @key{ESC} switches you into -`edit' mode, where you can edit the text of the line with the standard -Vi movement keys, move to previous history lines with `k', and following -lines with `j', and so forth. +@node Readline vi Mode +@section Readline vi Mode + +While the Readline library does not have a full set of @code{vi} +editing functions, it does contain enough to allow simple editing +of the line. The Readline @code{vi} mode behaves as specified in +the Posix 1003.2 standard. + +@ifset BashFeatures +In order to switch interactively between @code{Emacs} and @code{Vi} +editing modes, use the @code{set -o emacs} and @code{set -o vi} +commands (@pxref{The Set Builtin}). +@end ifset +@ifclear BashFeatures +In order to switch interactively between @code{Emacs} and @code{Vi} +editing modes, use the command M-C-j (toggle-editing-mode). +@end ifclear +The Readline default is @code{emacs} mode. + +When you enter a line in @code{vi} mode, you are already placed in +`insertion' mode, as if you had typed an @samp{i}. Pressing @key{ESC} +switches you into `command' mode, where you can edit the text of the +line with the standard @code{vi} movement keys, move to previous +history lines with @samp{k}, and following lines with @samp{j}, and +so forth. |
