2 .\" MAN PAGE COMMENTS to
5 .\" Information Network Services
6 .\" Case Western Reserve University
9 .\" Last Change: Tue Jan 22 09:18:25 EST 2002
11 .TH READLINE 3 "2002 January 22" "GNU Readline 4.3"
13 .\" File Name macro. This used to be `.PN', for Path Name,
14 .\" but Sun doesn't seem to like that very much.
20 readline \- get a line from a user with editing
26 #include <readline/readline.h>
27 #include <readline/history.h>
34 \fBreadline\fP (\fIconst char *prompt\fP);
37 .if n Readline is Copyright (C) 1989\-2002 by the Free Software Foundation, Inc.
38 .if t Readline is Copyright \(co 1989\-2002 by the Free Software Foundation, Inc.
42 will read a line from the terminal
47 is \fBNULL\fP or the empty string, no prompt is issued.
48 The line returned is allocated with
50 the caller must free it when finished. The line returned
51 has the final newline removed, so only the text of the line
55 offers editing capabilities while the user is entering the
57 By default, the line editing commands
58 are similar to those of emacs.
59 A vi\-style line editing interface is also available.
61 This manual page describes only the most basic use of \fBreadline\fP.
62 Much more functionality is available; see
63 \fIThe GNU Readline Library\fP and \fIThe GNU History Library\fP
64 for additional information.
68 returns the text of the line read. A blank line
69 returns the empty string. If
71 is encountered while reading a line, and the line is empty,
75 is read with a non\-empty line, it is
79 An emacs-style notation is used to denote
80 keystrokes. Control keys are denoted by C\-\fIkey\fR, e.g., C\-n
81 means Control\-N. Similarly,
83 keys are denoted by M\-\fIkey\fR, so M\-x means Meta\-X. (On keyboards
86 key, M\-\fIx\fP means ESC \fIx\fP, i.e., press the Escape key
89 key. This makes ESC the \fImeta prefix\fP.
90 The combination M\-C\-\fIx\fP means ESC\-Control\-\fIx\fP,
91 or press the Escape key
92 then hold the Control key while pressing the
96 Readline commands may be given numeric
98 which normally act as a repeat count. Sometimes, however, it is the
99 sign of the argument that is significant. Passing a negative argument
100 to a command that acts in the forward direction (e.g., \fBkill\-line\fP)
101 causes that command to act in a backward direction. Commands whose
102 behavior with arguments deviates from this are noted.
104 When a command is described as \fIkilling\fP text, the text
105 deleted is saved for possible future retrieval
106 (\fIyanking\fP). The killed text is saved in a
107 \fIkill ring\fP. Consecutive kills cause the text to be
108 accumulated into one unit, which can be yanked all at once.
109 Commands which do not kill text separate the chunks of text
111 .SH INITIALIZATION FILE
113 Readline is customized by putting commands in an initialization
114 file (the \fIinputrc\fP file).
115 The name of this file is taken from the value of the
117 environment variable. If that variable is unset, the default is
119 When a program which uses the readline library starts up, the
120 init file is read, and the key bindings and variables are set.
121 There are only a few basic constructs allowed in the
122 readline init file. Blank lines are ignored.
123 Lines beginning with a \fB#\fP are comments.
124 Lines beginning with a \fB$\fP indicate conditional constructs.
125 Other lines denote key bindings and variable settings.
126 Each program using this library may add its own commands
132 M\-Control\-u: universal\-argument
136 C\-Meta\-u: universal\-argument
141 would make M\-C\-u execute the readline command
142 .IR universal\-argument .
144 The following symbolic character names are recognized while
145 processing key bindings:
159 In addition to command names, readline allows keys to be bound
160 to a string that is inserted when the key is pressed (a \fImacro\fP).
164 The syntax for controlling key bindings in the
166 file is simple. All that is required is the name of the
167 command or the text of a macro and a key sequence to which
168 it should be bound. The name may be specified in one of two ways:
169 as a symbolic key name, possibly with \fIMeta\-\fP or \fIControl\-\fP
170 prefixes, or as a key sequence.
172 When using the form \fBkeyname\fP:\^\fIfunction-name\fP or \fImacro\fP,
174 is the name of a key spelled out in English. For example:
177 Control\-u: universal\-argument
179 Meta\-Rubout: backward\-kill\-word
181 Control\-o: "> output"
184 In the above example,
186 is bound to the function
187 .BR universal\-argument ,
189 is bound to the function
190 .BR backward\-kill\-word ,
193 is bound to run the macro
194 expressed on the right hand side (that is, to insert the text
195 .if t \f(CW> output\fP
199 In the second form, \fB"keyseq"\fP:\^\fIfunction\-name\fP or \fImacro\fP,
203 above in that strings denoting
204 an entire key sequence may be specified by placing the sequence
205 within double quotes. Some GNU Emacs style key escapes can be
206 used, as in the following example, but the symbolic character names
210 "\eC\-u": universal\-argument
212 "\eC\-x\eC\-r": re\-read\-init\-file
214 "\ee[11~": "Function Key 1"
219 is again bound to the function
220 .BR universal\-argument .
222 is bound to the function
223 .BR re\-read\-init\-file ,
226 is bound to insert the text
227 .if t \f(CWFunction Key 1\fP.
228 .if n ``Function Key 1''.
230 The full set of GNU Emacs style escape sequences available when specifying
248 literal ", a double quote
251 literal ', a single quote
255 In addition to the GNU Emacs style escape sequences, a second
256 set of backslash escapes is available:
285 the eight-bit character whose value is the octal value \fInnn\fP
286 (one to three digits)
289 the eight-bit character whose value is the hexadecimal value \fIHH\fP
290 (one or two hex digits)
294 When entering the text of a macro, single or double quotes should
295 be used to indicate a macro definition. Unquoted text
296 is assumed to be a function name.
297 In the macro body, the backslash escapes described above are expanded.
298 Backslash will quote any other character in the macro text,
302 allows the current readline key bindings to be displayed or modified
305 builtin command. The editing mode may be switched during interactive
310 builtin command. Other programs using this library provide
311 similar mechanisms. The
313 file may be edited and re-read if a program does not provide
314 any other means to incorporate new bindings.
317 Readline has variables that can be used to further customize its
318 behavior. A variable may be set in the
320 file with a statement of the form
323 \fBset\fP \fIvariable\-name\fP \fIvalue\fP
326 Except where noted, readline variables can take the values
330 (without regard to case).
331 The variables and their default values are:
335 .B bell\-style (audible)
336 Controls what happens when readline wants to ring the terminal bell.
337 If set to \fBnone\fP, readline never rings the bell. If set to
338 \fBvisible\fP, readline uses a visible bell if one is available.
339 If set to \fBaudible\fP, readline attempts to ring the terminal's bell.
341 .B comment\-begin (``#'')
342 The string that is inserted in \fBvi\fP mode when the
345 This command is bound to
351 .B completion\-ignore\-case (Off)
352 If set to \fBOn\fP, readline performs filename matching and completion
353 in a case\-insensitive fashion.
355 .B completion\-query\-items (100)
356 This determines when the user is queried about viewing
357 the number of possible completions
358 generated by the \fBpossible\-completions\fP command.
359 It may be set to any integer value greater than or equal to
360 zero. If the number of possible completions is greater than
361 or equal to the value of this variable, the user is asked whether
362 or not he wishes to view them; otherwise they are simply listed
365 .B convert\-meta (On)
366 If set to \fBOn\fP, readline will convert characters with the
367 eighth bit set to an ASCII key sequence
368 by stripping the eighth bit and prefixing it with an
369 escape character (in effect, using escape as the \fImeta prefix\fP).
371 .B disable\-completion (Off)
372 If set to \fBOn\fP, readline will inhibit word completion. Completion
373 characters will be inserted into the line as if they had been
374 mapped to \fBself-insert\fP.
376 .B editing\-mode (emacs)
377 Controls whether readline begins with a set of key bindings similar
385 .B enable\-keypad (Off)
386 When set to \fBOn\fP, readline will try to enable the application
387 keypad when it is called. Some systems need this to enable the
390 .B expand\-tilde (Off)
391 If set to \fBon\fP, tilde expansion is performed when readline
392 attempts word completion.
394 .B history-preserve-point
395 If set to \fBon\fP, the history code attempts to place point at the
396 same location on each history line retrived with \fBprevious-history\fP
397 or \fBnext-history\fP.
399 .B horizontal\-scroll\-mode (Off)
400 When set to \fBOn\fP, makes readline use a single line for display,
401 scrolling the input horizontally on a single screen line when it
402 becomes longer than the screen width rather than wrapping to a new line.
405 If set to \fBOn\fP, readline will enable eight-bit input (that is,
406 it will not clear the eighth bit in the characters it reads),
407 regardless of what the terminal claims it can support. The name
409 is a synonym for this variable.
411 .B isearch\-terminators (``C\-[ C\-J'')
412 The string of characters that should terminate an incremental
413 search without subsequently executing the character as a command.
414 If this variable has not been given a value, the characters
415 \fIESC\fP and \fIC\-J\fP will terminate an incremental search.
418 Set the current readline keymap. The set of legal keymap names is
419 \fIemacs, emacs-standard, emacs-meta, emacs-ctlx, vi, vi-move,
422 \fIvi\fP is equivalent to \fIvi-command\fP; \fIemacs\fP is
423 equivalent to \fIemacs-standard\fP. The default value is
427 also affects the default keymap.
429 .B mark\-directories (On)
430 If set to \fBOn\fP, completed directory names have a slash
433 .B mark\-modified\-lines (Off)
434 If set to \fBOn\fP, history lines that have been modified are displayed
435 with a preceding asterisk (\fB*\fP).
437 .B mark\-symlinked\-directories (Off)
438 If set to \fBOn\fP, completed names which are symbolic links to directories
439 have a slash appended (subject to the value of
440 \fBmark\-directories\fP).
442 .B match\-hidden\-files (On)
443 This variable, when set to \fBOn\fP, causes readline to match files whose
444 names begin with a `.' (hidden files) when performing filename
445 completion, unless the leading `.' is
446 supplied by the user in the filename to be completed.
448 .B output\-meta (Off)
449 If set to \fBOn\fP, readline will display characters with the
450 eighth bit set directly rather than as a meta-prefixed escape
453 .B page\-completions (On)
454 If set to \fBOn\fP, readline uses an internal \fImore\fP-like pager
455 to display a screenful of possible completions at a time.
457 .B print\-completions\-horizontally (Off)
458 If set to \fBOn\fP, readline will display completions with matches
459 sorted horizontally in alphabetical order, rather than down the screen.
461 .B show\-all\-if\-ambiguous (Off)
462 This alters the default behavior of the completion functions. If
465 words which have more than one possible completion cause the
466 matches to be listed immediately instead of ringing the bell.
468 .B visible\-stats (Off)
469 If set to \fBOn\fP, a character denoting a file's type as reported
470 by \fIstat\fP(2) is appended to the filename when listing possible
473 .SS Conditional Constructs
475 Readline implements a facility similar in spirit to the conditional
476 compilation features of the C preprocessor which allows key
477 bindings and variable settings to be performed as the result
478 of tests. There are four parser directives used.
482 construct allows bindings to be made based on the
483 editing mode, the terminal being used, or the application using
484 readline. The text of the test extends to the end of the line;
485 no characters are required to isolate it.
488 The \fBmode=\fP form of the \fB$if\fP directive is used to test
489 whether readline is in emacs or vi mode.
490 This may be used in conjunction
491 with the \fBset keymap\fP command, for instance, to set bindings in
492 the \fIemacs-standard\fP and \fIemacs-ctlx\fP keymaps only if
493 readline is starting out in emacs mode.
495 The \fBterm=\fP form may be used to include terminal-specific
496 key bindings, perhaps to bind the key sequences output by the
497 terminal's function keys. The word on the right side of the
499 is tested against the full name of the terminal and the portion
500 of the terminal name before the first \fB\-\fP. This allows
507 .IP \fBapplication\fP
508 The \fBapplication\fP construct is used to include
509 application-specific settings. Each program using the readline
510 library sets the \fIapplication name\fP, and an initialization
511 file can test for a particular value.
512 This could be used to bind key sequences to functions useful for
513 a specific program. For instance, the following command adds a
514 key sequence that quotes the current or previous word in Bash:
519 # Quote the current or previous word
520 "\eC-xq": "\eeb\e"\eef\e""
526 This command, as seen in the previous example, terminates an
529 Commands in this branch of the \fB$if\fP directive are executed if
532 This directive takes a single filename as an argument and reads commands
533 and bindings from that file. For example, the following directive
534 would read \fI/etc/inputrc\fP:
538 \fB$include\fP \^ \fI/etc/inputrc\fP
543 Readline provides commands for searching through the command history
544 for lines containing a specified string.
545 There are two search modes:
548 .IR non-incremental .
550 Incremental searches begin before the user has finished typing the
552 As each character of the search string is typed, readline displays
553 the next entry from the history matching the string typed so far.
554 An incremental search requires only as many characters as needed to
555 find the desired history entry.
556 To search backward in the history for a particular string, type
557 \fBC\-r\fP. Typing \fBC\-s\fP searches forward through the history.
558 The characters present in the value of the \fBisearch-terminators\fP
559 variable are used to terminate an incremental search.
560 If that variable has not been assigned a value the \fIEscape\fP and
561 \fBC\-J\fP characters will terminate an incremental search.
562 \fBC\-G\fP will abort an incremental search and restore the original
564 When the search is terminated, the history entry containing the
565 search string becomes the current line.
567 To find other matching entries in the history list, type \fBC\-s\fP or
568 \fBC\-r\fP as appropriate.
569 This will search backward or forward in the history for the next
570 line matching the search string typed so far.
571 Any other key sequence bound to a readline command will terminate
572 the search and execute that command.
573 For instance, a newline will terminate the search and accept
574 the line, thereby executing the command from the history list.
575 A movement command will terminate the search, make the last line found
576 the current line, and begin editing.
578 Non-incremental searches read the entire search string before starting
579 to search for matching history lines. The search string may be
580 typed by the user or be part of the contents of the current line.
583 The following is a list of the names of the commands and the default
584 key sequences to which they are bound.
585 Command names without an accompanying key sequence are unbound by default.
587 In the following descriptions, \fIpoint\fP refers to the current cursor
588 position, and \fImark\fP refers to a cursor position saved by the
589 \fBset\-mark\fP command.
590 The text between the point and mark is referred to as the \fIregion\fP.
591 .SS Commands for Moving
595 .B beginning\-of\-line (C\-a)
596 Move to the start of the current line.
598 .B end\-of\-line (C\-e)
599 Move to the end of the line.
601 .B forward\-char (C\-f)
602 Move forward a character.
604 .B backward\-char (C\-b)
605 Move back a character.
607 .B forward\-word (M\-f)
608 Move forward to the end of the next word. Words are composed of
609 alphanumeric characters (letters and digits).
611 .B backward\-word (M\-b)
612 Move back to the start of the current or previous word. Words are
613 composed of alphanumeric characters (letters and digits).
615 .B clear\-screen (C\-l)
616 Clear the screen leaving the current line at the top of the screen.
617 With an argument, refresh the current line without clearing the
620 .B redraw\-current\-line
621 Refresh the current line.
623 .SS Commands for Manipulating the History
627 .B accept\-line (Newline, Return)
628 Accept the line regardless of where the cursor is.
630 non-empty, it may be added to the history list for future recall with
632 If the line is a modified history line, the history line is restored to its original state.
634 .B previous\-history (C\-p)
635 Fetch the previous command from the history list, moving back in
638 .B next\-history (C\-n)
639 Fetch the next command from the history list, moving forward in the
642 .B beginning\-of\-history (M\-<)
643 Move to the first line in the history.
645 .B end\-of\-history (M\->)
646 Move to the end of the input history, i.e., the line currently being
649 .B reverse\-search\-history (C\-r)
650 Search backward starting at the current line and moving `up' through
651 the history as necessary. This is an incremental search.
653 .B forward\-search\-history (C\-s)
654 Search forward starting at the current line and moving `down' through
655 the history as necessary. This is an incremental search.
657 .B non\-incremental\-reverse\-search\-history (M\-p)
658 Search backward through the history starting at the current line
659 using a non-incremental search for a string supplied by the user.
661 .B non\-incremental\-forward\-search\-history (M\-n)
662 Search forward through the history using a non-incremental search
663 for a string supplied by the user.
665 .B history\-search\-forward
666 Search forward through the history for the string of characters
667 between the start of the current line and the current cursor
668 position (the \fIpoint\fP).
669 This is a non-incremental search.
671 .B history\-search\-backward
672 Search backward through the history for the string of characters
673 between the start of the current line and the point.
674 This is a non-incremental search.
676 .B yank\-nth\-arg (M\-C\-y)
677 Insert the first argument to the previous command (usually
678 the second word on the previous line) at point.
681 insert the \fIn\fPth word from the previous command (the words
682 in the previous command begin with word 0). A negative argument
683 inserts the \fIn\fPth word from the end of the previous command.
686 yank\-last\-arg (M\-.\^, M\-_\^)
687 Insert the last argument to the previous command (the last word of
688 the previous history entry). With an argument,
689 behave exactly like \fByank\-nth\-arg\fP.
690 Successive calls to \fByank\-last\-arg\fP move back through the history
691 list, inserting the last argument of each line in turn.
693 .SS Commands for Changing Text
697 .B delete\-char (C\-d)
698 Delete the character at point. If point is at the
699 beginning of the line, there are no characters in the line, and
700 the last character typed was not bound to \fBdelete\-char\fP, then return
704 .B backward\-delete\-char (Rubout)
705 Delete the character behind the cursor. When given a numeric argument,
706 save the deleted text on the kill ring.
708 .B forward\-backward\-delete\-char
709 Delete the character under the cursor, unless the cursor is at the
710 end of the line, in which case the character behind the cursor is
713 .B quoted\-insert (C\-q, C\-v)
714 Add the next character that you type to the line verbatim. This is
715 how to insert characters like \fBC\-q\fP, for example.
717 .B tab\-insert (M-TAB)
718 Insert a tab character.
720 .B self\-insert (a,\ b,\ A,\ 1,\ !,\ ...)
721 Insert the character typed.
723 .B transpose\-chars (C\-t)
724 Drag the character before point forward over the character at point,
725 moving point forward as well.
726 If point is at the end of the line, then this transposes
727 the two characters before point.
728 Negative arguments have no effect.
730 .B transpose\-words (M\-t)
731 Drag the word before point past the word after point,
732 moving point over that word as well.
733 If point is at the end of the line, this transposes
734 the last two words on the line.
736 .B upcase\-word (M\-u)
737 Uppercase the current (or following) word. With a negative argument,
738 uppercase the previous word, but do not move point.
740 .B downcase\-word (M\-l)
741 Lowercase the current (or following) word. With a negative argument,
742 lowercase the previous word, but do not move point.
744 .B capitalize\-word (M\-c)
745 Capitalize the current (or following) word. With a negative argument,
746 capitalize the previous word, but do not move point.
749 Toggle overwrite mode. With an explicit positive numeric argument,
750 switches to overwrite mode. With an explicit non-positive numeric
751 argument, switches to insert mode. This command affects only
752 \fBemacs\fP mode; \fBvi\fP mode does overwrite differently.
753 Each call to \fIreadline()\fP starts in insert mode.
754 In overwrite mode, characters bound to \fBself\-insert\fP replace
755 the text at point rather than pushing the text to the right.
756 Characters bound to \fBbackward\-delete\-char\fP replace the character
757 before point with a space. By default, this command is unbound.
759 .SS Killing and Yanking
764 Kill the text from point to the end of the line.
766 .B backward\-kill\-line (C\-x Rubout)
767 Kill backward to the beginning of the line.
769 .B unix\-line\-discard (C\-u)
770 Kill backward from point to the beginning of the line.
771 The killed text is saved on the kill-ring.
772 .\" There is no real difference between this and backward-kill-line
775 Kill all characters on the current line, no matter where point is.
778 Kill from point the end of the current word, or if between
779 words, to the end of the next word. Word boundaries are the same as
780 those used by \fBforward\-word\fP.
782 .B backward\-kill\-word (M\-Rubout)
783 Kill the word behind point.
784 Word boundaries are the same as those used by \fBbackward\-word\fP.
786 .B unix\-word\-rubout (C\-w)
787 Kill the word behind point, using white space as a word boundary.
788 The killed text is saved on the kill-ring.
790 .B delete\-horizontal\-space (M\-\e)
791 Delete all spaces and tabs around point.
794 Kill the text between the point and \fImark\fP (saved cursor position).
795 This text is referred to as the \fIregion\fP.
797 .B copy\-region\-as\-kill
798 Copy the text in the region to the kill buffer.
800 .B copy\-backward\-word
801 Copy the word before point to the kill buffer.
802 The word boundaries are the same as \fBbackward\-word\fP.
804 .B copy\-forward\-word
805 Copy the word following point to the kill buffer.
806 The word boundaries are the same as \fBforward\-word\fP.
809 Yank the top of the kill ring into the buffer at point.
812 Rotate the kill ring, and yank the new top. Only works following
817 .SS Numeric Arguments
821 .B digit\-argument (M\-0, M\-1, ..., M\-\-)
822 Add this digit to the argument already accumulating, or start a new
823 argument. M\-\- starts a negative argument.
825 .B universal\-argument
826 This is another way to specify an argument.
827 If this command is followed by one or more digits, optionally with a
828 leading minus sign, those digits define the argument.
829 If the command is followed by digits, executing
830 .B universal\-argument
831 again ends the numeric argument, but is otherwise ignored.
832 As a special case, if this command is immediately followed by a
833 character that is neither a digit or minus sign, the argument count
834 for the next command is multiplied by four.
835 The argument count is initially one, so executing this function the
836 first time makes the argument count four, a second time makes the
837 argument count sixteen, and so on.
844 Attempt to perform completion on the text before point.
845 The actual completion performed is application-specific.
847 for instance, attempts completion treating the text as a variable
848 (if the text begins with \fB$\fP), username (if the text begins with
849 \fB~\fP), hostname (if the text begins with \fB@\fP), or
850 command (including aliases and functions) in turn. If none
851 of these produces a match, filename completion is attempted.
854 allows completion of program functions and variables, and
855 only attempts filename completion under certain circumstances.
857 .B possible\-completions (M\-?)
858 List the possible completions of the text before point.
860 .B insert\-completions (M\-*)
861 Insert all completions of the text before point
862 that would have been generated by
863 \fBpossible\-completions\fP.
866 Similar to \fBcomplete\fP, but replaces the word to be completed
867 with a single match from the list of possible completions.
868 Repeated execution of \fBmenu\-complete\fP steps through the list
869 of possible completions, inserting each match in turn.
870 At the end of the list of completions, the bell is rung
871 (subject to the setting of \Bbell\-style\fP)
872 and the original text is restored.
873 An argument of \fIn\fP moves \fIn\fP positions forward in the list
874 of matches; a negative argument may be used to move backward
876 This command is intended to be bound to \fBTAB\fP, but is unbound
879 .B delete\-char\-or\-list
880 Deletes the character under the cursor if not at the beginning or
881 end of the line (like \fBdelete-char\fP).
882 If at the end of the line, behaves identically to
883 \fBpossible-completions\fP.
889 .B start\-kbd\-macro (C\-x (\^)
890 Begin saving the characters typed into the current keyboard macro.
892 .B end\-kbd\-macro (C\-x )\^)
893 Stop saving the characters typed into the current keyboard macro
894 and store the definition.
896 .B call\-last\-kbd\-macro (C\-x e)
897 Re-execute the last keyboard macro defined, by making the characters
898 in the macro appear as if typed at the keyboard.
904 .B re\-read\-init\-file (C\-x C\-r)
905 Read in the contents of the \fIinputrc\fP file, and incorporate
906 any bindings or variable assignments found there.
909 Abort the current editing command and
910 ring the terminal's bell (subject to the setting of
913 .B do\-uppercase\-version (M\-a, M\-b, M\-\fIx\fP, ...)
914 If the metafied character \fIx\fP is lowercase, run the command
915 that is bound to the corresponding uppercase character.
917 .B prefix\-meta (ESC)
918 Metafy the next character typed.
925 .B undo (C\-_, C\-x C\-u)
926 Incremental undo, separately remembered for each line.
928 .B revert\-line (M\-r)
929 Undo all changes made to this line. This is like executing the
931 command enough times to return the line to its initial state.
933 .B tilde\-expand (M\-&)
934 Perform tilde expansion on the current word.
936 .B set\-mark (C\-@, M\-<space>)
937 Set the mark to the point. If a
938 numeric argument is supplied, the mark is set to that position.
940 .B exchange\-point\-and\-mark (C\-x C\-x)
941 Swap the point with the mark. The current cursor position is set to
942 the saved position, and the old cursor position is saved as the mark.
944 .B character\-search (C\-])
945 A character is read and point is moved to the next occurrence of that
946 character. A negative count searches for previous occurrences.
948 .B character\-search\-backward (M\-C\-])
949 A character is read and point is moved to the previous occurrence of that
950 character. A negative count searches for subsequent occurrences.
952 .B insert\-comment (M\-#)
953 Without a numeric argument, the value of the readline
955 variable is inserted at the beginning of the current line.
956 If a numeric argument is supplied, this command acts as a toggle: if
957 the characters at the beginning of the line do not match the value
958 of \fBcomment\-begin\fP, the value is inserted, otherwise
959 the characters in \fBcomment-begin\fP are deleted from the beginning of
961 In either case, the line is accepted as if a newline had been typed.
964 makes the current line a shell comment.
965 If a numeric argument causes the comment character to be removed, the line
966 will be executed by the shell.
969 Print all of the functions and their key bindings to the
970 readline output stream. If a numeric argument is supplied,
971 the output is formatted in such a way that it can be made part
972 of an \fIinputrc\fP file.
975 Print all of the settable variables and their values to the
976 readline output stream. If a numeric argument is supplied,
977 the output is formatted in such a way that it can be made part
978 of an \fIinputrc\fP file.
981 Print all of the readline key sequences bound to macros and the
982 strings they ouput. If a numeric argument is supplied,
983 the output is formatted in such a way that it can be made part
984 of an \fIinputrc\fP file.
986 .B emacs\-editing\-mode (C\-e)
989 command mode, this causes a switch to
993 .B vi\-editing\-mode (M\-C\-j)
996 editing mode, this causes a switch to
1000 .SH DEFAULT KEY BINDINGS
1002 The following is a list of the default emacs and vi bindings.
1003 Characters with the eighth bit set are written as M\-<character>, and
1007 The printable ASCII characters not mentioned in the list of emacs
1008 standard bindings are bound to the
1010 function, which just inserts the given character into the input line.
1011 In vi insertion mode, all characters not specifically mentioned are
1014 Characters assigned to signal generation by
1016 or the terminal driver, such as C-Z or C-C,
1017 retain that function.
1018 Upper and lower case metafied characters are bound to the same function in
1019 the emacs mode meta keymap.
1020 The remaining characters are unbound, which causes readline
1021 to ring the bell (subject to the setting of the
1029 Emacs Standard bindings
1032 "C-A" beginning-of-line
1038 "C-H" backward-delete-char
1045 "C-P" previous-history
1047 "C-R" reverse-search-history
1048 "C-S" forward-search-history
1049 "C-T" transpose-chars
1050 "C-U" unix-line-discard
1052 "C-W" unix-word-rubout
1054 "C-]" character-search
1056 "\^ " to "/" self-insert
1057 "0" to "9" self-insert
1058 ":" to "~" self-insert
1059 "C-?" backward-delete-char
1064 "M-C-H" backward-kill-word
1066 "M-C-J" vi-editing-mode
1067 "M-C-M" vi-editing-mode
1069 "M-C-Y" yank-nth-arg
1071 "M-C-]" character-search-backward
1073 "M-#" insert-comment
1075 "M-*" insert-completions
1076 "M--" digit-argument
1078 "M-0" digit-argument
1079 "M-1" digit-argument
1080 "M-2" digit-argument
1081 "M-3" digit-argument
1082 "M-4" digit-argument
1083 "M-5" digit-argument
1084 "M-6" digit-argument
1085 "M-7" digit-argument
1086 "M-8" digit-argument
1087 "M-9" digit-argument
1088 "M-<" beginning-of-history
1089 "M-=" possible-completions
1090 "M->" end-of-history
1091 "M-?" possible-completions
1093 "M-C" capitalize-word
1097 "M-N" non-incremental-forward-search-history
1098 "M-P" non-incremental-reverse-search-history
1100 "M-T" transpose-words
1103 "M-\e" delete-horizontal-space
1105 "M-C-?" backward-kill-word
1108 Emacs Control-X bindings
1111 "C-XC-R" re-read-init-file
1113 "C-XC-X" exchange-point-and-mark
1114 "C-X(" start-kbd-macro
1115 "C-X)" end-kbd-macro
1116 "C-XE" call-last-kbd-macro
1117 "C-XC-?" backward-kill-line
1120 .SS VI Mode bindings
1126 VI Insert Mode functions
1129 "C-H" backward-delete-char
1133 "C-R" reverse-search-history
1134 "C-S" forward-search-history
1135 "C-T" transpose-chars
1136 "C-U" unix-line-discard
1138 "C-W" unix-word-rubout
1140 "C-[" vi-movement-mode
1142 "\^ " to "~" self-insert
1143 "C-?" backward-delete-char
1145 VI Command Mode functions
1148 "C-E" emacs-editing-mode
1156 "C-P" previous-history
1158 "C-R" reverse-search-history
1159 "C-S" forward-search-history
1160 "C-T" transpose-chars
1161 "C-U" unix-line-discard
1163 "C-W" unix-word-rubout
1174 "-" previous-history
1177 "0" beginning-of-line
1178 "1" to "9" vi-arg-digit
1188 "G" vi-fetch-history
1197 "X" backward-delete-char
1210 "i" vi-insertion-mode
1230 \fIThe Gnu Readline Library\fP, Brian Fox and Chet Ramey
1232 \fIThe Gnu History Library\fP, Brian Fox and Chet Ramey
1240 Individual \fBreadline\fP initialization file
1243 Brian Fox, Free Software Foundation
1247 Chet Ramey, Case Western Reserve University
1251 If you find a bug in
1253 you should report it. But first, you should
1254 make sure that it really is a bug, and that it appears in the latest
1257 library that you have.
1259 Once you have determined that a bug actually exists, mail a
1260 bug report to \fIbug\-readline\fP@\fIgnu.org\fP.
1261 If you have a fix, you are welcome to mail that
1262 as well! Suggestions and `philosophical' bug reports may be mailed
1263 to \fPbug-readline\fP@\fIgnu.org\fP or posted to the Usenet
1267 Comments and bug reports concerning
1268 this manual page should be directed to
1269 .IR chet@ins.CWRU.Edu .
1272 It's too big and too slow.
projects / deliverable / binutils-gdb.git / blob