[PATCH 02/30] man/curs_get_wch.3x: Revise and clarify.

[G. Branden Robinson]

Fix misleading discussion arising from excessive copy and paste from
curs_getch.3x.  Neither a wide character nor a curses complex character
is "returned" by `wget_wch()`.  Instead, a wide character is read from
the input queue, processed, and stored in a function argument (through a
dereferenced pointer).

Fix related misnomer in `wunget_wch()`: it places a wide character `wc`
into the input queue, not a curses complex character `wch`.  See
ncurses.3x.
---
 man/curs_get_wch.3x | 18 ++++++++----------
 1 file changed, 8 insertions(+), 10 deletions(-)

diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x
index 3eea1e98f..f56158e8c 100644
--- a/man/curs_get_wch.3x
+++ b/man/curs_get_wch.3x
@@ -122,14 +122,13 @@ .SS "Reading Characters"
 If \fB\%echo\fP(3X) has been called,
 and the window is not a pad,
 .I curses
-writes
-.I wch
+writes the wide character
+from the input queue
 to the window
 (at the cursor position)
 per the following rules.
 .bP
-If
-.I wch
+If the wide character
 matches the terminal's erase character,
 the cursor moves leftward one position
 and the new position is erased
@@ -143,7 +142,7 @@ .SS "Reading Characters"
 .bP
 .I curses
 writes any other
-.I wch
+wide character
 to the window,
 as with \fB\%wecho_wchar\fP(3X).
 .bP
@@ -156,18 +155,17 @@ .SS "Reading Characters"
 .B \%wrefresh
 on it.
 .PP
-If
-.I wch
+If the wide character
 is a carriage return and \fBnl\fP(3X) has been called,
 .B \%wgetch
-stores the the character code for line feed in
+stores the the wide character code for line feed in
 .I wch
 instead.
 .SS "Ungetting Characters"
 .B \%unget_wch
 places
-.I wch
-into the input queue to be returned by the next call to
+.I wc
+into the input queue to be retrieved by the next call to
 .BR \%wget_wch "."
 A single input queue serves all windows associated with the terminal.
 .SH RETURN VALUE
-- 
2.30.2

signature.asc
Description: PGP signature