bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 05/20] Relocate material.


From: G. Branden Robinson
Subject: [PATCH 05/20] Relocate material.
Date: Fri, 29 Dec 2023 21:00:39 -0600

Thomas's new text about macros applies generally to the ncurses API, not
just the terminfo portion.

Also:
* Set "ncurses" in italics, not bold.
* Prefer English phrases to Latin abbreviations.
* Recast discussion of "base" and "extended" standards conformance in
  "PORTABILITY" section.
---
 man/curs_terminfo.3x | 15 --------------
 man/ncurses.3x       | 49 ++++++++++++++++++++++++++++++++------------
 2 files changed, 36 insertions(+), 28 deletions(-)

diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index 88f5b97f1..5edbfebb8 100644
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -517,21 +517,6 @@ .SH RETURN VALUE
 .SH NOTES
 .\" See X/Open Curses Issue 4, Version 2, pp. 227-234.
 .\" See X/Open Curses Issue 7, pp. 311-318.
-According to X/Open Curses,
-any of the \fIenhanced curses\fP functions may be implemented as macros.
-The term \*(``enhanced\*('' refers to features not found in SVr4 curses.
-.PP
-\fB\%ncurses\fP uses macros
-.bP
-for functions which return values via their parameters,
-.bP
-to support obsolete features,
-.bP
-to reuse functions,
-e.g., those that move the cursor before another operation, and
-.bP
-a few special cases.
-.PP
 The \fB\%vid_puts\fP function in \fB\%ncurses\fP is a special case.
 It was originally implemented based on a draft of X/Open Curses,
 as a macro,
diff --git a/man/ncurses.3x b/man/ncurses.3x
index ec0e39ba6..39cae840e 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -1544,6 +1544,20 @@ .SH FILES
 .I \*d
 compiled terminal capability database
 .SH NOTES
+\fI\%ncurses\fP implements many functions as macros as well.
+It does so
+.bP
+for functions that return values via their parameters,
+.bP
+to support obsolete features,
+.bP
+to reuse functions,
+(for example,
+those that move the cursor before another operation)
+and
+.bP
+a few special cases.
+.PP
 If standard output from a \fI\%ncurses\fP program is re-directed to
 something which is not a tty,
 screen updates will be directed to standard error.
@@ -1552,10 +1566,15 @@ .SH NOTES
 See subsection \*(``Header files\*('' below regarding symbols exposed by
 inclusion of \fI\%curses.h\fP.
 .SH EXTENSIONS
-The \fI\%ncurses\fP library can be compiled with an option
-(\fB\-DUSE_GETCAP\fP)
-that falls back to the old-style /etc/termcap file if the terminal setup code
-cannot find a terminfo entry corresponding to \fITERM\fP.
+.I \%ncurses
+can be compiled with an option
+.RB ( \%\-DUSE_GETCAP )
+that falls back to reading
+.I \%/etc/termcap
+if the terminal setup code cannot find a
+.I \%term\%info
+entry corresponding to
+.I TERM.
 Use of this feature is not recommended,
 as it essentially includes an entire termcap compiler in the
 \fI\%ncurses\fP startup code,
@@ -1593,15 +1612,19 @@ .SH EXTENSIONS
 application output to a printer attached to the terminal device.
 See the \fBcurs_print\fP(3X) manual page for details.
 .SH PORTABILITY
-The \fI\%ncurses\fP library is intended to be BASE-level conformant with
-XSI Curses.
-The EXTENDED XSI Curses functionality
-(including color support) is supported.
-.PP
-A small number of local differences
-(that is,
-individual differences between the XSI Curses and \fI\%ncurses\fP calls)
-are described in \fBPORTABILITY\fP sections of the library man pages.
+X/Open Curses defines two levels of conformance,
+\*(``base\*('' and \*(``enhanced\*(''.
+The latter includes several additional features,
+such as wide-character and color support.
+.I \%ncurses
+intends base-level conformance with X/Open Curses,
+and supports nearly all its enhanced features.
+.\" XXX: What's missing?  GBR counts untic(1), and that's all.
+.PP
+Differences between X/Open Curses and
+.I \%ncurses
+are documented in the \*(``PORTABILITY\*('' sections of applicable man
+pages.
 .SS "Error Checking"
 In many cases, X/Open Curses is vague about error conditions,
 omitting some of the SVr4 documentation.
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]