[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 38/42] man/curs_pad.3x: Lightly revise.
From: |
G. Branden Robinson |
Subject: |
[PATCH 38/42] man/curs_pad.3x: Lightly revise. |
Date: |
Sat, 16 Dec 2023 11:48:46 -0600 |
Content:
* Refer to "X/Open Curses" on "X/Open"'s first appearance.
* Refer to Solaris "xcurses" library by that name.
Style:
* Migrate away from "routine" usage.
* Favor English words over Latin abbreviations.
* Perform Kemper notectomy.
* Set "WINDOW" data type in italics, not bold.
Markup:
* Define and use `` and '' strings for typographer's quotation marks.
* Break input lines after commas.
---
man/curs_pad.3x | 54 ++++++++++++++++++++++++++++++++-----------------
1 file changed, 35 insertions(+), 19 deletions(-)
diff --git a/man/curs_pad.3x b/man/curs_pad.3x
index d030161f2..5297e11a6 100644
--- a/man/curs_pad.3x
+++ b/man/curs_pad.3x
@@ -29,6 +29,17 @@
.\"
.\" $Id: curs_pad.3x,v 1.49 2023/11/25 14:08:35 tom Exp $
.TH curs_pad 3X 2023-11-25 "ncurses 6.4" "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
@@ -57,16 +68,19 @@ .SH SYNOPSIS
.fi
.SH DESCRIPTION
.SS newpad
-The \fB\%newpad\fP routine creates and returns a pointer to a new pad data
-structure with the given number of lines, \fInlines\fP, and columns,
+\fB\%newpad\fP creates and returns a pointer to a new pad data structure
+with the given number of lines,
+\fInlines\fP,
+and columns,
\fIncols\fP.
-A pad is like a window, except that it is not restricted by the
-screen size, and is not necessarily associated with a particular part of the
-screen.
-Pads can be used when a large window is needed, and only a part of the
-window will be on the screen at one time.
+A pad is like a window,
+except that it is not restricted by the screen size,
+and is not necessarily associated with a particular part of the screen.
+Pads can be used when a large window is needed,
+and only a part of the window will be on the screen at one time.
Automatic refreshes of pads
-(e.g., from scrolling or echoing of input) do not occur.
+(as from scrolling or echoing of input)
+do not occur.
.PP
It is not valid to call \fB\%wrefresh\fP with a \fIpad\fP argument;
call \fB\%prefresh\fP or \fB\%pnoutrefresh\fP instead.
@@ -126,16 +140,16 @@ .SS pecho_wchar
It does this by a call to \fB\%wadd_wch\fP followed by a call
to \fB\%prefresh\fP.
.SH RETURN VALUE
-Routines that return an integer return \fBERR\fP upon failure and
+Functions that return an integer return \fBERR\fP upon failure and
\fBOK\fP
(SVr4 specifies only
\*(``an integer value other than \fBERR\fP\*('')
upon successful completion.
.PP
-Routines that return pointers return \fBNULL\fP on error, and set \fB\%errno\fP
-to \fB\%ENOMEM\fP.
+Functions that return pointers return \fBNULL\fP on error,
+and set \fB\%errno\fP to \fB\%ENOMEM\fP.
.PP
-X/Open does not define any error conditions.
+X/Open Curses does not define any error conditions.
In this implementation
.RS 3
.TP 5
@@ -157,7 +171,7 @@ .SH RETURN VALUE
to \fB\%wecho_wchar\fP returns an error.
.RE
.SH NOTES
-Note that \fB\%pechochar\fP may be a macro.
+\fB\%pechochar\fP may be a macro.
.SH PORTABILITY
BSD \fIcurses\fP has no \fIpad\fP feature.
.PP
@@ -183,8 +197,8 @@ .SH PORTABILITY
a pad is undocumented,
and is not checked by the vendor Unix implementations:
.bP
-SVr4 \fIcurses\fP sets a flag in the \fB\%WINDOW\fP structure in \fB\%newpad\fP
-which tells if the window is a \fIpad\fP.
+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.
.IP
However, it uses this information only in
\fB\%waddch\fP (to decide if it should call \fB\%wrefresh\fP) and
@@ -192,10 +206,12 @@ .SH PORTABILITY
and does not check in \fB\%wrefresh\fP to ensure that the pad
is refreshed properly.
.bP
-Solaris X/Open Curses checks if a window is a pad in \fB\%wnoutrefresh\fP,
+Solaris \fI\%xcurses\fP checks whether a window is a pad in
+\fB\%wnoutrefresh\fP,
returning \fBERR\fP in that case.
.IP
-However, it only sets the flag for subwindows if the parent window is a pad.
+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.
.IP
@@ -204,7 +220,7 @@ .SH PORTABILITY
states that the lack of a check was an MKS extension.
.bP
NetBSD 7 \fIcurses\fP
-sets a flag in the \fB\%WINDOW\fP structure
+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.
@@ -218,7 +234,7 @@ .SH PORTABILITY
.PP
This implementation
.bP
-sets a flag in the \fB\%WINDOW\fP structure
+sets a flag in the \fI\%WINDOW\fP structure
for \fB\%newpad\fP and \fB\%subpad\fP,
.bP
allows a \fB\%subwin\fP or \fB\%derwin\fP call to succeed having a pad parent
by
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 38/42] man/curs_pad.3x: Lightly revise.,
G. Branden Robinson <=