[PATCH 01/17] man/curs_add*: Rationalize man page cross-references.

[G. Branden Robinson]

Make wide-character functions' man pages refer primarily to each other
(or to width-agnostic pages).

Do similarly for functions of the non-wide-character configuration.

Add separate cross reference to a wide/non-wide function's counterpart,
explicitly identifying it as such, to aid users reading about the
"wrong" API.

* man/curs_add_wch.3x (SEE ALSO):
  - Drop cross reference to addch() in unadorned list.
  - Add cross references to add_wchstr() and addwstr().
  - Add counterpart cross reference to addch().

* man/curs_add_wchstr.3x (SEE ALSO):
  - Drop cross references to addch(), addchstr(), and addstr() in
    unadorned list.
  - Add counterpart cross reference to addchstr().

* man/curs_addch.3x (SEE ALSO):
  - Add cross references to addchstr() and addstr() in unadorned list.
  - Recast counterpart cross reference to add_wch() to favor active
    voice over passive.

* man/curs_addchstr.3x (SEE ALSO):
  - Drop cross references to addwstr() and add_wchstr() in unadorned
    list.
  - Add counterpart cross reference to add_wchstr().

* man/curs_addstr.3x (SEE ALSO):
  - Drop cross references to addwstr() and add_wchstr() in unadorned
    list.
  - Add counterpart cross reference to addwstr().

* man/curs_addwstr.3x (SEE ALSO):
  - Drop cross references to addch(), addchstr(), and addstr() in
    unadorned list.
  - Add counterpart cross reference to addstr().
---
 man/curs_add_wch.3x    |  7 ++++++-
 man/curs_add_wchstr.3x | 11 ++++++-----
 man/curs_addch.3x      |  9 ++++++---
 man/curs_addchstr.3x   |  9 ++++++---
 man/curs_addstr.3x     |  9 ++++++---
 man/curs_addwstr.3x    |  7 ++++---
 6 files changed, 34 insertions(+), 18 deletions(-)

diff --git a/man/curs_add_wch.3x b/man/curs_add_wch.3x
index 70d849f1c..0e63e12d8 100644
--- a/man/curs_add_wch.3x
+++ b/man/curs_add_wch.3x
@@ -425,10 +425,15 @@ .SS "Complex Characters"
 (base) spacing character.
 .SH SEE ALSO
 \fB\%curses\fP(3X),
-\fB\%curs_addch\fP(3X),
+\fB\%curs_add_wchstr\fP(3X),
+\fB\%curs_addwstr\fP(3X),
 \fB\%curs_attr\fP(3X),
 \fB\%curs_clear\fP(3X),
 \fB\%curs_getcchar\fP(3X),
 \fB\%curs_outopts\fP(3X),
 \fB\%curs_refresh\fP(3X),
 \fB\%putwc\fP(3)
+.PP
+\fB\%curs_addch\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x
index c53b812c4..016df8a45 100644
--- a/man/curs_add_wchstr.3x
+++ b/man/curs_add_wchstr.3x
@@ -118,8 +118,9 @@ .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_addchstr\fP(3X),
-\fB\%curs_addstr\fP(3X),
-\fB\%curs_addwstr\fP(3X),
-\fB\%curs_add_wch\fP(3X)
+\fB\%curs_add_wch\fP(3X),
+\fB\%curs_addwstr\fP(3X)
+.PP
+\fB\%curs_addchstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
diff --git a/man/curs_addch.3x b/man/curs_addch.3x
index b87f76637..d8929ae8d 100644
--- a/man/curs_addch.3x
+++ b/man/curs_addch.3x
@@ -316,6 +316,8 @@ .SS TABSIZE
 This is true of other implementations, but is not documented.
 .SH SEE ALSO
 \fB\%curses\fP(3X),
+\fB\%curs_addchstr\fP(3X),
+\fB\%curs_addstr\fP(3X),
 \fB\%curs_attr\fP(3X),
 \fB\%curs_clear\fP(3X),
 \fB\%curs_inch\fP(3X),
@@ -324,6 +326,7 @@ .SH SEE ALSO
 \fB\%curs_variables\fP(3X),
 \fB\%putc\fP(3)
 .PP
-Comparable functions in the wide-character (ncursesw) library are
-described in
-\fB\%curs_add_wch\fP(3X).
+\fB\%curs_add_wch\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its wide-character configuration
+.RI ( \%ncursesw ).
diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x
index 9e8db9860..5e56f29b6 100644
--- a/man/curs_addchstr.3x
+++ b/man/curs_addchstr.3x
@@ -113,6 +113,9 @@ .SH PORTABILITY
 .SH SEE ALSO
 \fB\%curses\fP(3X),
 \fB\%curs_addch\fP(3X),
-\fB\%curs_addstr\fP(3X),
-\fB\%curs_addwstr\fP(3X),
-\fB\%curs_add_wchstr\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 ).
diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x
index 8db64ada9..fc2c5d106 100644
--- a/man/curs_addstr.3x
+++ b/man/curs_addstr.3x
@@ -103,6 +103,9 @@ .SH PORTABILITY
 .SH SEE ALSO
 \fB\%curses\fP(3X),
 \fB\%curs_addch\fP(3X),
-\fB\%curs_addchstr\fP(3X),
-\fB\%curs_addwstr\fP(3X),
-\fB\%curs_add_wchstr\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 ).
diff --git a/man/curs_addwstr.3x b/man/curs_addwstr.3x
index ff8240bc9..0c82ed3cb 100644
--- a/man/curs_addwstr.3x
+++ b/man/curs_addwstr.3x
@@ -110,8 +110,9 @@ .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_addchstr\fP(3X),
-\fB\%curs_addstr\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.
-- 
2.30.2

signature.asc
Description: PGP signature