bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 134/177] man/curs_pad.3x: Revise "PORTABILITY" section.


From: G. Branden Robinson
Subject: [PATCH 134/177] man/curs_pad.3x: Revise "PORTABILITY" section.
Date: Mon, 13 Jan 2025 11:38:20 -0600

Style:
* Slightly recast.
* Set macro names and other C symbols in italics, not bold, when
  referring to them generically in this section, as opposed to the
  ncurses topic/implementation.
* Favor "ncurses" over "this implementation".

Markup:
* 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_pad.3x | 117 ++++++++++++++++++++++++++++++++++--------------
 1 file changed, 83 insertions(+), 34 deletions(-)

diff --git a/man/curs_pad.3x b/man/curs_pad.3x
index 6a0f9a0e5..78a09f7b4 100644
--- a/man/curs_pad.3x
+++ b/man/curs_pad.3x
@@ -243,54 +243,103 @@ .SH PORTABILITY
 if the parent window is not a pad is undocumented,
 and is not checked by the vendor Unix implementations.
 .bP
-SVr4 \fIcurses\fP sets a flag in the \fI\%WINDOW\fP structure in
-\fB\%newpad\fP which tells if the window is a \fIpad\fP.
+SVr4
+.IR curses 's
+.I \%newpad
+sets a flag in the
+.I \%WINDOW
+structure indicating that the window is a pad.
 .IP
-However, it uses this information only in
-\fB\%waddch\fP (to decide if it should call \fB\%wrefresh\fP) and
-\fB\%wscrl\fP (to avoid scrolling a pad),
-and does not check in \fB\%wrefresh\fP to ensure that the pad
-is refreshed properly.
+However,
+it uses this information only in
+.I \%waddch
+(to decide if it should call
+.IR \%wrefresh ")"
+and
+.I \%wscrl
+(to avoid scrolling a pad);
+its
+.I \%wrefresh
+does not check it to ensure that a pad is properly updated.
 .bP
-Solaris \fI\%xcurses\fP checks whether a window is a pad in
-\fB\%wnoutrefresh\fP,
-returning \fBERR\fP in that case.
+Solaris
+.I \%xcurses
+checks whether a window is a pad in its
+.IR \%wnoutrefresh ","
+returning
+.I ERR
+in that case.
 .IP
 However,
-it only sets the flag for subwindows if the parent window is a pad.
-Its \fB\%newpad\fP function does not set this information.
-Consequently, the check will never fail.
+it sets the flag on subwindows only if the parent window is a pad.
+Its
+.I \%newpad
+does not set this information.
+Consequently,
+the check never fails.
 .IP
-It makes no comparable check in \fB\%pnoutrefresh\fP,
-though interestingly enough, a comment in the source code
-states that the lack of a check was an MKS extension.
+It makes no comparable check in
+.I \%pnoutrefresh
+\(em though interestingly enough,
+a comment in the source code states that the lack of a check
+was an MKS extension.
 .bP
-NetBSD 7 \fIcurses\fP
-sets a flag in the \fI\%WINDOW\fP structure
-for \fB\%newpad\fP and \fB\%subpad\fP,
-using this to help with the distinction between \fB\%wnoutrefresh\fP
-and \fB\%pnoutrefresh\fP.
+NetBSD\ 7
+.I curses
+sets a flag in the
+.I \%WINDOW
+structure for
+.I \%newpad
+and
+.IR \%subpad ","
+aiding itself to distinguish between
+.I \%wnoutrefresh
+and
+.IR \%pnoutrefresh "."
 .IP
 It does not check for the case where a subwindow is created in
-a pad using \fB\%subwin\fP or \fB\%derwin\fP.
+a pad using
+.I \%subwin
+or
+.IR \%derwin "."
 .IP
-The \fB\%dupwin\fP function returns a regular window when duplicating a pad.
-Likewise, \fB\%getwin\fP always returns a window, even if the saved
-data was from a pad.
+Its
+.I \%dupwin
+returns a regular window when duplicating a pad.
+Likewise,
+its
+.I \%getwin
+always returns a window,
+even if the saved data was from a pad.
 .PP
-This implementation
+.IR \%ncurses ":"
 .bP
-sets a flag in the \fI\%WINDOW\fP structure
-for \fB\%newpad\fP and \fB\%subpad\fP,
+sets a flag in the
+.I \%WINDOW
+structure for
+.I \%newpad
+and
+.IR \%subpad ","
 .bP
-allows a \fB\%subwin\fP or \fB\%derwin\fP call to succeed having a pad parent 
by
-forcing the subwindow to be a pad,
+allows a
+.I \%subwin
+or
+.I \%derwin
+call to succeed having a pad parent
+by forcing the subwindow to be a pad,
 .bP
-checks in both \fB\%wnoutrefresh\fP and \fB\%pnoutrefresh\fP to ensure
-that pads and windows are handled distinctly, and
+checks in both
+.I \%wnoutrefresh
+and
+.I \%pnoutrefresh
+to ensure that pads and windows are handled distinctly,
+and
 .bP
-ensures that \fB\%dupwin\fP and \fB\%getwin\fP treat
-pads versus windows consistently.
+ensures that
+.I \%dupwin
+and
+.I \%getwin
+treat pads versus windows consistently.
 .SH SEE ALSO
 \fB\%curses\fP(3X),
 \fB\%curs_addch\fP(3X),
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]