[PATCH 03/25 v2] doc/bash.1: Clarify program/man page reference.

[G. Branden Robinson]

At 2024-11-22T07:09:27-0500, Greg Wooledge wrote:
> On Thu, Nov 21, 2024 at 22:19:13 -0600, G. Branden Robinson wrote:
> > diff --git a/doc/bash.1 b/doc/bash.1
> > index 23a8dbd6..6c864eab 100644
> > --- a/doc/bash.1
> > +++ b/doc/bash.1
> > @@ -6962,7 +6962,8 @@ .SS "Readline Variables"
> >  its value may change if the locale changes.
> >  .TP
> >  .B page\-completions (On)
> > -If set to \fBOn\fP, \fBreadline\fP uses an internal \fImore\fP-like pager
> > +If set to \fBOn\fP, \fBreadline\fP uses an internal
> > +.BR more (1)-like
> >  to display a screenful of possible completions at a time.
> >  .TP
> >  .B prefer\-visible\-bell
> 
> You dropped the word "pager" from the changed text.

Thanks, Greg.

Here's a fix that also syncs it up with readline(3) and the Readline
Texinfo manual.

commit f5c3470b76b7e6b3d46a9d9d8f8a9163299664b8
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Sun Nov 10 14:18:04 2024 -0600

    doc/bash.1: Clarify program/man page reference.
    
    This way the novice is less likely to think the plain English word
    "more" is meant here.
    
    * lib/readline/doc/readline.3:
    * lib/readline/doc/rluser.texi: Parallelize.

diff --git a/doc/bash.1 b/doc/bash.1
index 23a8dbd6..efd11b2e 100644
--- a/doc/bash.1
+++ b/doc/bash.1
@@ -6962,8 +6962,9 @@ .SS "Readline Variables"
 its value may change if the locale changes.
 .TP
 .B page\-completions (On)
-If set to \fBOn\fP, \fBreadline\fP uses an internal \fImore\fP-like pager
-to display a screenful of possible completions at a time.
+If set to \fBOn\fP, \fBreadline\fP uses an internal
+.BR more (1)-like
+pager to display a screenful of possible completions at a time.
 .TP
 .B prefer\-visible\-bell
 See \fBbell\-style\fP.
diff --git a/lib/readline/doc/readline.3 b/lib/readline/doc/readline.3
index 7b7dc9d2..748a1720 100644
--- a/lib/readline/doc/readline.3
+++ b/lib/readline/doc/readline.3
@@ -739,8 +739,9 @@ .SS Variables
 its value may change if the locale changes.
 .TP
 .B page\-completions (On)
-If set to \fBOn\fP, \fBreadline\fP uses an internal \fImore\fP-like pager
-to display a screenful of possible completions at a time.
+If set to \fBOn\fP, \fBreadline\fP uses an internal
+.BR more (1)-like
+pager to display a screenful of possible completions at a time.
 .TP
 .B prefer\-visible\-bell
 See \fBbell\-style\fP.
diff --git a/lib/readline/doc/rluser.texi b/lib/readline/doc/rluser.texi
index caab87d4..ff5b9448 100644
--- a/lib/readline/doc/rluser.texi
+++ b/lib/readline/doc/rluser.texi
@@ -818,9 +818,9 @@
 
 @item page-completions
 @vindex page-completions
-If set to @samp{on}, Readline uses an internal @code{more}-like pager
-to display a screenful of possible completions at a time.
-This variable is @samp{on} by default.
+If set to @samp{on}, Readline uses an internal
+@cite{more@r{(1)}}-like
+pager to display a screenful of possible completions at a time.
 
 @item prefer-visible-bell
 See @code{bell-style}.

Regards,
Branden

more.diff
Description: Text Data

signature.asc
Description: PGP signature