[PATCH 1/3] man/curs_variables.3x: Clarify `curscr` and `newscr`.

[G. Branden Robinson]

* `curscr` is standardized by both SVID and X/Open.
* ...but not to do very much.  Explain.
* Document `newscr` as an ncurses extension.
* Annotate an area for possible expansion in comment.
---
 man/curs_variables.3x | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/man/curs_variables.3x b/man/curs_variables.3x
index 2bb82695..3055c397 100644
--- a/man/curs_variables.3x
+++ b/man/curs_variables.3x
@@ -185,7 +185,7 @@ .SS TABSIZE
 spaces as it adds a tab to a window;
 see \fB\%curs_addch\fP(3X).
 .SS curscr
-\fIncurses\fP records updates to the terminal screen in a \fI\%WINDOW\fP
+\fIcurses\fP records updates to the terminal screen in a \fI\%WINDOW\fP
 structure named \fB\%curscr\fP.
 .PP
 This object is referred to as the \*(``physical screen\*('' in
@@ -217,8 +217,21 @@ .SH NOTES
 \fIterminfo\fP libraries,
 most of these variables reside in the \fIcurses\fP library.
 .SH PORTABILITY
-The X/Open Curses standard documents neither \fB\%TABSIZE\fP nor
-\fB\%ESCDELAY\fP.
+The X/Open Curses standard documents all of the foregoing types and
+symbols except for \fB\%newscr\fP,
+\fB\%TABSIZE\fP,
+and \fB\%ESCDELAY\fP.
+.PP
+X/Open Curses describes \fB\%curscr\fP only as \*(``an internal data
+structure\*('';
+SVID was less cagey,
+noting its use \*(``for certain low-level operations like clearing and
+redrawing a screen containing garbage\*(''.
+Neither specified its interaction with the rest of the interface beyond
+use as an argument to \fB\%clearok\fP(3X) and \fB\%wrefresh\fP(3X).
+.PP
+\fB\%newscr\fP is an extension in SVr4 \fIcurses\fP.
+.\" TODO: Can we say more?  When is it a valid argument to any function?
 .PP
 \fB\%TABSIZE\fP is an extension in SVr4 \fIcurses\fP.
 .IP \(bu 2
-- 
2.30.2

signature.asc
Description: PGP signature