[PATCH 05/43] man/curs_scroll.3x: Fix content error and style nits.

[G. Branden Robinson]

Content:
* Fix backwards claim.  In ncurses, the scrolling functions do not alter
  the blank character's attributes or color pair identifier.  See
  example program below.

Style:
* Parallelize advice to wide-character API users with other recently
  edited ncurses man pages.
* Describe `wscrl()` elemental function in its own right; delegate
  explanation of the `scrl()` variant to ncurses(3x) as usual.
* Favor active voice over passive.
* Favor present tense over future.
* Favor "better" optimization over "smarter".
* Tighten wording.
---
 man/curs_scroll.3x | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

diff --git a/man/curs_scroll.3x b/man/curs_scroll.3x
index 6dee97c50..96301df9a 100644
--- a/man/curs_scroll.3x
+++ b/man/curs_scroll.3x
@@ -68,7 +68,8 @@ .SH DESCRIPTION
 .IR i "\-1."
 The text of the top line in the window disappears and the bottom line
 is populated with blank characters;
-see \fB\%bkgd\fP(3X) or \fB\%bkgrnd\fP(3X).
+see \fB\%bkgd\fP(3X)
+(wide-character API users: \fB\%bkgrnd\fP(3X)).
 As an optimization,
 if the scrolling region of the window is the entire screen,
 the physical screen may be scrolled at the same time;
@@ -77,9 +78,9 @@ .SH DESCRIPTION
 .B \%scrl
 and
 .B \%wscrl
-scroll
-.B \%stdscr
-or the specified window up or down depending on the sign of
+scrolls the specified window
+.I win
+up or down per the sign of
 .IR n "."
 .bP
 For positive
@@ -97,6 +98,9 @@ .SH DESCRIPTION
 becomes
 .I i
 (scrolling down).
+\fB\%ncurses\fP(3X) describes the
+.B \%scrl
+variant of this function.
 .PP
 The cursor does not move.
 These functions perform no operation unless scrolling is enabled for the
@@ -147,16 +151,17 @@ .SH PORTABILITY
 if the scroll region is the entire screen \*(``is\*('' performed,
 not \*(``may be\*('' performed.
 .I \%ncurses
-deliberately does not guarantee that this will occur,
-to leave open the possibility of smarter optimization of multiple scroll
+deliberately does not guarantee that this occurs,
+to leave open the possibility of better optimization of multiple scroll
 actions on the next update.
 .PP
 Neither SVr4
 .I curses
-nor X/Open Curses specify whether the current attribute or current color
-pair of blanks generated by the scroll function are zeroed.
-.I \%ncurses
-does so.
+nor X/Open Curses specify whether these functions zero the attributes or
+color pair identifier of the blank character.
+In
+.IR \%ncurses ","
+they do not.
 .SH SEE ALSO
 \fB\%curses\fP(3X),
 \fB\%curs_outopts\fP(3X)
-- 
2.30.2

signature.asc
Description: PGP signature