[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 061/177] man/curs_variables.3x: Fix content nits.
From: |
G. Branden Robinson |
Subject: |
[PATCH 061/177] man/curs_variables.3x: Fix content nits. |
Date: |
Mon, 13 Jan 2025 11:24:27 -0600 |
* Discuss `stdscr` before `curscr` and `newscr`, improving the
conceptual flow.
* Document more extensions in "EXTENSIONS" section.
---
man/curs_variables.3x | 61 ++++++++++++++++++++++++++++++++-----------
1 file changed, 46 insertions(+), 15 deletions(-)
diff --git a/man/curs_variables.3x b/man/curs_variables.3x
index 6635d3052..5d4497197 100644
--- a/man/curs_variables.3x
+++ b/man/curs_variables.3x
@@ -233,7 +233,24 @@ .SS "\fIWINDOW\fP"
structure type;
see subsection \*(``Overview\*('' of \fB\%ncurses\fP(3X).
.SH "VARIABLES"
-.SS "curscr, stdscr, newscr"
+.SS "curscr, newscr, stdscr"
+When a
+.I curses
+application calls
+\fB\%initscr\fP(3X) or \fB\%newterm\fP(3X),
+the library creates a window named
+.B \%stdscr
+that is the same size as the terminal screen
+and is the implicit window used by functions
+that interact with a window
+but do not take a parameter identifying one;
+many
+.I curses
+functions use it.
+An application need not use
+.BR \%stdscr ";"
+it might prefer to tile the display into multiple windows instead.
+.PP
The library records updates to the terminal screen in a window named
\fB\%curscr\fP.
This object is referred to as the \*(``physical screen\*('' in
@@ -250,12 +267,6 @@ .SS "curscr, stdscr, newscr"
When the screen is refreshed,
\fIcurses\fP determines a minimal set of updates using the terminal's
capabilities to make \fB\%curscr\fP look like \fB\%newscr\fP.
-.PP
-Once \fIcurses\fP is initialized,
-it creates a window named \fB\%stdscr\fP.
-It is the same size as the terminal screen and is the default window
-used by routines that do not take a parameter identifying one.
-Many \fIcurses\fP functions use this window.
.SS COLORS
Once \fIcurses\fP is initialized,
\fB\%COLORS\fP
@@ -306,13 +317,26 @@ .SH NOTES
and
.I \%tinfo
libraries,
-most of these variables reside in the former.
+most of these symbols reside in the former.
+The
+.B bool
+data type
+is used by both.
.SH EXTENSIONS
The
-.I \%CCHARW_MAX
-constant is an
-.I \%ncurses
-extension.
+.B \%CCHARW_MAX
+constant,
+and
+.BR \%ESCDELAY ","
+.BR \%TABSIZE ","
+and
+.B \%newscr
+variables,
+are
+extensions,
+the first of these originating in
+.\" Solaris xcurses calls it M_CCHAR_MAX.
+.IR \%ncurses "."
.SH PORTABILITY
Applications employing
.I \%ncurses
@@ -321,9 +345,12 @@ .SH PORTABILITY
preprocessor macro.
.PP
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.
+symbols except for
+.BR \%CCHARW_MAX ","
+.BR \%newscr ","
+.BR \%TABSIZE ","
+and
+.BR \%ESCDELAY "."
.PP
X/Open Curses describes \fB\%curscr\fP only as \*(``an internal data
structure\*('';
@@ -393,6 +420,10 @@ .SH SEE ALSO
Segmentation\*(''
.UE
.PP
+\fB\%getcchar\fP(3X)
+further discusses
+.BR \%CCHARW_MAX "."
+.PP
\fB\%curses\fP(3X),
\fB\%curs_color\fP(3X),
\fB\%curs_opaque\fP(3X),
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 061/177] man/curs_variables.3x: Fix content nits.,
G. Branden Robinson <=