[PATCH 26/43] man/curs_outopts.3x: Revise "PORTABILITY" section.

[G. Branden Robinson]

Content:
* Promote mentions of "wrefresh" and "curs_set" to man page cross
  references.

Style:
* Align wording of "X/Open Curses, Issue 4" specification status with
  other recently edited ncurses man pages.
* Set multi-word inline function call example in quotation marks, for
  clarity when font styling is stripped.
* Set ellipsis in multi-word inline function call example in roman, not
  bold.
* Set "curses" in italics, not roman.
* Prevent break within "System V".
* Tighten wording.

Markup:
* Define and use `` and '' strings for typographer's quotation marks.
* Spell ellipsis better for typesetting scenarios.  See
  groff_man_style(7).
* Favor man(7) font style macros over *roff font selection escape
  sequences, except for man page cross references (because
  man/make_sed.sh recognizes only certain patterns when rewriting such
  cross references) and terms in the "NAME" section (because the
  generated edit_man.sh script expects font selection escape sequences
  when scraping terms thence to gather names for man page aliases).
---
 man/curs_outopts.3x | 59 ++++++++++++++++++++++++++++++++++-----------
 1 file changed, 45 insertions(+), 14 deletions(-)

diff --git a/man/curs_outopts.3x b/man/curs_outopts.3x
index a441160a9..7ac39fcae 100644
--- a/man/curs_outopts.3x
+++ b/man/curs_outopts.3x
@@ -29,6 +29,17 @@
 .\"
 .\" $Id: curs_outopts.3x,v 1.69 2024/07/27 19:55:45 tom Exp $
 .TH curs_outopts 3X 2024-07-27 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" 
"Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
+.
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
@@ -166,25 +177,45 @@ .SH NOTES
 The \fBimmedok\fP routine is useful for windows that are used as terminal
 emulators.
 .SH PORTABILITY
-These functions are described in X/Open Curses, Issue 4.
+X/Open Curses,
+Issue 4 describes these functions.
 It specifies no error conditions for them.
 .PP
-Some historic curses implementations had, as an undocumented feature, the
-ability to do the equivalent of \fBclearok(..., 1)\fP by saying
-\fBtouchwin(stdscr)\fP or \fBclear(stdscr)\fP.
-This will not work under \fI\%ncurses\fP.
+Some historic
+.I curses
+implementations,
+as an undocumented feature,
+did the equivalent of
+.RB \*(`` \%clearok( .\|.\|. ", 1)" \*(''
+when
+.B \%touchwin(stdstr)
+or
+.B \%clear(stdstr)
+were used.
+This trick does not work with
+.IR \%ncurses .
 .PP
-Earlier System V curses implementations specified that with \fBscrollok\fP
-enabled, any window modification triggering a scroll also forced a physical
-refresh.
-X/Open Curses does not require this, and \fI\%ncurses\fP avoids doing
-it to perform better vertical-motion optimization at \fBwrefresh\fP
-time.
+Early System\ V
+.I curses
+implementations specified that with
+.B \%scrollok
+enabled,
+any window modification triggering a scroll
+also forced a physical refresh.
+X/Open Curses does not require this,
+and
+.I \%ncurses
+avoids doing so to better optimize vertical motions upon a
+\fB\%wrefresh\fP(3X).
 .PP
 X/Open Curses does not mention that the cursor should be
-made invisible as a side-effect of \fBleaveok\fP.
-SVr4 curses documentation does this, but the code does not.
-Use \fBcurs_set\fP to make the cursor invisible.
+made invisible as a side-effect of
+.BR \%leaveok .
+SVr4
+.I curses
+documentation notes this,
+but the code neglects it.
+Use \fB\%curs_set\fP(3X) to make the cursor invisible.
 .SH HISTORY
 .I \%ncurses
 formerly treated \fBnl\fP(3X) and \fBnonl\fP(3X) as both input
-- 
2.30.2

signature.asc
Description: PGP signature