[PATCH 51/52] Parallelize language and organization of API extension material.

[G. Branden Robinson]

...for consistency.

Declare extensions in "EXTENSIONS" section.  Indicate how to
conditionally use them in "PORTABILITY" section.

* man/curs_color.3x:
* man/curs_extend.3x:
* man/curs_getch.3x:
* man/curs_inopts.3x:
* man/curs_print.3x: Do it.
---
 man/curs_color.3x  | 13 +++++++++++--
 man/curs_extend.3x | 17 ++++++++++++-----
 man/curs_getch.3x  | 12 ++++++++++++
 man/curs_inopts.3x | 23 +++++++++++++++++------
 man/curs_print.3x  | 19 +++++++++++++------
 5 files changed, 65 insertions(+), 19 deletions(-)

diff --git a/man/curs_color.3x b/man/curs_color.3x
index cce8547ba..e2ad70462 100644
--- a/man/curs_color.3x
+++ b/man/curs_color.3x
@@ -494,9 +494,18 @@ .SH NOTES
 .SH EXTENSIONS
 The functions marked as extensions were designed for
 \fB\%ncurses\fP(3X),
-and are not found in SVr4 curses, 4.4BSD curses,
-or any other previous version of curses.
+and are not found in SVr4
+.IR curses ,
+4.4BSD
+.IR curses ,
+or any other previous curses implementation.
 .SH PORTABILITY
+Applications employing
+.I \%ncurses
+extensions should condition their use on the visibility of the
+.B \%NCURSES_VERSION
+preprocessor macro.
+.PP
 This implementation satisfies XSI Curses's minimum maximums
 for \fB\%COLORS\fP and \fB\%COLOR_PAIRS\fP.
 .PP
diff --git a/man/curs_extend.3x b/man/curs_extend.3x
index 54cb1e7f5..7e3c641cb 100644
--- a/man/curs_extend.3x
+++ b/man/curs_extend.3x
@@ -80,12 +80,19 @@ .SH RETURN VALUE
 .PP
 \fBuse_extended_names\fP returns the previous state, allowing you to
 save this and restore it.
+.SH EXTENSIONS
+These functions are \fB\%ncurses\fP(3X) extensions,
+and are not found in SVr4
+.IR curses ,
+4.4BSD
+.IR curses ,
+or any other previous curses implementation.
 .SH PORTABILITY
-These routines are specific to \fI\%ncurses\fP.
-They were not supported on
-Version 7, BSD or System V implementations.
-It is recommended that
-any code depending on them be conditioned using NCURSES_VERSION.
+Applications employing
+.I \%ncurses
+extensions should condition their use on the visibility of the
+.B \%NCURSES_VERSION
+preprocessor macro.
 .SH AUTHORS
 Thomas Dickey.
 .SH SEE ALSO
diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index b1cf9c8f6..aeb8b6405 100644
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -370,7 +370,19 @@ .SH NOTES
 \fBKEY_NPAGE\fP, \fBKEY_PPAGE\fP, and function keys 1 through 12.
 The Ins key
 is usually mapped to \fBKEY_IC\fP.
+.SH EXTENSIONS
+\fB\%has_key\fP was designed for \fB\%ncurses\fP(3X),
+and is not found in SVr4
+.IR curses ,
+4.4BSD
+.IR curses ,
+or any other previous curses implementation.
 .SH PORTABILITY
+Applications employing
+.I \%ncurses
+extensions should condition their use on the visibility of the
+.B \%NCURSES_VERSION
+preprocessor macro.
 .PP
 X/Open Curses, Issue 4, Version 2, describes
 \fB\%getch\fP,
diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x
index 39635429b..fdc438a56 100644
--- a/man/curs_inopts.3x
+++ b/man/curs_inopts.3x
@@ -410,13 +410,24 @@ .SH EXTENSIONS
 \-1
 if the library is not initialized.
 .PP
-These routines are specific to \fI\%ncurses\fP.
-They were not supported on Version 7, BSD or System V implementations.
-It is recommended that any code depending on \fI\%ncurses\fP extensions
-be conditioned using NCURSES_VERSION.
+They were designed for
+\fB\%ncurses\fP(3X),
+and are not found in SVr4
+.IR curses ,
+4.4BSD
+.IR curses ,
+or any other previous
+.I curses
+implementation.
 .SH PORTABILITY
-Except as noted in the section on extensions,
-these functions are described in the XSI Curses standard, Issue 4.
+Applications employing
+.I \%ncurses
+extensions should condition their use on the visibility of the
+.B \%NCURSES_VERSION
+preprocessor macro.
+.PP
+Except as noted in section \*(``EXTENSIONS\*('' above,
+X/Open Curses, Issue 4, Version 2 describes these functions.
 .PP
 .I \%ncurses
 follows X/Open Curses
diff --git a/man/curs_print.3x b/man/curs_print.3x
index 16fac2dd6..38fe4cdab 100644
--- a/man/curs_print.3x
+++ b/man/curs_print.3x
@@ -66,13 +66,20 @@ .SH RETURN VALUE
 .PP
 When \fB\%mcprint\fP succeeds, it returns the number of characters actually
 sent to the printer.
+.SH EXTENSIONS
+\fB\%mcprint\fP was designed for
+\fB\%ncurses\fP(3X),
+and was not found in SVr4
+.IR curses ,
+4.4BSD
+.IR curses ,
+or any other previous curses implementation.
 .SH PORTABILITY
-The \fB\%mcprint\fP call was designed for \fI\%ncurses\fP,
-and is not found in SVr4 \fIcurses\fP,
-4.4BSD \fIcurses\fP,
-or any other previous version of \fIcurses\fP.
-It is recommended that any code depending on \fI\%ncurses\fP extensions
-be conditioned using \fB\%NCURSES_VERSION\fP.
+Applications employing this
+.I \%ncurses
+extension should condition its use on the visibility of the
+.B \%NCURSES_VERSION
+preprocessor macro.
 .SH BUGS
 Padding in the
 \fBmc5p\fP,
-- 
2.30.2

signature.asc
Description: PGP signature