bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 03/23] man/curs_scr_dump.3x: Revise "PORTABILITY" and "HISTORY" s


From: G. Branden Robinson
Subject: [PATCH 03/23] man/curs_scr_dump.3x: Revise "PORTABILITY" and "HISTORY" sections.
Date: Thu, 26 Dec 2024 21:33:50 -0600

* Set function names in italics, not bold, when referring to them
  generically as opposed to the ncurses topic/implementation.

* To throw the distinction into sharper relief, set mention of the
  "wresize" ncurses extension as a man page cross reference.

* Favor man(7) font macros over roff(7) font selection escape sequences,
  except for man page cross references (because man/make_sed.sh
  recognizes only certain patterns when rewriting such cross references)
  and terms in the "NAME" section (because the generated edit_man.sh
  script expects font selection escape sequences when scraping terms
  thence to gather names for man page aliases).

* Tighten wording.
---
 man/curs_scr_dump.3x | 47 ++++++++++++++++++++++++++++++--------------
 1 file changed, 32 insertions(+), 15 deletions(-)

diff --git a/man/curs_scr_dump.3x b/man/curs_scr_dump.3x
index 0cde3da8c..8bc09b282 100644
--- a/man/curs_scr_dump.3x
+++ b/man/curs_scr_dump.3x
@@ -198,31 +198,48 @@ .SH PORTABILITY
 qualifiers.
 .PP
 SVr4 documentation describes
-.B \%scr_init
+.I \%scr_init
 such that the dump data is also considered invalid
 \*(``if the time-stamp of the tty is old\*(''
 but does not define \*(``old\*(''.
 .PP
-As of 2024, PDCurses provides these functions.
-NetBSD curses does not provide these functions,
-although it provides \fB\%getwin\fP.
+As of 2024,
+.I \%PDCurses
+provides these functions.
+NetBSD
+.I curses
+does not.
 .PP
-Other implementations of curses store the window in binary form.
-One drawback to binary form is that this makes the dump dependent upon
-the curses library's internal data structures.
-Rather than do that, ncurses stores the dump in textual form,
+Other implementations of
+.I curses
+store the window in binary form,
+which makes the dump dependent
+upon the
+.I curses
+library's internal data structures.
+.I \%ncurses
+avoids this drawback by storing the dump in textual form,
 allowing more flexible use of the data.
-For instance, SVr4 curses \fB\%scr_restore\fP requires that the
-dumped window have the same dimensions as the restored window.
-ncurses uses \fB\%wresize\fP to adjust the restored window size.
+For instance,
+the
+.I \%scr_restore
+of SVr4
+.I curses
+requires that the dumped window have the same dimensions
+as the restored window.
+.I \%ncurses
+uses its
+\fB\%wresize\fP(3X)
+extension
+to adjust the restored window size.
 .SH HISTORY
 SVr3 (1987) introduced
-.BR \%scr_dump ","
-.BR \%scr_init ","
+.IR \%scr_dump ","
+.IR \%scr_init ","
 and
-.BR \%scr_restore "."
+.IR \%scr_restore "."
 SVr3.1 added
-.BR \%scr_set "."
+.IR \%scr_set "."
 .SH SEE ALSO
 .na
 \fB\%curses\fP(3X),
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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