[PATCH 060/177] man/curs_variables.3x: Document `CCHARW_MAX`.

[G. Branden Robinson]

---
 man/curs_variables.3x | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/man/curs_variables.3x b/man/curs_variables.3x
index 75c1f68f4..6635d3052 100644
--- a/man/curs_variables.3x
+++ b/man/curs_variables.3x
@@ -104,6 +104,7 @@ .SH NAME
 \fB\%FALSE\fP,
 \fB\%ERR\fP,
 \fB\%OK\fP,
+\fB\%CCHARW_MAX\fP,
 \fB\%curscr\fP,
 \fB\%newscr\fP,
 \fB\%stdscr\fP,
@@ -133,6 +134,9 @@ .SH SYNOPSIS
 \fBconst \fI/*\fP .\|.\|. \fI*/\fP ERR;
 \fBconst \fI/*\fP .\|.\|. \fI*/\fP OK;
 .PP
+\fI/* extension */
+\fBconst \fI/*\fP .\|.\|. \fI*/\fP CCHARW_MAX;
+.PP
 \fI/* variables */
 \fBint COLORS;
 \fBint COLOR_PAIRS;
@@ -159,7 +163,7 @@ .SH DESCRIPTION
 In either case,
 applications should treat them as read-only to avoid
 confusing the library.
-.SH "CONSTANTS"
+.SH CONSTANTS
 .SS "TRUE, FALSE"
 The \fIcurses\fP library defines \fBTRUE\fP and \fBFALSE\fP
 to represent the values of the Boolean data type.
@@ -167,6 +171,17 @@ .SS "ERR, OK"
 \fIcurses\fP and \fIterminfo\fP routines frequently return these
 constant integral values indicating failure and success,
 respectively.
+.SS CCHARW_MAX
+This integral value,
+an
+.I \%ncurses
+extension,
+contains the maximum number of
+.I \%wchar_t
+wide characters that can be stored in a
+.I curses
+complex character
+.IR \%cchar_t "."
 .SH "PREDEFINED TYPES"
 .SS "\fIbool\fP"
 X/Open Issue\ 4 \fIcurses\fP (1996) preceded the ISO C99 and ISO C++98
@@ -292,7 +307,19 @@ .SH NOTES
 .I \%tinfo
 libraries,
 most of these variables reside in the former.
+.SH EXTENSIONS
+The
+.I \%CCHARW_MAX
+constant is an
+.I \%ncurses
+extension.
 .SH PORTABILITY
+Applications employing
+.I \%ncurses
+extensions should condition their use on the visibility of the
+.B \%NCURSES_VERSION
+preprocessor macro.
+.PP
 The X/Open Curses standard documents all of the foregoing types and
 symbols except for \fB\%newscr\fP,
 \fB\%TABSIZE\fP,
-- 
2.30.2

signature.asc
Description: PGP signature