summaryrefslogtreecommitdiff
path: root/doc/rluserman.info
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rluserman.info')
-rw-r--r--doc/rluserman.info168
1 files changed, 130 insertions, 38 deletions
diff --git a/doc/rluserman.info b/doc/rluserman.info
index 3e5a3ba..49f2a1e 100644
--- a/doc/rluserman.info
+++ b/doc/rluserman.info
@@ -1,8 +1,8 @@
This is rluserman.info, produced by makeinfo version 4.13 from
-/Users/chet/src/bash/readline-src/doc/rluserman.texi.
+/usr/src/local/chet/src/bash/readline-src/doc/rluserman.texi.
This manual describes the end user interface of the GNU Readline Library
-(version 6.0, 28 October 2008), a library which aids in the consistency
+(version 6.1, 9 October 2009), a library which aids in the consistency
of user interface across discrete programs which provide a command line
interface.
@@ -14,7 +14,7 @@ preserved on all copies.
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
- Version 1.2 or any later version published by the Free Software
+ Version 1.3 or any later version published by the Free Software
Foundation; with no Invariant Sections, with the Front-Cover texts
being "A GNU Manual", and with the Back-Cover Texts as in (a)
below. A copy of the license is included in the section entitled
@@ -438,11 +438,22 @@ Variable Settings
editing mode, where the keystrokes are most similar to Emacs.
This variable can be set to either `emacs' or `vi'.
+ `echo-control-characters'
+ 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'.
+
`enable-keypad'
When set to `on', Readline will try to enable the application
keypad when it is called. Some systems need this to enable
the arrow keys. The default is `off'.
+ `enable-meta-key'
+ When set to `on', Readline will try to enable any meta
+ modifier key the terminal claims to support when it is
+ called. On many terminals, the meta key is used to send
+ eight-bit characters. The default is `on'.
+
`expand-tilde'
If set to `on', tilde expansion is performed when Readline
attempts word completion. The default is `off'.
@@ -545,6 +556,19 @@ Variable Settings
be listed immediately instead of ringing the bell. The
default value is `off'.
+ `skip-completed-text'
+ If set to `on', this alters the default completion behavior
+ when inserting a single match into the line. It's only
+ active when performing completion in the middle of a word.
+ If enabled, readline does not insert characters from the
+ completion that match characters after point in the word
+ being completed, so portions of the word following the cursor
+ are not duplicated. For instance, if this is enabled,
+ attempting completion when the cursor is after the `e' in
+ `Makefile' will result in `Makefile' rather than
+ `Makefilefile', assuming there is a single possible
+ completion. The default value is `off'.
+
`visible-stats'
If set to `on', a character denoting a file's type is
appended to the filename when listing possible completions.
@@ -1159,6 +1183,11 @@ File: rluserman.info, Node: Commands For Completion, Next: Keyboard Macros, P
command is intended to be bound to <TAB>, but is unbound by
default.
+`menu-complete-backward ()'
+ Identical to `menu-complete', but moves backward through the list
+ of possible completions, as if `menu-complete' had been given a
+ negative argument.
+
`delete-char-or-list ()'
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,
@@ -1235,6 +1264,15 @@ File: rluserman.info, Node: Miscellaneous Commands, Prev: Keyboard Macros, Up
of that character. A negative count searches for subsequent
occurrences.
+`skip-csi-sequence ()'
+ Read enough characters to consume a multi-key sequence such as
+ those defined for keys like Home and End. Such sequences begin
+ with a Control Sequence Indicator (CSI), usually ESC-[. If this
+ sequence is bound to "\e[", keys producing such sequences will
+ have no effect unless explicitly bound to a readline command,
+ instead of inserting stray characters into the editing buffer.
+ This is unbound by default, but usually bound to ESC-[.
+
`insert-comment (M-#)'
Without a numeric argument, the value of the `comment-begin'
variable is inserted at the beginning of the current line. If a
@@ -1300,10 +1338,10 @@ File: rluserman.info, Node: GNU Free Documentation License, Prev: Command Line
Appendix A GNU Free Documentation License
*****************************************
- Version 1.2, November 2002
+ Version 1.3, 3 November 2008
- Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+ `http://fsf.org/'
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
@@ -1405,6 +1443,9 @@ Appendix A GNU Free Documentation License
Page" means the text near the most prominent appearance of the
work's title, preceding the beginning of the body of the text.
+ The "publisher" means any person or entity that distributes copies
+ of the Document to the public.
+
A section "Entitled XYZ" means a named subunit of the Document
whose title either is precisely XYZ or contains XYZ in parentheses
following text that translates XYZ in another language. (Here XYZ
@@ -1670,12 +1711,29 @@ Appendix A GNU Free Documentation License
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document
- except as expressly provided for under this License. Any other
- attempt to copy, modify, sublicense or distribute the Document is
- void, and will automatically terminate your rights under this
- License. However, parties who have received copies, or rights,
- from you under this License will not have their licenses
- terminated so long as such parties remain in full compliance.
+ except as expressly provided under this License. Any attempt
+ otherwise to copy, modify, sublicense, or distribute it is void,
+ and will automatically terminate your rights under this License.
+
+ However, if you cease all violation of this License, then your
+ license from a particular copyright holder is reinstated (a)
+ provisionally, unless and until the copyright holder explicitly
+ and finally terminates your license, and (b) permanently, if the
+ copyright holder fails to notify you of the violation by some
+ reasonable means prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+ reinstated permanently if the copyright holder notifies you of the
+ violation by some reasonable means, this is the first time you have
+ received notice of violation of this License (for any work) from
+ that copyright holder, and you cure the violation prior to 30 days
+ after your receipt of the notice.
+
+ Termination of your rights under this section does not terminate
+ the licenses of parties who have received copies or rights from
+ you under this License. If your rights have been terminated and
+ not permanently reinstated, receipt of a copy of some or all of
+ the same material does not give you any rights to use it.
10. FUTURE REVISIONS OF THIS LICENSE
@@ -1693,7 +1751,41 @@ Appendix A GNU Free Documentation License
published (not as a draft) by the Free Software Foundation. If
the Document does not specify a version number of this License,
you may choose any version ever published (not as a draft) by the
- Free Software Foundation.
+ Free Software Foundation. If the Document specifies that a proxy
+ can decide which future versions of this License can be used, that
+ proxy's public statement of acceptance of a version permanently
+ authorizes you to choose that version for the Document.
+
+ 11. RELICENSING
+
+ "Massive Multiauthor Collaboration Site" (or "MMC Site") means any
+ World Wide Web server that publishes copyrightable works and also
+ provides prominent facilities for anybody to edit those works. A
+ public wiki that anybody can edit is an example of such a server.
+ A "Massive Multiauthor Collaboration" (or "MMC") contained in the
+ site means any set of copyrightable works thus published on the MMC
+ site.
+
+ "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
+ license published by Creative Commons Corporation, a not-for-profit
+ corporation with a principal place of business in San Francisco,
+ California, as well as future copyleft versions of that license
+ published by that same organization.
+
+ "Incorporate" means to publish or republish a Document, in whole or
+ in part, as part of another Document.
+
+ An MMC is "eligible for relicensing" if it is licensed under this
+ License, and if all works that were first published under this
+ License somewhere other than this MMC, and subsequently
+ incorporated in whole or in part into the MMC, (1) had no cover
+ texts or invariant sections, and (2) were thus incorporated prior
+ to November 1, 2008.
+
+ The operator of an MMC Site may republish an MMC contained in the
+ site under CC-BY-SA on the same site at any time before August 1,
+ 2009, provided the MMC is eligible for relicensing.
+
ADDENDUM: How to use this License for your documents
====================================================
@@ -1704,7 +1796,7 @@ notices just after the title page:
Copyright (C) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.2
+ under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled ``GNU
@@ -1729,29 +1821,29 @@ permit their use in free software.

Tag Table:
-Node: Top1364
-Node: Command Line Editing1818
-Node: Introduction and Notation2472
-Node: Readline Interaction4096
-Node: Readline Bare Essentials5289
-Node: Readline Movement Commands7080
-Node: Readline Killing Commands8047
-Node: Readline Arguments9969
-Node: Searching11015
-Node: Readline Init File13168
-Node: Readline Init File Syntax14323
-Node: Conditional Init Constructs27277
-Node: Sample Init File29812
-Node: Bindable Readline Commands32931
-Node: Commands For Moving33990
-Node: Commands For History34853
-Node: Commands For Text37979
-Node: Commands For Killing40707
-Node: Numeric Arguments42851
-Node: Commands For Completion43992
-Node: Keyboard Macros45538
-Node: Miscellaneous Commands46111
-Node: Readline vi Mode49474
-Node: GNU Free Documentation License50395
+Node: Top1371
+Node: Command Line Editing1825
+Node: Introduction and Notation2479
+Node: Readline Interaction4103
+Node: Readline Bare Essentials5296
+Node: Readline Movement Commands7087
+Node: Readline Killing Commands8054
+Node: Readline Arguments9976
+Node: Searching11022
+Node: Readline Init File13175
+Node: Readline Init File Syntax14330
+Node: Conditional Init Constructs28537
+Node: Sample Init File31072
+Node: Bindable Readline Commands34191
+Node: Commands For Moving35250
+Node: Commands For History36113
+Node: Commands For Text39239
+Node: Commands For Killing41967
+Node: Numeric Arguments44111
+Node: Commands For Completion45252
+Node: Keyboard Macros46991
+Node: Miscellaneous Commands47564
+Node: Readline vi Mode51422
+Node: GNU Free Documentation License52343

End Tag Table