documentation updates; test suite updates to reduce extraneous diff output; don't export BASHOPTS into running tests

This commit is contained in:
Chet Ramey
2025-01-09 16:13:16 -05:00
parent 5114e17172
commit 2ea356081d
35 changed files with 4139 additions and 3415 deletions
+4 -3
View File
@@ -6,9 +6,9 @@
.\" Case Western Reserve University
.\" chet.ramey@case.edu
.\"
.\" Last Change: Fri Nov 29 18:17:58 EST 2024
.\" Last Change: Tue Dec 31 13:35:52 EST 2024
.\"
.TH HISTORY 3 "2024 November 29" "GNU History 8.3"
.TH HISTORY 3 "2024 December 31" "GNU History 8.3"
.\"
.ie \n(.g \{\
.ds ' \(aq
@@ -495,7 +495,8 @@ The history list will contain only \fImax\fP entries at a time.
.F1 int unstifle_history "void"
Stop stifling the history. This returns the previously-set
maximum number of history entries (as set by \fBstifle_history()\fP).
history was stifled. The value is positive if the history was
history was stifled.
The value is positive if the history was
stifled, negative if it wasn't.
.PP
.F1 int history_is_stifled "void"
+1 -1
View File
@@ -36,7 +36,7 @@ For information on the interactive use of @sc{gnu} History,
* Introduction to History:: What is the GNU History library for?
* History Storage:: How information is stored.
* History Functions:: Functions that you can use.
* History Variables:: Variables that control behaviour.
* History Variables:: Variables that control behavior.
* History Programming Example:: Example of using the GNU History Library.
@end menu
+4 -4
View File
@@ -6,9 +6,9 @@
.\" Case Western Reserve University
.\" chet.ramey@case.edu
.\"
.\" Last Change: Fri Nov 29 18:17:27 EST 2024
.\" Last Change: Mon Dec 30 11:27:47 EST 2024
.\"
.TH READLINE 3 "2024 November 29" "GNU Readline 8.3"
.TH READLINE 3 "2024 December 30" "GNU Readline 8.3"
.\"
.ie \n(.g \{\
.ds ' \(aq
@@ -1248,7 +1248,7 @@ Negative arguments have no effect.
.TP
.B transpose\-words (M\-t)
Drag the word before point past the word after point,
moving point over that word as well.
moving point past that word as well.
If point is at the end of the line, this transposes
the last two words on the line.
.TP
@@ -1438,7 +1438,7 @@ the number of matches \fIN\fP;
the word being completed;
.IP \(bu
\fIS\fP:\fIE\fP,
where S and E are the start and end offsets of the word
where \fIS\fP and \fIE\fP are the start and end offsets of the word
in the \fBreadline\fP line buffer; then
.IP \(bu
each match, one per line
+4 -4
View File
@@ -58,7 +58,7 @@ in your own programs, this section is for you.
Many programs provide a command line interface, such as @code{mail},
@code{ftp}, and @code{sh}.
For such programs, the default behaviour of Readline is sufficient.
For such programs, the default behavior of Readline is sufficient.
This section describes how to use Readline in
the simplest way possible, perhaps to replace calls in your code to
@code{fgets()}.
@@ -149,7 +149,7 @@ rl_gets ()
@}
@end example
This function gives the user the default behaviour of @key{TAB}
This function gives the user the default behavior of @key{TAB}
completion: filename completion.
If you do not want Readline to
complete filenames, you can change the binding of the @key{TAB} key
@@ -768,7 +768,7 @@ The caller should free @var{keymap}.
@deftypefun void rl_free_keymap (Keymap keymap)
Free all storage associated with @var{keymap}.
This calls @code{rl_discard_keymap} to free subordindate
This calls @code{rl_discard_keymap} to free subordinate
keymaps and macros.
@end deftypefun
@@ -1168,7 +1168,7 @@ displaying a new message in the message area with @code{rl_message()}.
@deftypefun void rl_restore_prompt (void)
Restore the local Readline prompt display state saved by the most
recent call to @code{rl_save_prompt}.
if you called @code{rl_save_prompt} to save the prompt before a call
If you called @code{rl_save_prompt} to save the prompt before a call
to @code{rl_message}, you should call this function before the
corresponding call to @code{rl_clear_message}.
@end deftypefun
+14 -10
View File
@@ -466,9 +466,10 @@ A sample value might be @samp{\e[01;33m}.
@item active-region-end-color
@vindex active-region-end-color
A string variable that "undoes" the effects of @code{active-region-start-color}
and restores "normal" terminal display appearance after displaying text
in the active region.
A string variable that ``undoes''
the effects of @code{active-region-start-color}
and restores ``normal''
terminal display appearance after displaying text in the active region.
This string must not take up any physical character positions on the display,
so it should consist only of terminal escape sequences.
It is output to the terminal after displaying the text in the active region.
@@ -703,7 +704,7 @@ are saved.
If set to a value less than zero, the number of history entries is not
limited.
@ifset BashFeatures
By default, Bash sets the the maximum number of history entries to
By default, Bash sets the maximum number of history entries to
the value of the @code{HISTSIZE} shell variable.
@end ifset
@ifclear BashFeatures
@@ -1055,7 +1056,7 @@ The eight-bit character whose value is the hexadecimal value @var{HH}
When entering the text of a macro, single or double quotes must
be used to indicate a macro definition.
Unquoted text is assumed to be a function name.
Tthe backslash escapes described above are expanded
The backslash escapes described above are expanded
in the macro body.
Backslash will quote any other character in the macro text,
including @samp{"} and @samp{'}.
@@ -1188,7 +1189,7 @@ binding, variable assignment, and conditional syntax.
@example
@page
# This file controls the behaviour of line input editing for
# This file controls the behavior of line input editing for
# programs that use the GNU Readline library. Existing
# programs include FTP, Bash, and GDB.
#
@@ -1316,10 +1317,13 @@ In the following descriptions, @dfn{point} refers to the current cursor
position, and @dfn{mark} refers to a cursor position saved by the
@code{set-mark} command.
The text between the point and mark is referred to as the @dfn{region}.
Readline has the concept of an @emph{active region}:
Readline
has the concept of an @emph{active region}:
when the region is active,
Readline redisplay highlights the region using the
value of the @code{active-region-start-color} variable.
value of the
@code{active-region-start-color}
variable.
The @code{enable-active-region} variable turns this on and off.
Several commands set the region to active; those are noted below.
@@ -1806,7 +1810,7 @@ the number of matches @var{N};
the word being completed;
@item
@var{S}:@var{E},
where S and E are the start and end offsets of the word
where @var{S} and @var{E} are the start and end offsets of the word
in the Readline line buffer; then
@item
each match, one per line
@@ -2057,7 +2061,7 @@ Expand the line by performing shell word expansions.
This performs alias and history expansion,
$'@var{string}' and $"@var{string}" quoting,
tilde expansion, parameter and variable expansion, arithmetic expansion,
command and proces substitution,
command and process substitution,
word splitting, and quote removal.
An explicit argument suppresses command and process substitution.
+3 -3
View File
@@ -5,7 +5,7 @@ Copyright (C) 1988-2024 Free Software Foundation, Inc.
@set EDITION 8.3
@set VERSION 8.3
@set UPDATED 29 November 2024
@set UPDATED-MONTH November 2024
@set UPDATED 30 December 2024
@set UPDATED-MONTH December 2024
@set LASTCHANGE Fri Nov 29 18:18:20 EST 2024
@set LASTCHANGE Mon Dec 30 11:27:03 EST 2024