bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 005/100] man/*.3x: Parallelize narrow/wide man page cross referen


From: G. Branden Robinson
Subject: [PATCH 005/100] man/*.3x: Parallelize narrow/wide man page cross references.
Date: Sat, 30 Mar 2024 16:47:28 -0500

Content:
* In "SEE ALSO" section, drop cross references from wide-API pages to
  non-wide ones, except for the separate counterpart paragraph.
* Add counterpart cross reference paragraph (man/curs_get_wstr.3x,
  man/curs_get_wstr.3x, man/curs_get_wstr.3x, man/curs_get_wstr.3x,
  man/curs_insstr.3x, man/curs_instr.3x).
* Drop commentary on contents of curses(3X) and curs_attr(3X) man pages
  from "SEE ALSO" section of man/curs_inch.3x.

Style:
* Consistently locate the counterpart cross reference pragraph at the
  start of the "SEE ALSO" section.
---
 man/curs_add_wchstr.3x |  7 ++++---
 man/curs_addchstr.3x   |  8 ++++----
 man/curs_addstr.3x     |  8 ++++----
 man/curs_addwstr.3x    |  8 ++++----
 man/curs_get_wch.3x    |  8 ++++----
 man/curs_get_wstr.3x   |  5 ++++-
 man/curs_getch.3x      | 10 +++++-----
 man/curs_getstr.3x     |  5 +++++
 man/curs_in_wch.3x     |  7 ++++---
 man/curs_in_wchstr.3x  |  6 ++++--
 man/curs_inch.3x       | 19 +++++++------------
 man/curs_ins_wstr.3x   |  5 ++++-
 man/curs_instr.3x      |  9 ++++++---
 13 files changed, 59 insertions(+), 46 deletions(-)

diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x
index 5493dd858..646e15bdf 100644
--- a/man/curs_add_wchstr.3x
+++ b/man/curs_add_wchstr.3x
@@ -117,9 +117,10 @@ .SH NOTES
 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO
+\fB\%curs_addchstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
 \fB\%curses\fP(3X),
-\fB\%curs_addch\fP(3X),
-\fB\%curs_addchstr\fP(3X),
-\fB\%curs_addstr\fP(3X),
 \fB\%curs_addwstr\fP(3X),
 \fB\%curs_add_wch\fP(3X)
diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x
index 9286885e3..946c632e8 100644
--- a/man/curs_addchstr.3x
+++ b/man/curs_addchstr.3x
@@ -111,11 +111,11 @@ .SH NOTES
 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO
-\fB\%curses\fP(3X),
-\fB\%curs_addch\fP(3X),
-\fB\%curs_addstr\fP(3X)
-.PP
 \fB\%curs_add_wchstr\fP(3X) describes comparable functions of the
 .I \%ncurses
 library in its wide-character configuration
 .RI ( \%ncursesw ).
+.PP
+\fB\%curses\fP(3X),
+\fB\%curs_addch\fP(3X),
+\fB\%curs_addstr\fP(3X)
diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x
index 928a4d493..38a8f396a 100644
--- a/man/curs_addstr.3x
+++ b/man/curs_addstr.3x
@@ -127,11 +127,11 @@ .SH PORTABILITY
 X/Open Curses,
 Issue 4 describes these functions.
 .SH SEE ALSO
-\fB\%curses\fP(3X),
-\fB\%curs_addch\fP(3X),
-\fB\%curs_addchstr\fP(3X)
-.PP
 \fB\%curs_addwstr\fP(3X) describes comparable functions of the
 .I \%ncurses
 library in its wide-character configuration
 .RI ( \%ncursesw ).
+.PP
+\fB\%curses\fP(3X),
+\fB\%curs_addch\fP(3X),
+\fB\%curs_addchstr\fP(3X)
diff --git a/man/curs_addwstr.3x b/man/curs_addwstr.3x
index 866c05dc5..53895e33f 100644
--- a/man/curs_addwstr.3x
+++ b/man/curs_addwstr.3x
@@ -139,10 +139,10 @@ .SH PORTABILITY
 X/Open Curses,
 Issue 4 describes these functions.
 .SH SEE ALSO
-\fB\%curses\fP(3X),
-\fB\%curs_add_wch\fP(3X),
-\fB\%curs_add_wchstr\fP(3X)
-.PP
 \fB\%curs_addstr\fP(3X) describes comparable functions of the
 .I \%ncurses
 library in its non-wide-character configuration.
+.PP
+\fB\%curses\fP(3X),
+\fB\%curs_add_wch\fP(3X),
+\fB\%curs_add_wchstr\fP(3X)
diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x
index b0d69166f..5378c8604 100644
--- a/man/curs_get_wch.3x
+++ b/man/curs_get_wch.3x
@@ -249,12 +249,12 @@ .SH PORTABILITY
 .B \%wget_wch
 with signal handlers.
 .SH SEE ALSO
+\fB\%curs_getch\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
 \fB\%curses\fP(3X),
 \fB\%curs_add_wch\fP(3X),
 \fB\%curs_inopts\fP(3X),
 \fB\%curs_move\fP(3X),
 \fB\%curs_refresh\fP(3X)
-.PP
-\fB\%curs_getch\fP(3X) describes comparable functions of the
-.I \%ncurses
-library in its non-wide-character configuration.
diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x
index 48d270873..aee02743d 100644
--- a/man/curs_get_wstr.3x
+++ b/man/curs_get_wstr.3x
@@ -216,6 +216,9 @@ .SH PORTABILITY
 NetBSD 7 curses imitates \fI\%ncurses\fP 6.1 in this regard,
 treating a \fB\-1\fP as an indefinite number of characters.
 .SH SEE ALSO
+\fB\%curs_getstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
 \fB\%curses\fP(3X),
-\fB\%curs_getstr\fP(3X),
 \fB\%curs_get_wch\fP(3X)
diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index 30e10699b..f2c7554fe 100644
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -672,6 +672,11 @@ .SH PORTABILITY
 had added them along with
 .BR \%KEY_MOUSE .
 .SH SEE ALSO
+\fB\%curs_get_wch\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its wide-character configuration
+.RI ( \%ncursesw ).
+.PP
 \fB\%curses\fP(3X),
 \fB\%curs_addch\fP(3X),
 \fB\%curs_inopts\fP(3X),
@@ -683,11 +688,6 @@ .SH SEE ALSO
 \fB\%resizeterm\fP(3X),
 \fB\%ascii\fP(7)
 .PP
-\fB\%curs_get_wch\fP(3X) describes comparable functions of the
-.I \%ncurses
-library in its wide-character configuration
-.RI ( \%ncursesw ).
-.PP
 ECMA-6 \*(``7-bit coded Character Set\*(''
 \%<https://\*:ecma\-international\*:.org/\
 \*:publications\-and\-standards/\*:standards/\*:ecma\-6/>
diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x
index 33563ab68..2526336e4 100644
--- a/man/curs_getstr.3x
+++ b/man/curs_getstr.3x
@@ -288,6 +288,11 @@ .SH PORTABILITY
 rather than \fBnoraw\fP and \fBcbreak\fP for better compatibility with
 SVr4-curses, e.g., allowing one to enter a \fB^C\fP into the buffer.
 .SH SEE ALSO
+\fB\%curs_get_wstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its wide-character configuration
+.RI ( \%ncursesw ).
+.PP
 \fB\%curses\fP(3X),
 \fB\%curs_getch\fP(3X),
 \fB\%curs_termattrs\fP(3X),
diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x
index e061df200..edd147e73 100644
--- a/man/curs_in_wch.3x
+++ b/man/curs_in_wch.3x
@@ -74,8 +74,9 @@ .SH NOTES
 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO
+\fB\%curs_inch\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
 \fB\%curses\fP(3X),
-\fB\%curs_inch\fP(3X),
-\fB\%curs_inchstr\fP(3X),
-\fB\%curs_instr\fP(3X),
 \fB\%curs_inwstr\fP(3X)
diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x
index fa012b21d..2bdc940cc 100644
--- a/man/curs_in_wchstr.3x
+++ b/man/curs_in_wchstr.3x
@@ -121,8 +121,10 @@ .SH PORTABILITY
 This implementation checks for null pointers,
 returning \fBERR\fP in that case.
 .SH SEE ALSO
+\fB\%curs_inchstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
 \fB\%curses\fP(3X),
-\fB\%curs_inchstr\fP(3X),
-\fB\%curs_instr\fP(3X),
 \fB\%curs_inwstr\fP(3X),
 \fB\%curs_in_wch\fP(3X)
diff --git a/man/curs_inch.3x b/man/curs_inch.3x
index 66f488f8a..91cea7575 100644
--- a/man/curs_inch.3x
+++ b/man/curs_inch.3x
@@ -117,15 +117,10 @@ .SH PORTABILITY
 An application using more bits, e.g., a Unicode value,
 should use the wide-character equivalents to these functions.
 .SH SEE ALSO
-.TP
-\fB\%curses\fP(3X)
-gives an overview of the \fB\%WINDOW\fP and \fB\%chtype\fP data types.
-.TP
-\fB\%curs_attr\fP(3X)
-goes into more detail, pointing out portability problems and
-constraints on the use of \fB\%chtype\fP for returning window
-information.
-.TP
-\fB\%curs_in_wch\fP(3X)
-describes comparable functions for the wide-character (ncursesw)
-library.
+\fB\%curs_in_wch\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its wide-character configuration
+.RI ( \%ncursesw ).
+.PP
+\fB\%curses\fP(3X),
+\fB\%curs_instr\fP(3X)
diff --git a/man/curs_ins_wstr.3x b/man/curs_ins_wstr.3x
index 3bf9b9d08..32ce107e4 100644
--- a/man/curs_ins_wstr.3x
+++ b/man/curs_ins_wstr.3x
@@ -117,7 +117,10 @@ .SH PORTABILITY
 because it is inconsistent with other functions,
 and differs from the X/Open implementation on Solaris.
 .SH SEE ALSO
+\fB\%curs_insstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
 \fB\%curses\fP(3X),
-\fB\%curs_insstr\fP(3X),
 \fB\%curs_ins_wch\fP(3X),
 \fB\%curs_in_wch\fP(3X)
diff --git a/man/curs_instr.3x b/man/curs_instr.3x
index d35a3615b..41129d72d 100644
--- a/man/curs_instr.3x
+++ b/man/curs_instr.3x
@@ -118,8 +118,11 @@ .SH PORTABILITY
 negative value for \fIn\fP.
 In this case, the functions return the string ending at the right margin.
 .SH SEE ALSO
+\fB\%curs_ins_wstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its wide-character configuration
+.RI ( \%ncursesw ).
+.PP
 \fB\%curses\fP(3X),
 \fB\%curs_inch\fP(3X),
-\fB\%curs_inchstr\fP(3X),
-\fB\%curs_inwstr\fP(3X),
-\fB\%curs_in_wchstr\fP(3X)
+\fB\%curs_inchstr\fP(3X)
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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