[PATCH 081/100] man/*.3x: Name metasyntactic variables more consistently (1/3).

[G. Branden Robinson]

* `wc` is always a `wchar_t` (or `wint_t`).
* `wch` is always a curses `cchar_t`.
---
 man/curs_get_wch.3x  |  2 +-
 man/curs_getcchar.3x | 32 ++++++++++++++++----------------
 man/curs_in_wch.3x   | 10 +++++-----
 man/curs_sp_funcs.3x |  2 +-
 man/curs_util.3x     |  6 +++---
 man/form_driver.3x   |  2 +-
 6 files changed, 27 insertions(+), 27 deletions(-)

diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x
index 5297726de..46a37b821 100644
--- a/man/curs_get_wch.3x
+++ b/man/curs_get_wch.3x
@@ -60,7 +60,7 @@ .SH SYNOPSIS
 \fBint mvget_wch(int \fIy\fP, int \fIx\fP, wint_t *\fIwch\fP);
 \fBint mvwget_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wint_t 
*\fIwch\fP);
 .PP
-\fBint unget_wch(const wchar_t \fIwch\fP);
+\fBint unget_wch(const wchar_t \fIwc\fP);
 .fi
 .SH DESCRIPTION
 .SS "Reading Characters"
diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x
index d0c3ba97e..48ff311e2 100644
--- a/man/curs_getcchar.3x
+++ b/man/curs_getcchar.3x
@@ -42,15 +42,15 @@ .SH SYNOPSIS
 \fB#include <curses.h>
 .PP
 \fBint getcchar(
-.B "        const cchar_t *\fIwcval\fP,"
-.B "        wchar_t *\fIwch\fP,"
+.B "        const cchar_t *\fIwch\fP,"
+.B "        wchar_t *\fIwc\fP,"
 .B "        attr_t *\fIattrs\fP,"
 .B "        short *\fIcolor_pair\fP,"
 .B "        void *\fIopts\fP );"
 .PP
 .B "int setcchar("
-.B "        cchar_t *\fIwcval\fP,"
-.B "        const wchar_t *\fIwch\fP,"
+.B "        cchar_t *\fIwch\fP,"
+.B "        const wchar_t *\fIwc\fP,"
 .B "        const attr_t \fIattrs\fP,"
 .B "        short \fIcolor_pair\fP,"
 .B "        const void *\fIopts\fP );"
@@ -59,32 +59,32 @@ .SH DESCRIPTION
 .SS getcchar
 The \fBgetcchar\fP function gets a wide-character string
 and rendition from a \fBcchar_t\fP argument.
-When \fIwch\fP is not a null pointer,
+When \fIwc\fP is not a null pointer,
 the \fBgetcchar\fP function does the following:
 .bP
-Extracts information from a \fBcchar_t\fP value \fIwcval\fP
+Extracts information from a \fBcchar_t\fP value \fIwch\fP
 .bP
 Stores the character attributes in the location pointed to by \fIattrs\fP
 .bP
 Stores the color pair in the location pointed to by \fIcolor_pair\fP
 .bP
 Stores the wide-character string,
-characters referenced by \fIwcval\fP, into the array pointed to by \fIwch\fP.
+characters referenced by \fIwch\fP, into the array pointed to by \fIwc\fP.
 .PP
 When
-\fIwch\fP
+\fIwc\fP
 is a null pointer, the
 \fBgetcchar\fP
 function does the following:
 .bP
-Obtains the number of wide characters pointed to by \fIwcval\fP
+Obtains the number of wide characters pointed to by \fIwch\fP
 .bP
 Does not change the data referenced by
 \fIattrs\fP
 or
 \fIcolor_pair\fP
 .SS setcchar
-The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP
+The \fBsetcchar\fP function initializes the location pointed to by \fIwch\fP
 by using:
 .bP
 The character attributes in
@@ -93,7 +93,7 @@ .SS setcchar
 The color pair in
 \fIcolor_pair\fP
 .bP
-The wide-character string pointed to by \fIwch\fP.
+The wide-character string pointed to by \fIwc\fP.
 The string must be L'\e0' terminated,
 contain at most one spacing character,
 which must be the first.
@@ -104,21 +104,21 @@ .SS setcchar
 The string may contain a single control character instead.
 In that case, no non-spacing characters are allowed.
 .SH RETURN VALUE
-When \fIwch\fP is a null pointer,
+When \fIwc\fP is a null pointer,
 \fBgetcchar\fP returns the number of wide characters referenced by
-\fIwcval\fP,
+\fIwch\fP,
 including one for a trailing null.
 .PP
-When \fIwch\fP is not a null pointer,
+When \fIwc\fP is not a null pointer,
 \fBgetcchar\fP returns \fBOK\fP upon successful completion,
 and \fBERR\fP otherwise.
 .PP
 Upon successful completion, \fBsetcchar\fP returns \fBOK\fP.
 Otherwise, it returns \fBERR\fP.
 .SH NOTES
-The \fIwcval\fP argument may be a value generated by a call to
+The \fIwch\fP argument may be a value generated by a call to
 \fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument.
-If \fIwcval\fP is constructed by any other means, the effect is unspecified.
+If \fIwch\fP is constructed by any other means, the effect is unspecified.
 .SH EXTENSIONS
 X/Open Curses documents the \fIopts\fP argument as reserved for future use,
 saying that it must be null.
diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x
index edd147e73..b88d37629 100644
--- a/man/curs_in_wch.3x
+++ b/man/curs_in_wch.3x
@@ -49,16 +49,16 @@ .SH SYNOPSIS
 .nf
 \fB#include <curses.h>
 .PP
-\fBint in_wch(cchar_t *\fIwcval\fP);
-\fBint win_wch(WINDOW *\fIwin\fP, cchar_t *\fIwcval\fP);
+\fBint in_wch(cchar_t *\fIwch\fP);
+\fBint win_wch(WINDOW *\fIwin\fP, cchar_t *\fIwch\fP);
 .PP
-\fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t *\fIwcval\fP);
-\fBint mvwin_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t 
*\fIwcval\fP);
+\fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t *\fIwch\fP);
+\fBint mvwin_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t 
*\fIwch\fP);
 .fi
 .SH DESCRIPTION
 These functions extract the complex character and rendition from
 the current position in the named window into the \fBcchar_t\fP object
-referenced by wcval.
+referenced by wch.
 .SH RETURN VALUE
 No errors are defined in the XSI Curses standard.
 This implementation checks for null pointers, returns \fBERR\fP in that case.
diff --git a/man/curs_sp_funcs.3x b/man/curs_sp_funcs.3x
index c4c2b1320..7bf67b349 100644
--- a/man/curs_sp_funcs.3x
+++ b/man/curs_sp_funcs.3x
@@ -159,7 +159,7 @@ .SH SYNOPSIS
 \fBchtype termattrs_sp(SCREEN* \fIsp\fP);
 \fBchar* termname_sp(SCREEN* \fIsp\fP);
 \fBint typeahead_sp(SCREEN* \fIsp\fP, int \fIfd\fP);
-\fBint unget_wch_sp(SCREEN* \fIsp\fP, const wchar_t \fIwch\fP);
+\fBint unget_wch_sp(SCREEN* \fIsp\fP, const wchar_t \fIwc\fP);
 \fBint ungetch_sp(SCREEN* \fIsp\fP, int \fIch\fP);
 \fBint ungetmouse_sp(SCREEN* \fIsp\fP, MEVENT* \fIevent\fP);
 \fBint use_default_colors_sp(SCREEN* \fIsp\fP);
diff --git a/man/curs_util.3x b/man/curs_util.3x
index 7e162e959..c81b856c7 100644
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -64,10 +64,10 @@ .SH SYNOPSIS
 \fB#include <curses.h>
 .PP
 \fBconst char *unctrl(chtype \fIc\fP);
-\fBwchar_t *wunctrl(cchar_t *\fIc\fP);
+\fBwchar_t *wunctrl(cchar_t *\fIwch\fP);
 .PP
 \fBconst char *keyname(int \fIc\fP);
-\fBconst char *key_name(wchar_t \fIw\fP);
+\fBconst char *key_name(wchar_t \fIwc\fP);
 .PP
 \fBvoid filter(void);
 .PP
@@ -106,7 +106,7 @@ .SS unctrl
 this follows the X/Open specification.
 .PP
 The corresponding \fBwunctrl\fP returns a printable representation of
-a complex character \fIc\fP.
+a complex character \fIwch\fP.
 .PP
 In both \fBunctrl\fP and \fBwunctrl\fP the attributes and color associated
 with the character parameter are ignored.
diff --git a/man/form_driver.3x b/man/form_driver.3x
index 893f7d816..5cf51fbd1 100644
--- a/man/form_driver.3x
+++ b/man/form_driver.3x
@@ -43,7 +43,7 @@ .SH SYNOPSIS
 \fB#include <form.h>
 .PP
 \fBint form_driver(FORM *\fIform\fP, int \fIc\fP);
-\fBint form_driver_w(FORM *\fIform\fP, int \fIc\fP, wchar_t \fIwch\fP);
+\fBint form_driver_w(FORM *\fIform\fP, int \fIc\fP, wchar_t \fIwc\fP);
 .fi
 .SH DESCRIPTION
 .SS form_driver
-- 
2.30.2

signature.asc
Description: PGP signature