updates to man pages to deal with groff warnings and old troff versions

This commit is contained in:
Chet Ramey
2024-02-09 10:41:58 -05:00
parent dc97ded434
commit 092aa45bcc
15 changed files with 17669 additions and 17198 deletions
+6
View File
@@ -8555,3 +8555,9 @@ bashline.c
in the presence of multibyte characters
- bash_vi_complete: call vi_advance_point instead of just incrementing
rl_point
2/5
---
doc/bash.1,lib/readline/doc/readline.3
- minor updates to handle old versions of troff and groff warnings
Fixes from G. Branden Robinson <g.branden.robinson@gmail.com>
+1789 -1780
View File
File diff suppressed because it is too large Load Diff
+344 -214
View File
File diff suppressed because it is too large Load Diff
+648 -424
View File
File diff suppressed because it is too large Load Diff
+3678 -3670
View File
File diff suppressed because it is too large Load Diff
BIN
View File
Binary file not shown.
+6673 -6631
View File
File diff suppressed because it is too large Load Diff
+3678 -3670
View File
File diff suppressed because it is too large Load Diff
+50 -50
View File
@@ -1,12 +1,12 @@
This is pdfTeX, Version 3.141592653-2.6-1.40.22 (TeX Live 2021/MacPorts 2021.58693_0) (preloaded format=pdfetex 2021.8.30) 14 DEC 2023 16:39
This is pdfTeX, Version 3.141592653-2.6-1.40.25 (TeX Live 2023/MacPorts 2023.66589_3) (preloaded format=pdfetex 2024.1.2) 7 FEB 2024 09:25
entering extended mode
restricted \write18 enabled.
file:line:error style messages enabled.
%&-line parsing enabled.
**\input /usr/local/src/bash/bash-20231212/doc/bashref.texi \input /usr/local/s
rc/bash/bash-20231212/doc/bashref.texi
(/usr/local/src/bash/bash-20231212/doc/bashref.texi
(/usr/local/src/bash/bash-20231212/doc/texinfo.tex
**\input /usr/local/src/bash/bash-20240205/doc/bashref.texi \input /usr/local/s
rc/bash/bash-20240205/doc/bashref.texi
(/usr/local/src/bash/bash-20240205/doc/bashref.texi
(/usr/local/src/bash/bash-20240205/doc/texinfo.tex
Loading texinfo [version 2015-11-22.14]:
\outerhsize=\dimen16
\outervsize=\dimen17
@@ -162,15 +162,15 @@ This is `epsf.tex' v2.7.4 <14 February 2011>
texinfo.tex: doing @include of version.texi
(/usr/local/src/bash/bash-20231212/doc/version.texi) [1{/opt/local/var/db/texmf
(/usr/local/src/bash/bash-20240205/doc/version.texi) [1{/opt/local/var/db/texmf
/fonts/map/pdftex/updmap/pdftex.map}] [2]
(/usr/local/build/bash/bash-20231212/doc/bashref.toc [-1] [-2] [-3]) [-4]
(/usr/local/build/bash/bash-20231212/doc/bashref.toc)
(/usr/local/build/bash/bash-20231212/doc/bashref.toc) Chapter 1
(/usr/local/build/bash/bash-20240205/doc/bashref.toc [-1] [-2] [-3]) [-4]
(/usr/local/build/bash/bash-20240205/doc/bashref.toc)
(/usr/local/build/bash/bash-20240205/doc/bashref.toc) Chapter 1
\openout0 = `bashref.toc'.
(/usr/local/build/bash/bash-20231212/doc/bashref.aux)
(/usr/local/build/bash/bash-20240205/doc/bashref.aux)
\openout1 = `bashref.aux'.
Chapter 2 [1] [2]
@@ -221,16 +221,17 @@ Overfull \hbox (5.95723pt too wide) in paragraph at lines 724--725
@rwindfile=@write4
\openout4 = `bashref.rw'.
[9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23]
[24] [25] [26] [27] [28] [29] [30] [31] [32] [33] [34] [35] [36] [37] [38]
[39] [40] [41] [42] [43] [44] [45] [46] [47] Chapter 4 [48]
[9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19{/opt/local/share/texmf-tex
live/fonts/enc/dvips/cm-super/cm-super-t1.enc}] [20] [21] [22] [23] [24]
[25] [26] [27] [28] [29] [30] [31] [32] [33] [34] [35] [36] [37] [38] [39]
[40] [41] [42] [43] [44] [45] [46] [47] Chapter 4 [48]
@btindfile=@write5
\openout5 = `bashref.bt'.
[49] [50] [51]
[52] [53] [54] [55] [56] [57] [58] [59] [60] [61] [62] [63] [64] [65] [66]
[67] [68]
Overfull \hbox (38.26585pt too wide) in paragraph at lines 5420--5420
[49] [50] [51] [52]
[53] [54] [55] [56] [57] [58] [59] [60] [61] [62] [63] [64] [65] [66] [67]
[68]
Overfull \hbox (38.26585pt too wide) in paragraph at lines 5435--5435
[]@texttt set [-abefhkmnptuvxBCEHPT] [-o @textttsl option-name@texttt ] [--] [
-] [@textttsl ar-gu-ment []@texttt ][]
@@ -243,7 +244,7 @@ Overfull \hbox (38.26585pt too wide) in paragraph at lines 5420--5420
.etc.
Overfull \hbox (38.26585pt too wide) in paragraph at lines 5421--5421
Overfull \hbox (38.26585pt too wide) in paragraph at lines 5436--5436
[]@texttt set [+abefhkmnptuvxBCEHPT] [+o @textttsl option-name@texttt ] [--] [
-] [@textttsl ar-gu-ment []@texttt ][]
@@ -262,10 +263,10 @@ Overfull \hbox (38.26585pt too wide) in paragraph at lines 5421--5421
[119] [120]
texinfo.tex: doing @include of rluser.texi
(/usr/local/src/bash/bash-20231212/lib/readline/doc/rluser.texi
(/usr/local/src/bash/bash-20240205/lib/readline/doc/rluser.texi
Chapter 8 [121] [122] [123] [124] [125] [126] [127] [128] [129] [130] [131]
[132]
Underfull \hbox (badness 7540) in paragraph at lines 878--884
Underfull \hbox (badness 7540) in paragraph at lines 882--888
[]@textrm In the ex-am-ple above, @textttsl C-u[] @textrm is bound to the func
-tion
@@ -278,7 +279,7 @@ Underfull \hbox (badness 7540) in paragraph at lines 878--884
.etc.
Underfull \hbox (badness 10000) in paragraph at lines 878--884
Underfull \hbox (badness 10000) in paragraph at lines 882--888
@texttt universal-argument[]@textrm , @textttsl M-DEL[] @textrm is bound to th
e func-tion
@@ -291,7 +292,7 @@ e func-tion
.etc.
[133] [134] [135] [136]
Overfull \hbox (26.43913pt too wide) in paragraph at lines 1112--1112
Overfull \hbox (26.43913pt too wide) in paragraph at lines 1116--1116
[]@texttt Meta-Control-h: backward-kill-word Text after the function name is i
gnored[]
@@ -312,10 +313,10 @@ gnored[]
texinfo.tex: doing @include of hsuser.texi
(/usr/local/src/bash/bash-20231212/lib/readline/doc/hsuser.texi Chapter 9
(/usr/local/src/bash/bash-20240205/lib/readline/doc/hsuser.texi Chapter 9
[158] [159] [160] [161] [162] [163]) Chapter 10 [164] [165] [166] [167]
[168]
Underfull \hbox (badness 10000) in paragraph at lines 9776--9785
Underfull \hbox (badness 10000) in paragraph at lines 9801--9810
[]@textrm All of the fol-low-ing op-tions ex-cept for `@texttt alt-array-implem
entation[]@textrm '[],
@@ -328,7 +329,7 @@ entation[]@textrm '[],
.etc.
Underfull \hbox (badness 10000) in paragraph at lines 9776--9785
Underfull \hbox (badness 10000) in paragraph at lines 9801--9810
@textrm `@texttt disabled-builtins[]@textrm '[], `@texttt direxpand-default[]@t
extrm '[], `@texttt strict-posix-default[]@textrm '[], and
@@ -344,35 +345,34 @@ extrm '[], `@texttt strict-posix-default[]@textrm '[], and
[178] [179] Appendix C [180]
texinfo.tex: doing @include of fdl.texi
(/usr/local/src/bash/bash-20231212/doc/fdl.texi
(/usr/local/src/bash/bash-20240205/doc/fdl.texi
[181] [182] [183] [184] [185] [186] [187]) Appendix D [188] [189] [190]
[191] [192] [193] [194] [195] [196] [197] )
Here is how much of TeX's memory you used:
4104 strings out of 497086
47614 string characters out of 6206517
141909 words of memory out of 5000000
4869 multiletter control sequences out of 15000+600000
4105 strings out of 495840
47629 string characters out of 6171739
143202 words of memory out of 5000000
5048 multiletter control sequences out of 15000+600000
34315 words of font info for 116 fonts, out of 8000000 for 9000
51 hyphenation exceptions out of 8191
16i,6n,16p,389b,983s stack positions out of 5000i,500n,10000p,200000b,80000s
{/opt/local/share/texmf-texlive/font
s/enc/dvips/cm-super/cm-super-t1.enc}</opt/local/share/texmf-texlive/fonts/type
1/public/amsfonts/cm/cmbx12.pfb></opt/local/share/texmf-texlive/fonts/type1/pub
lic/amsfonts/cm/cmcsc10.pfb></opt/local/share/texmf-texlive/fonts/type1/public/
amsfonts/cm/cmmi10.pfb></opt/local/share/texmf-texlive/fonts/type1/public/amsfo
nts/cm/cmmi12.pfb></opt/local/share/texmf-texlive/fonts/type1/public/amsfonts/c
m/cmmi9.pfb></opt/local/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmr1
0.pfb></opt/local/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmr9.pfb><
/opt/local/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmsl10.pfb></opt/
local/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmsltt10.pfb></opt/loc
al/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmsy10.pfb></opt/local/sh
are/texmf-texlive/fonts/type1/public/amsfonts/cm/cmti10.pfb></opt/local/share/t
exmf-texlive/fonts/type1/public/amsfonts/cm/cmtt10.pfb></opt/local/share/texmf-
texlive/fonts/type1/public/amsfonts/cm/cmtt12.pfb></opt/local/share/texmf-texli
ve/fonts/type1/public/amsfonts/cm/cmtt9.pfb></opt/local/share/texmf-texlive/fon
ts/type1/public/cm-super/sfrm1095.pfb></opt/local/share/texmf-texlive/fonts/typ
e1/public/cm-super/sfrm1440.pfb>
Output written on bashref.pdf (203 pages, 816032 bytes).
701 hyphenation exceptions out of 8191
16i,6n,16p,389b,983s stack positions out of 10000i,1000n,20000p,200000b,200000s
</opt/local/share/texmf-texlive/font
s/type1/public/amsfonts/cm/cmbx12.pfb></opt/local/share/texmf-texlive/fonts/typ
e1/public/amsfonts/cm/cmcsc10.pfb></opt/local/share/texmf-texlive/fonts/type1/p
ublic/amsfonts/cm/cmmi10.pfb></opt/local/share/texmf-texlive/fonts/type1/public
/amsfonts/cm/cmmi12.pfb></opt/local/share/texmf-texlive/fonts/type1/public/amsf
onts/cm/cmmi9.pfb></opt/local/share/texmf-texlive/fonts/type1/public/amsfonts/c
m/cmr10.pfb></opt/local/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmr9
.pfb></opt/local/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmsl10.pfb>
</opt/local/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmsltt10.pfb></o
pt/local/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmsy10.pfb></opt/lo
cal/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmti10.pfb></opt/local/s
hare/texmf-texlive/fonts/type1/public/amsfonts/cm/cmtt10.pfb></opt/local/share/
texmf-texlive/fonts/type1/public/amsfonts/cm/cmtt12.pfb></opt/local/share/texmf
-texlive/fonts/type1/public/amsfonts/cm/cmtt9.pfb></opt/local/share/texmf-texli
ve/fonts/type1/public/cm-super/sfrm1095.pfb></opt/local/share/texmf-texlive/fon
ts/type1/public/cm-super/sfrm1440.pfb>
Output written on bashref.pdf (203 pages, 816864 bytes).
PDF statistics:
2830 PDF objects out of 2984 (max. 8388607)
2580 compressed objects within 26 object streams
BIN
View File
Binary file not shown.
+9 -7
View File
@@ -1999,8 +1999,6 @@ where @var{x} and @var{y} are either integers or letters,
and @var{incr}, an optional increment, is an integer.
When integers are supplied, the expression expands to each number between
@var{x} and @var{y}, inclusive.
Supplied integers may be prefixed with @samp{0} to force each term to have the
same width.
When either @var{x} or @var{y} begins with a zero, the shell
attempts to force all generated terms to contain the same number of digits,
zero-padding where necessary.
@@ -4313,10 +4311,12 @@ The expression is parsed and evaluated according to precedence
using the rules listed above.
@end table
If the shell is in @sc{posix} mode, or if the expression is part
of the @code{[[} command,
the @samp{<} and @samp{>} operators sort using the current locale.
If the shell is not in @sc{posix} mode,
when used with @code{test} or @samp{[}, the @samp{<} and @samp{>}
operators sort lexicographically using ASCII ordering.
If the shell is in @sc{posix} mode, these operators use the current locale.
the @code{test} and @samp{[} commands
sort lexicographically using ASCII ordering.
The historical operator-precedence parsing with 4 or more arguments can
lead to ambiguities when it encounters strings that look like primaries.
@@ -6771,9 +6771,11 @@ after reading any startup files.
@item HISTIGNORE
A colon-separated list of patterns used to decide which command
lines should be saved on the history list. Each pattern is
lines should be saved on the history list.
Each pattern is
anchored at the beginning of the line and must match the complete
line (no implicit @samp{*} is appended). Each pattern is tested
line (Bash will not implicitly append a @samp{*}).
Each pattern is tested
against the line after the checks specified by @env{HISTCONTROL}
are applied. In addition to the normal shell pattern matching
characters, @samp{&} matches the previous history line. @samp{&}
+638 -646
View File
File diff suppressed because it is too large Load Diff
+40 -22
View File
@@ -6,9 +6,9 @@
.\" Case Western Reserve University
.\" chet.ramey@case.edu
.\"
.\" Last Change: Fri Jan 19 11:53:57 EST 2024
.\" Last Change: Mon Feb 5 14:37:12 EST 2024
.\"
.TH HISTORY 3 "2024 January 19" "GNU History 8.3"
.TH HISTORY 3 "2024 February 5" "GNU History 8.3"
.\"
.\" File Name macro. This used to be `.PN', for Path Name,
.\" but Sun doesn't seem to like that very much.
@@ -18,7 +18,7 @@
..
.de Q
.ie \n(.g \(lq\\$1\(rq\\$2
.el \{
.el \{\
. if t ``\\$1''\\$2
. if n "\\$1"\\$2
.\}
@@ -53,7 +53,7 @@ history \- GNU History Library
Many programs read input from the user a line at a time. The GNU
History library is able to keep track of those lines, associate arbitrary
data with each line, and utilize information from previous lines in
composing new ones.
composing new ones.
.PP
.SH "HISTORY EXPANSION"
The history library supports a history expansion feature that
@@ -78,7 +78,7 @@ and the portions of that line that are acted upon are \fIwords\fP.
Various \fImodifiers\fP are available to manipulate the selected words.
The line is broken into words in the same fashion as \fBbash\fP
does when reading input,
so that several words that would otherwise be separated
so that several words that would otherwise be separated
are considered one word when surrounded by quotes (see the
description of \fBhistory_tokenize()\fP below).
.PP
@@ -118,7 +118,8 @@ Refer to the current command minus
.IR n .
.TP
.B !!
Refer to the previous command. This is a synonym for `!\-1'.
Refer to the previous command. This is a synonym for
.Q !\-1 .
.TP
.B !\fIstring\fR
Refer to the most recent command
@@ -182,15 +183,22 @@ The last word. This is usually the last argument, but will expand to the
zeroth word if there is only one word in the line.
.TP
.B %
The first word matched by the most recent `?\fIstring\fR?' search,
The first word matched by the most recent
.Q ?\fIstring\fR?
search,
if the search string begins with a character that is part of a word.
.TP
.I x\fB\-\fPy
A range of words; `\-\fIy\fR' abbreviates `0\-\fIy\fR'.
A range of words;
.Q \-\fIy\fR
abbreviates
.Q 0\-\fIy\fR .
.TP
.B *
All of the words but the zeroth. This is a synonym
for `\fI1\-$\fP'. It is not an error to use
All of the words but the zeroth.
This is a synonym for
.Q \fI1\-$\fP .
It is not an error to use
.B *
if there is just one
word in the event; the empty string is returned in that case.
@@ -207,7 +215,8 @@ If a word designator is supplied without an event specification, the
previous command is used as the event.
.SS Modifiers
After the optional word designator, there may appear a sequence of
one or more of the following modifiers, each preceded by a `:'.
one or more of the following modifiers, each preceded by a
.Q : .
These modify, or edit, the word or words selected from the history event.
.PP
.PD 0
@@ -279,17 +288,26 @@ is deleted.
Repeat the previous substitution.
.TP
.B g
Cause changes to be applied over the entire event line. This is
used in conjunction with `\fB:s\fP' (e.g., `\fB:gs/\fIold\fP/\fInew\fP/\fR')
or `\fB:&\fP'. If used with
`\fB:s\fP', any delimiter can be used
in place of /, and the final delimiter is optional
Cause changes to be applied over the entire event line.
This is used in conjunction with
.Q \fB:s\fP
(e.g.,
.Q \fB:gs/\fIold\fP/\fInew\fP/\fR )
or
.Q \fB:&\fP .
If used with
.Q \fB:s\fP ,
any delimiter can be used in place of /,
and the final delimiter is optional
if it is the last character of the event line.
An \fBa\fP may be used as a synonym for \fBg\fP.
.TP
.B G
Apply the following `\fBs\fP' or `\fB&\fP' modifier once to each word
in the event line.
Apply the following
.Q \fBs\fP
or
.Q \fB&\fP
modifier once to each word in the event line.
.PD
.SH "PROGRAMMING WITH HISTORY FUNCTIONS"
This section describes how to use the History library in other programs.
@@ -500,8 +518,8 @@ offset. The search is anchored: matching lines must begin with
\fIstring\fP. If \fIdirection\fP is less than 0, then the search is
through previous entries, otherwise through subsequent entries.
If \fIstring\fP is found, then the
current history index is set to that entry, and the return value is 0.
Otherwise, nothing is changed, and a -1 is returned.
current history index is set to that entry, and the return value is 0.
Otherwise, nothing is changed, and a -1 is returned.
.Fn3 int history_search_pos "const char *string" "int direction" "int pos"
Search for \fIstring\fP in the history list, starting at \fIpos\fP, an
@@ -632,7 +650,7 @@ This is disabled by default.
.Vb "char *" history_word_delimiters
The characters that separate tokens for \fBhistory_tokenize()\fP.
The default value is \fB"\ \et\en()<>;&|"\fP.
The default value is \fB\(dq\ \et\en()<>;&|\(dq\fP.
.Vb "char *" history_no_expand_chars
The list of characters which inhibit history expansion if found immediately
@@ -674,7 +692,7 @@ It is intended for use by applications like \fBbash\fP that use the history
expansion character for additional purposes.
By default, this variable is set to \fBNULL\fP.
.SH FILES
.PD 0
.PD 0
.TP
.FN \(ti/.history
Default filename for reading and writing saved history
+109 -78
View File
@@ -6,9 +6,9 @@
.\" Case Western Reserve University
.\" chet.ramey@case.edu
.\"
.\" Last Change: Thu Jan 18 11:05:44 EST 2024
.\" Last Change: Mon Feb 5 10:50:56 EST 2024
.\"
.TH READLINE 3 "2024 January 18" "GNU Readline 8.3"
.TH READLINE 3 "2024 February 5" "GNU Readline 8.3"
.\"
.\" File Name macro. This used to be `.PN', for Path Name,
.\" but Sun doesn't seem to like that very much.
@@ -18,7 +18,7 @@
..
.de Q
.ie \n(.g \(lq\\$1\(rq\\$2
.el \{
.el \{\
. if t ``\\$1''\\$2
. if n "\\$1"\\$2
.\}
@@ -49,7 +49,7 @@ readline \- get a line from a user with editing
will read a line from the terminal
and return it, using
.B prompt
as a prompt. If
as a prompt. If
.B prompt
is \fBNULL\fP or the empty string, no prompt is issued.
The line returned is allocated with
@@ -188,11 +188,13 @@ When using the form \fBkeyname\fP:\^\fIfunction-name\fP or \fImacro\fP,
is the name of a key spelled out in English. For example:
.PP
.RS
Control\-u: universal\-argument
.br
Meta\-Rubout: backward\-kill\-word
.br
Control\-o: "> output"
.EX
.nf
Control-u: universal\-argument
Meta-Rubout: backward\-kill\-word
Control-o: \(dq> output\(dq
.fi
.EE
.RE
.LP
In the above example,
@@ -209,7 +211,8 @@ expressed on the right hand side (that is, to insert the text
.Q "> output"
into the line).
.PP
In the second form, \fB"keyseq"\fP:\^\fIfunction\-name\fP or \fImacro\fP,
In the second form,
\fB\(dqkeyseq\(dq\fP:\^\fIfunction\-name\fP or \fImacro\fP,
.B keyseq
differs from
.B keyname
@@ -220,11 +223,13 @@ used, as in the following example, but the symbolic character names
are not recognized.
.PP
.RS
"\eC\-u": universal\-argument
.br
"\eC\-x\eC\-r": re\-read\-init\-file
.br
"\ee[11\(ti": "Function Key 1"
.EX
.nf
\(dq\eC\-u\(dq: universal\-argument
\(dq\eC\-x\eC\-r\(dq: re\-read\-init\-file
\(dq\ee[11\(ti\(dq: \(dqFunction Key 1\(dq
.fi
.EE
.RE
.PP
In this example,
@@ -256,11 +261,11 @@ an escape character
.B \e\e
backslash
.TP
.B \e"
literal ", a double quote
.B \e\(dq
literal \(dq, a double quote
.TP
.B \e'
literal ', a single quote
.B \e\(aq
literal \(aq, a single quote
.RE
.PD
.PP
@@ -308,7 +313,7 @@ be used to indicate a macro definition. Unquoted text
is assumed to be a function name.
In the macro body, the backslash escapes described above are expanded.
Backslash will quote any other character in the macro text,
including " and '.
including \(dq and \(aq.
.PP
.B Bash
allows the current readline key bindings to be displayed or modified
@@ -340,8 +345,12 @@ or
.B Off
(without regard to case).
Unrecognized variable names are ignored.
When a variable value is read, empty or null values, "on" (case-insensitive),
and "1" are equivalent to \fBOn\fP. All other values are equivalent to
When readline reads a variable value, empty or null values,
.Q "on"
(case-insensitive), and
.Q 1
are equivalent to \fBOn\fP.
All other values are equivalent to
\fBOff\fP.
The variables and their default values are:
.PP
@@ -358,7 +367,7 @@ This variable is reset to the default value whenever the terminal type changes.
The default value is the string that puts the terminal in standout mode,
as obtained from the terminal's terminfo description.
A sample value might be
.Q "\ee[01;33m" .
.Q \ee[01;33m .
.TP
.B active\-region\-end\-color
A string variable that
@@ -374,7 +383,7 @@ This variable is reset to the default value whenever the terminal type changes.
The default value is the string that restores the terminal from standout mode,
as obtained from the terminal's terminfo description.
A sample value might be
.Q "\ee[0m" .
.Q \ee[0m .
.TP
.B bell\-style (audible)
Controls what happens when readline wants to ring the terminal bell.
@@ -383,10 +392,9 @@ If set to \fBnone\fP, readline never rings the bell. If set to
If set to \fBaudible\fP, readline attempts to ring the terminal's bell.
.TP
.B bind\-tty\-special\-chars (On)
If set to \fBOn\fP (the default), readline attempts to bind the control
characters that are
treated specially by the kernel's terminal driver to their
readline equivalents.
If set to \fBOn\fP (the default), readline attempts to bind
the control characters that are treated specially by the kernel's
terminal driver to their readline equivalents.
These override the default readline bindings described here.
Type
.Q "stty -a"
@@ -412,9 +420,13 @@ If set to \fBOn\fP, readline displays possible completions using different
colors to indicate their file type.
The color definitions are taken from the value of the \fBLS_COLORS\fP
environment variable.
.\" Tucking multiple macro calls into a paragraph tag requires some
.\" finesse. We require `\c`, and while the single-font macros don't
.\" honor input trap continuation, the font alternation macros do.
.TP
.B comment\-begin (``#'')
The string that is inserted in \fBvi\fP mode when the
.BR comment\-begin\ (\c
.Q \fB#\fP \fB)\fP
The string that is inserted when the
.B insert\-comment
command is executed.
This command is bound to
@@ -430,7 +442,7 @@ The value is ignored if it is less than 0 or greater than the terminal
screen width.
A value of 0 will cause matches to be displayed one per line.
The default value is \-1.
.TP
.TP
.B completion\-ignore\-case (Off)
If set to \fBOn\fP, readline performs filename matching and completion
in a case\-insensitive fashion.
@@ -465,11 +477,11 @@ by stripping the eighth bit and prefixing it with an
escape character (in effect, using escape as the \fImeta prefix\fP).
The default is \fIOn\fP, but readline will set it to \fIOff\fP if the
locale contains eight-bit characters.
This variable is dependent on the \fBLC_CTYPE\fP locale category, and
This variable is dependent on the \fBLC_CTYPE\fP locale category, and
may change if the locale is changed.
.TP
.B disable\-completion (Off)
If set to \fBOn\fP, readline will inhibit word completion. Completion
If set to \fBOn\fP, readline will inhibit word completion. Completion
characters will be inserted into the line as if they had been
mapped to \fBself-insert\fP.
.TP
@@ -488,13 +500,13 @@ or
.BR vi .
.TP
.B emacs\-mode\-string (@)
If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
this string is displayed immediately before the last line of the primary
prompt when emacs editing mode is active. The value is expanded like a
key binding, so the standard set of meta- and control prefixes and
backslash escape sequences is available.
Use the \e1 and \e2 escapes to begin and end sequences of
non-printing characters, which can be used to embed a terminal control
non-printing characters, which can be used to embed a terminal control
sequence into the mode string.
.TP
.B enable\-active\-region (On)
@@ -532,8 +544,8 @@ If set to \fBOn\fP, tilde expansion is performed when readline
attempts word completion.
.TP
.B history\-preserve\-point (Off)
If set to \fBOn\fP, the history code attempts to place point at the
same location on each history line retrieved with \fBprevious-history\fP
If set to \fBOn\fP, the history code attempts to place point at the
same location on each history line retrieved with \fBprevious-history\fP
or \fBnext-history\fP.
.TP
.B history\-size (unset)
@@ -558,12 +570,13 @@ it will not clear the eighth bit in the characters it reads),
regardless of what the terminal claims it can support. The name
.B meta\-flag
is a synonym for this variable.
The default is \fIOff\fP, but readline will set it to \fIOn\fP if the
The default is \fIOff\fP, but readline will set it to \fIOn\fP if the
locale contains eight-bit characters.
This variable is dependent on the \fBLC_CTYPE\fP locale category, and
This variable is dependent on the \fBLC_CTYPE\fP locale category, and
may change if the locale is changed.
.TP
.B isearch\-terminators (``C\-[ C\-J'')
.BR isearch\-terminators\ (\c
.Q \fBC\-[C\-J\fP \fB)\fP
The string of characters that should terminate an incremental
search without subsequently executing the character as a command.
If this variable has not been given a value, the characters
@@ -584,7 +597,7 @@ also affects the default keymap.
.B keyseq\-timeout (500)
Specifies the duration \fIreadline\fP will wait for a character when reading an
ambiguous key sequence (one that can form a complete key sequence using
the input read so far, or can take additional input to complete a longer
the input read so far, or can take additional input to complete a longer
key sequence).
If no input is received within the timeout, \fIreadline\fP will use the shorter
but complete key sequence.
@@ -608,11 +621,13 @@ have a slash appended (subject to the value of
\fBmark\-directories\fP).
.TP
.B match\-hidden\-files (On)
This variable, when set to \fBOn\fP, causes readline to match files whose
names begin with a `.' (hidden files) when performing filename
completion.
If set to \fBOff\fP, the leading `.' must be
supplied by the user in the filename to be completed.
This variable, when set to \fBOn\fP, forces readline to match files whose
names begin with a
.Q .
(hidden files) when performing filename completion.
If set to \fBOff\fP, the user must include the leading
.Q .
in the filename to be completed.
.TP
.B menu\-complete\-display\-prefix (Off)
If set to \fBOn\fP, menu completion displays the common prefix of the
@@ -657,9 +672,9 @@ matches to be listed immediately instead of ringing the bell.
This alters the default behavior of the completion functions in
a fashion similar to \fBshow\-all\-if\-ambiguous\fP.
If set to
.BR On ,
.BR On ,
words which have more than one possible completion without any
possible partial completion (the possible completions don't share
possible partial completion (the possible completions don't share
a common prefix) cause the matches to be listed immediately instead
of ringing the bell.
.TP
@@ -677,7 +692,7 @@ after point in the word being completed, so portions of the word
following the cursor are not duplicated.
.TP
.B vi\-cmd\-mode\-string ((cmd))
If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
this string is displayed immediately before the last line of the primary
prompt when vi editing mode is active and in command mode.
The value is expanded like a
@@ -688,18 +703,18 @@ non-printing characters, which can be used to embed a terminal control
sequence into the mode string.
.TP
.B vi\-ins\-mode\-string ((ins))
If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
If the \fIshow\-mode\-in\-prompt\fP variable is enabled,
this string is displayed immediately before the last line of the primary
prompt when vi editing mode is active and in insertion mode.
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
key binding, so the standard set of meta- and control prefixes and
backslash escape sequences is available.
Use the \e1 and \e2 escapes to begin and end sequences of
non-printing characters, which can be used to embed a terminal control
non-printing characters, which can be used to embed a terminal control
sequence into the mode string.
.TP
.B visible\-stats (Off)
If set to \fBOn\fP, a character denoting a file's type as reported
If set to \fBOn\fP, a character denoting a file's type as reported
by \fIstat\fP(2) is appended to the filename when listing possible
completions.
.PD
@@ -708,7 +723,8 @@ 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 four parser directives used.
.IP \fB$if\fP
.TP
.B $if
The
.B $if
construct allows bindings to be made based on the
@@ -717,14 +733,16 @@ readline. The text of the test, after any comparison operator,
extends to the end of the line;
unless otherwise noted, no characters are required to isolate it.
.RS
.IP \fBmode\fP
.TP
.B mode
The \fBmode=\fP form of the \fB$if\fP directive is used to test
whether readline is in emacs or vi mode.
This may be used in conjunction
with the \fBset keymap\fP command, for instance, to set bindings in
the \fIemacs-standard\fP and \fIemacs-ctlx\fP keymaps only if
readline is starting out in emacs mode.
.IP \fBterm\fP
.TP
.B term
The \fBterm=\fP 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
@@ -737,7 +755,8 @@ to match both
and
.IR sun\-cmd ,
for instance.
.IP \fBversion\fP
.TP
.B version
The \fBversion\fP test may be used to perform comparisons against
specific readline versions.
The \fBversion\fP expands to the current readline version.
@@ -757,9 +776,11 @@ minor version (e.g., \fB7.1\fP). If the minor version is omitted, it
is assumed to be \fB0\fP.
The operator may be separated from the string \fBversion\fP
and from the version number argument by whitespace.
.IP \fBapplication\fP
The \fBapplication\fP construct is used to include
application-specific settings. Each program using the readline
.TP
.I application
The \fIapplication\fP construct is used to include
application-specific settings.
Each program using the readline
library sets the \fIapplication name\fP, and an initialization
file can test for a particular value.
This could be used to bind key sequences to functions useful for
@@ -767,14 +788,17 @@ a specific program. For instance, the following command adds a
key sequence that quotes the current or previous word in \fBbash\fP:
.PP
.RS
.EX
.nf
\fB$if\fP Bash
# Quote the current or previous word
"\eC-xq": "\eeb\e"\eef\e""
\(dq\eC-xq\(dq: \(dq\eeb\e\(dq\eef\e\(dq\(dq
\fB$endif\fP
.fi
.EE
.RE
.IP \fIvariable\fP
.TP
.I variable
The \fIvariable\fP construct provides simple equality tests for readline
variables and values.
The permitted comparison operators are \fI=\fP, \fI==\fP, and \fI!=\fP.
@@ -784,13 +808,16 @@ side by whitespace.
Both string and boolean variables may be tested. Boolean variables must be
tested against the values \fIon\fP and \fIoff\fP.
.RE
.IP \fB$endif\fP
.TP
.B $endif
This command, as seen in the previous example, terminates an
\fB$if\fP command.
.IP \fB$else\fP
.TP
.B $else
Commands in this branch of the \fB$if\fP directive are executed if
the test fails.
.IP \fB$include\fP
.TP
.B $include
This directive takes a single filename as an argument and reads commands
and bindings from that file. For example, the following directive
would read \fI/etc/inputrc\fP:
@@ -798,7 +825,7 @@ would read \fI/etc/inputrc\fP:
.PP
.nf
\fB$include\fP \^ \fI/etc/inputrc\fP
.fi
.fi
.RE
.SH SEARCHING
Readline provides commands for searching through the command history
@@ -940,12 +967,16 @@ and make it the current line.
Without an argument, move back to the first entry in the history list.
.TP
.B reverse\-search\-history (C\-r)
Search backward starting at the current line and moving `up' through
the history as necessary. This is an incremental search.
Search backward starting at the current line and moving
.Q up
through the history as necessary.
This is an incremental search.
.TP
.B forward\-search\-history (C\-s)
Search forward starting at the current line and moving `down' through
the history as necessary. This is an incremental search.
Search forward starting at the current line and moving
.Q down
through the history as necessary.
This is an incremental search.
.TP
.B non\-incremental\-reverse\-search\-history (M\-p)
Search backward through the history starting at the current line
@@ -1032,7 +1063,7 @@ commonly is, see above for the effects.
Delete the character behind the cursor. When given a numeric argument,
save the deleted text on the kill ring.
.TP
.B forward\-backward\-delete\-char
.B forward\-backward\-delete\-char
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
deleted.
@@ -1044,7 +1075,7 @@ how to insert characters like \fBC\-q\fP, for example.
.B tab\-insert (M-TAB)
Insert a tab character.
.TP
.B self\-insert (a,\ b,\ A,\ 1,\ !,\ ...)
.B "self\-insert (a, b, A, 1, !, \fR.\|.\|.\fP)"
Insert the character typed.
.TP
.B transpose\-chars (C\-t)
@@ -1148,7 +1179,7 @@ or
.SS Numeric Arguments
.PD 0
.TP
.B digit\-argument (M\-0, M\-1, ..., M\-\-)
.B digit\-argument (M\-0, M\-1, \fR.\|.\|.\fP, M\-\-)
Add this digit to the argument already accumulating, or start a new
argument. M\-\- starts a negative argument.
.TP
@@ -1206,7 +1237,7 @@ At the end of the list of completions, the bell is rung
(subject to the setting of \fBbell\-style\fP)
and the original text is restored.
An argument of \fIn\fP moves \fIn\fP positions forward in the list
of matches; a negative argument may be used to move backward
of matches; a negative argument may be used to move backward
through the list.
This command is intended to be bound to \fBTAB\fP, but is unbound
by default.
@@ -1252,7 +1283,7 @@ Abort the current editing command and
ring the terminal's bell (subject to the setting of
.BR bell\-style ).
.TP
.B do\-lowercase\-version (M\-A, M\-B, M\-\fIx\fP, ...)
.B do\-lowercase\-version (M\-A, M\-B, M\-\fIx\fP, \fR.\|.\|.\fP)
If the metafied character \fIx\fP is uppercase, run the command
that is bound to the corresponding metafied lowercase character.
The behavior is undefined if \fIx\fP is already lowercase.
@@ -1308,8 +1339,8 @@ Without a numeric argument, the value of the readline
.B comment\-begin
variable is inserted at the beginning of the current line.
If a numeric argument is supplied, this command acts as a toggle: if
the characters at the beginning of the line do not match the value
of \fBcomment\-begin\fP, the value is inserted, otherwise
the characters at the beginning of the line do not match the value
of \fBcomment\-begin\fP, the value is inserted, otherwise
the characters in \fBcomment-begin\fP are deleted from the beginning of
the line.
In either case, the line is accepted as if a newline had been typed.
+7 -6
View File
@@ -405,11 +405,12 @@ set editing-mode vi
@end example
Variable names and values, where appropriate, are recognized without regard
to case. Unrecognized variable names are ignored.
to case.
Unrecognized variable names are ignored.
Boolean variables (those that can be set to on or off) are set to on if
the value is null or empty, @var{on} (case-insensitive), or 1. Any other
value results in the variable being set to off.
the value is null or empty, @var{on} (case-insensitive), or 1.
Any other value results in the variable being set to off.
@ifset BashFeatures
The @w{@code{bind -V}} command lists the current Readline variable names
@@ -723,11 +724,11 @@ The default is @samp{off}.
@item match-hidden-files
@vindex match-hidden-files
This variable, when set to @samp{on}, causes Readline to match files whose
This variable, when set to @samp{on}, forces Readline to match files whose
names begin with a @samp{.} (hidden files) when performing filename
completion.
If set to @samp{off}, the leading @samp{.} must be
supplied by the user in the filename to be completed.
If set to @samp{off}, the user must include the leading @samp{.}
in the filename to be completed.
This variable is @samp{on} by default.
@item menu-complete-display-prefix