pmodules/bash
0
0
Fork 0
mirror of https://https.git.savannah.gnu.org/git/bash.git synced 2026-07-02 09:50:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

documentation updates

Browse Source
This commit is contained in:
Chet Ramey
2022-09-20 10:16:23 -04:00
parent b7b9d7c306
commit e9c75143a2
33 changed files with 1400 additions and 1716 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/readline/doc/hsuser.texi
+5 -5
View File
@@ -246,10 +246,10 @@ the history list as a single entry.
@end table
When any of the @option{-w}, @option{-r}, @option{-a}, or @option{-n} options is
used, if @var{filename}
is given, then it is used as the history file. If not, then
the value of the @env{HISTFILE} variable is used.
If a @var{filename} argument is supplied
when any of the @option{-w}, @option{-r}, @option{-a}, or @option{-n} options
is used, Bash uses @var{filename} as the history file.
If not, then the value of the @env{HISTFILE} variable is used.
The return value is 0 unless an invalid option is encountered, an
error occurs while reading or writing the history file, an invalid
@@ -513,7 +513,7 @@ substituted, or, if no previous history substitutions took place,
the last @var{string}
in a !?@var{string}@code{[?]}
search.
If @var{new} is is null, each matching @var{old} is deleted.
If @var{new} is null, each matching @var{old} is deleted.
The final delimiter is optional if it is the last
character on the input line.
lib/readline/doc/readline.3
+8 -8
View File
@@ -6,9 +6,9 @@
.\" Case Western Reserve University
.\" chet.ramey@case.edu
.\"
.\" Last Change: Fri Aug 12 11:12:23 EDT 2022
.\" Last Change: Mon Sep 19 11:11:22 EDT 2022
.\"
.TH READLINE 3 "2022 August 12" "GNU Readline 8.2"
.TH READLINE 3 "2022 September 19" "GNU Readline 8.2"
.\"
.\" File Name macro. This used to be `.PN', for Path Name,
.\" but Sun doesn't seem to like that very much.
@@ -850,14 +850,14 @@ composed of alphanumeric characters (letters and digits).
.B previous\-screen\-line
Attempt to move point to the same physical screen column on the previous
physical screen line. This will not have the desired effect if the current
Readline line does not take up more than one physical line or if point is not
readline line does not take up more than one physical line or if point is not
greater than the length of the prompt plus the screen width.
.TP
.B next\-screen\-line
Attempt to move point to the same physical screen column on the next
physical screen line. This will not have the desired effect if the current
Readline line does not take up more than one physical line or if the length
of the current Readline line is not greater than the length of the prompt
readline line does not take up more than one physical line or if the length
of the current readline line is not greater than the length of the prompt
plus the screen width.
.TP
.B clear\-display (M\-C\-l)
@@ -990,7 +990,7 @@ The character indicating end-of-file as set, for example, by
.if t \f(CWstty\fP.
.if n ``stty''.
If this character is read when there are no characters
on the line, and point is at the beginning of the line, Readline
on the line, and point is at the beginning of the line, readline
interprets it as the end of input and returns
.SM
.BR EOF .
@@ -1259,11 +1259,11 @@ the saved position, and the old cursor position is saved as the mark.
.TP
.B character\-search (C\-])
A character is read and point is moved to the next occurrence of that
character. A negative count searches for previous occurrences.
character. A negative argument searches for previous occurrences.
.TP
.B character\-search\-backward (M\-C\-])
A character is read and point is moved to the previous occurrence of that
character. A negative count searches for subsequent occurrences.
character. A negative argument searches for subsequent occurrences.
.TP
.B skip\-csi\-sequence
Read enough characters to consume a multi-key sequence such as those
lib/readline/doc/rltech.texi
+13 -13
View File
@@ -393,7 +393,7 @@ value 0x0402.
@end deftypevar
@deftypevar {int} rl_gnu_readline_p
Always set to 1, denoting that this is @sc{gnu} readline rather than some
Always set to 1, denoting that this is @sc{gnu} Readline rather than some
emulation.
@end deftypevar
@@ -515,7 +515,7 @@ By default, this is set to @code{rl_deprep_terminal}
@deftypevar {Keymap} rl_executing_keymap
This variable is set to the keymap (@pxref{Keymaps}) in which the
currently executing readline function was found.
currently executing Readline function was found.
@end deftypevar
@deftypevar {Keymap} rl_binding_keymap
@@ -916,7 +916,7 @@ invoke @var{function} in the keymap @var{map}.
@end deftypefun
@deftypefun void rl_function_dumper (int readable)
Print the readline function names and the key sequences currently
Print the Readline function names and the key sequences currently
bound to them to @code{rl_outstream}. If @var{readable} is non-zero,
the list is formatted in such a way that it can be made part of an
@code{inputrc} file and re-read.
@@ -1358,7 +1358,7 @@ that it can be made part of an @code{inputrc} file and re-read.
@deftypefun int rl_variable_bind (const char *variable, const char *value)
Make the Readline variable @var{variable} have @var{value}.
This behaves as if the readline command
This behaves as if the Readline command
@samp{set @var{variable} @var{value}} had been executed in an @code{inputrc}
file (@pxref{Readline Init File Syntax}).
@end deftypefun
@@ -1369,7 +1369,7 @@ For boolean variables, this string is either @samp{on} or @samp{off}.
@end deftypefun
@deftypefun void rl_variable_dumper (int readable)
Print the readline variable names and their current values
Print the Readline variable names and their current values
to @code{rl_outstream}.
If @var{readable} is non-zero, the list is formatted in such a way
that it can be made part of an @code{inputrc} file and re-read.
@@ -1400,7 +1400,7 @@ Readline saves in the history list.
Enable an @emph{active} mark.
When this is enabled, the text between point and mark (the @var{region}) is
displayed in the terminal's standout mode (a @var{face}).
This is called by various readline functions that set the mark and insert
This is called by various Readline functions that set the mark and insert
text, and is available for applications to call.
@end deftypefun
@@ -1409,10 +1409,10 @@ Turn off the active mark.
@end deftypefun
@deftypefun {void} rl_keep_mark_active (void)
Indicate that the mark should remain active when the current readline function
completes and after redisplay occurs.
Indicate that the mark should remain active when the current Readline
function completes and after redisplay occurs.
In most cases, the mark remains active for only the duration of a single
bindable readline function.
bindable Readline function.
@end deftypefun
@deftypefun {int} rl_mark_active_p (void)
@@ -1425,12 +1425,12 @@ Return a non-zero value if the mark is currently active; zero otherwise.
An alternate interface is available to plain @code{readline()}. Some
applications need to interleave keyboard I/O with file, device, or
window system I/O, typically by using a main loop to @code{select()}
on various file descriptors. To accommodate this need, readline can
on various file descriptors. To accommodate this need, Readline can
also be invoked as a `callback' function from an event loop. There
are functions available to make this easy.
@deftypefun void rl_callback_handler_install (const char *prompt, rl_vcpfunc_t *lhandler)
Set up the terminal for readline I/O and display the initial
Set up the terminal for Readline I/O and display the initial
expanded value of @var{prompt}. Save the value of @var{lhandler} to
use as a handler function to call when a complete line of input has been
entered.
@@ -1815,7 +1815,7 @@ a @code{SIGWINCH}.
@deftypefun void rl_echo_signal_char (int sig)
If an application wishes to install its own signal handlers, but still
have readline display characters that generate signals, calling this
have Readline display characters that generate signals, calling this
function with @var{sig} set to @code{SIGINT}, @code{SIGQUIT}, or
@code{SIGTSTP} will display the character generating that signal.
@end deftypefun
@@ -2213,7 +2213,7 @@ shell variables and hostnames.
@deftypevar int rl_completion_query_items
Up to this many items will be displayed in response to a
possible-completions call. After that, readline asks the user for
possible-completions call. After that, Readline asks the user for
confirmation before displaying them.
The default value is 100. A negative value
indicates that Readline should never ask for confirmation.
lib/readline/doc/rluser.texi
+11 -11
View File
@@ -179,7 +179,7 @@ empty line.
@end table
@noindent
(Depending on your configuration, the @key{Backspace} key be set to
(Depending on your configuration, the @key{Backspace} key might be set to
delete the character to the left of the cursor and the @key{DEL} key set
to delete the character underneath the cursor, like @kbd{C-d}, rather
than the character to the left of the cursor.)
@@ -246,7 +246,7 @@ words, to the end of the next word.
Word boundaries are the same as those used by @kbd{M-f}.
@item M-@key{DEL}
Kill from the cursor the start of the current word, or, if between
Kill from the cursor to the start of the current word, or, if between
words, to the start of the previous word.
Word boundaries are the same as those used by @kbd{M-b}.
@@ -552,7 +552,7 @@ been mapped to @code{self-insert}. The default is @samp{off}.
@item echo-control-characters
@vindex echo-control-characters
When set to @samp{on}, on operating systems that indicate they support it,
readline echoes a character corresponding to a signal generated from the
Readline echoes a character corresponding to a signal generated from the
keyboard. The default is @samp{on}.
@item editing-mode
@@ -755,7 +755,7 @@ The default is @samp{off}.
If set to @samp{on}, Readline will undo all changes to history lines
before returning when @code{accept-line} is executed. By default,
history lines may be modified and retain individual undo lists across
calls to @code{readline}. The default is @samp{off}.
calls to @code{readline()}. The default is @samp{off}.
@item show-all-if-ambiguous
@vindex show-all-if-ambiguous
@@ -787,7 +787,7 @@ The default value is @samp{off}.
@vindex skip-completed-text
If set to @samp{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
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.
@@ -847,7 +847,7 @@ interpreted as part of the key name.
The name of the key can be expressed in different ways, depending on
what you find most comfortable.
In addition to command names, readline allows keys to be bound
In addition to command names, Readline allows keys to be bound
to a string that is inserted when the key is pressed (a @var{macro}).
@ifset BashFeatures
@@ -1728,7 +1728,7 @@ Re-execute the last keyboard macro defined, by making the characters
in the macro appear as if typed at the keyboard.
@item print-last-kbd-macro ()
Print the last keboard macro defined in a format suitable for the
Print the last keyboard macro defined in a format suitable for the
@var{inputrc} file.
@end ftable
@@ -1781,11 +1781,11 @@ the saved position, and the old cursor position is saved as the mark.
@item character-search (C-])
A character is read and point is moved to the next occurrence of that
character. A negative count searches for previous occurrences.
character. A negative argument searches for previous occurrences.
@item character-search-backward (M-C-])
A character is read and point is moved to the previous occurrence
of that character. A negative count searches for subsequent
of that character. A negative argument searches for subsequent
occurrences.
@item skip-csi-sequence ()
@@ -1793,7 +1793,7 @@ 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
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-[.
@@ -2467,7 +2467,7 @@ via @var{CDPATH}: Readline can't tell those completions are directories).
The @option{-o nospace} option tells Readline to not append a space
character to the directory name, in case we want to append to it.
The @option{-o bashdefault} option brings in the rest of the "Bash default"
completions -- possible completion that Bash adds to the default Readline
completions -- possible completions that Bash adds to the default Readline
set. These include things like command name completion, variable completion
for words beginning with @samp{$} or @samp{$@{}, completions containing pathname
expansion patterns (@pxref{Filename Expansion}), and so on.
lib/readline/doc/version.texi
+3 -3
View File
@@ -5,7 +5,7 @@ Copyright (C) 1988-2022 Free Software Foundation, Inc.
@set EDITION 8.2
@set VERSION 8.2
@set UPDATED 12 August 2022
@set UPDATED-MONTH August 2022
@set UPDATED 19 September 2022
@set UPDATED-MONTH September 2022
@set LASTCHANGE Fri Aug 12 11:10:50 EDT 2022
@set LASTCHANGE Mon Sep 19 11:15:16 EDT 2022