[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 082/100] man/*.3x: Name metasyntactic variables more consistently
From: |
G. Branden Robinson |
Subject: |
[PATCH 082/100] man/*.3x: Name metasyntactic variables more consistently (2/3). |
Date: |
Sat, 30 Mar 2024 17:01:26 -0500 |
* `c` is always a `char` or `int`.
* `ch` is always a curses `chtype`.
---
man/curs_getch.3x | 14 +++++++-------
man/curs_sp_funcs.3x | 12 ++++++------
man/curs_termattrs.3x | 12 ++++++------
man/curs_trace.3x | 2 +-
man/curs_util.3x | 4 ++--
5 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index 5b8a7b5ae..21d89edf7 100644
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -67,11 +67,11 @@ .SH SYNOPSIS
.B int mvgetch(int \fIy\fP, int \fIx\fP);
.B int mvwgetch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP);
.PP
-.B int ungetch(int \fIch\fP);
+.B int ungetch(int \fIc\fP);
.PP
.\" XXX: Move has_key into its own page like define_key and key_defined?
\fI/* extension */\fP
-.B int has_key(int \fIch\fP);
+.B int has_key(int \fIc\fP);
.fi
.SH DESCRIPTION
.SS "Reading Characters"
@@ -116,13 +116,13 @@ .SS "Reading Characters"
and the window is not a pad,
.I curses
writes the returned character
-.I ch
+.I c
to the window
(at the cursor position)
per the following rules.
.bP
If
-.I ch
+.I c
matches the terminal's erase character,
the cursor moves leftward one position
and the new position is erased
@@ -136,7 +136,7 @@ .SS "Reading Characters"
.bP
.I curses
writes any other
-.I ch
+.I c
to the window,
as with \fB\%wechochar\fP(3X).
.bP
@@ -147,7 +147,7 @@ .SS "Reading Characters"
.BR \%wrefresh .
.PP
If
-.I ch
+.I c
is a carriage return and \fBnl\fP(3X) has been called,
.B \%wgetch
returns the character code for newline
@@ -244,7 +244,7 @@ .SS "Keypad Mode"
.SS "Ungetting Characters"
.B \%ungetch
places
-.I ch
+.I c
into the input queue to be returned by the next call to
.BR \%wgetch .
A single input queue serves all windows.
diff --git a/man/curs_sp_funcs.3x b/man/curs_sp_funcs.3x
index 7bf67b349..7f5496238 100644
--- a/man/curs_sp_funcs.3x
+++ b/man/curs_sp_funcs.3x
@@ -63,7 +63,7 @@ .SH SYNOPSIS
\fBint echo_sp(SCREEN* \fIsp\fP);
\fBint endwin_sp(SCREEN* \fIsp\fP);
\fBchar erasechar_sp(SCREEN* \fIsp\fP);
-\fBint erasewchar_sp(SCREEN* \fIsp\fP, wchar_t *\fIch\fP);
+\fBint erasewchar_sp(SCREEN* \fIsp\fP, wchar_t *\fIwc\fP);
\fBint extended_color_content_sp(SCREEN * \fIsp\fP, int \fIcolor\fP, int *
\fIr\fP, int * \fIg\fP, int * \fIb\fP);
\fBint extended_pair_content_sp(SCREEN* \fIsp\fP, int \fIpair\fP, int *
\fIfg\fP, int * \fIbg\fP);
\fBint extended_slk_color_sp(SCREEN* \fIsp\fP, int \fIpair\fP);
@@ -81,7 +81,7 @@ .SH SYNOPSIS
.PP
\fBbool has_ic_sp(SCREEN* \fIsp\fP);
\fBbool has_il_sp(SCREEN* \fIsp\fP);
-\fBint has_key_sp(SCREEN* \fIsp\fP, int \fIch\fP);
+\fBint has_key_sp(SCREEN* \fIsp\fP, int \fIc\fP);
\fBbool has_mouse_sp(SCREEN* \fIsp\fP);
\fBint init_color_sp(SCREEN* \fIsp\fP, short \fIcolor\fP, short \fIr\fP, short
\fIg\fP, short \fIb\fP);
\fBint init_extended_color_sp(SCREEN* \fIsp\fP, int \fIcolor\fP, int \fIr\fP,
int \fIg\fP, int \fIb\fP);
@@ -101,7 +101,7 @@ .SH SYNOPSIS
\fBint keyok_sp(SCREEN* \fIsp\fP, int \fIkeycode\fP, bool \fIenable\fP);
\fBchar killchar_sp(SCREEN* \fIsp\fP);
.PP
-\fBint killwchar_sp(SCREEN* \fIsp\fP, wchar_t *\fIch\fP);
+\fBint killwchar_sp(SCREEN* \fIsp\fP, wchar_t *\fIwc\fP);
\fBchar* longname_sp(SCREEN* \fIsp\fP);
\fBint mcprint_sp(SCREEN* \fIsp\fP, char *\fIdata\fP, int \fIlen\fP);
\fBint mouseinterval_sp(SCREEN* \fIsp\fP, int \fIerval\fP);
@@ -160,7 +160,7 @@ .SH SYNOPSIS
\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 \fIwc\fP);
-\fBint ungetch_sp(SCREEN* \fIsp\fP, int \fIch\fP);
+\fBint ungetch_sp(SCREEN* \fIsp\fP, int \fIc\fP);
\fBint ungetmouse_sp(SCREEN* \fIsp\fP, MEVENT* \fIevent\fP);
\fBint use_default_colors_sp(SCREEN* \fIsp\fP);
\fBvoid use_env_sp(SCREEN* \fIsp\fP, bool \fIbf\fP);
@@ -171,7 +171,7 @@ .SH SYNOPSIS
\fBint vid_puts_sp(SCREEN* \fIsp\fP, attr_t \fIattrs\fP, short \fIpair\fP,
void * \fIopts\fP, NCURSES_SP_OUTC \fIputc\fP);
\fBint vidattr_sp(SCREEN* \fIsp\fP, chtype \fIattrs\fP);
\fBint vidputs_sp(SCREEN* \fIsp\fP, chtype \fIattrs\fP, NCURSES_SP_OUTC
\fIputc\fP);
-\fBwchar_t* wunctrl_sp(SCREEN* \fIsp\fP, cchar_t *\fIch\fP);
+\fBwchar_t* wunctrl_sp(SCREEN* \fIsp\fP, cchar_t *\fIwch\fP);
.PP
\fB#include <form.h>
.PP
@@ -208,7 +208,7 @@ .SH SYNOPSIS
.PP
\fB#include <unctrl.h>
.PP
-\fBNCURSES_CONST char* unctrl_sp(SCREEN* \fIsp\fP, chtype \fIc\fP);
+\fBNCURSES_CONST char* unctrl_sp(SCREEN* \fIsp\fP, chtype \fIch\fP);
.fi
.SH DESCRIPTION
This implementation can be configured to provide a set of functions which
diff --git a/man/curs_termattrs.3x b/man/curs_termattrs.3x
index 9c63afc04..cb750fd77 100644
--- a/man/curs_termattrs.3x
+++ b/man/curs_termattrs.3x
@@ -48,11 +48,11 @@ .SH SYNOPSIS
.PP
\fBint baudrate(void);
\fBchar erasechar(void);
-\fBint erasewchar(wchar_t *\fIch\fP);
+\fBint erasewchar(wchar_t *\fIwc\fP);
\fBbool has_ic(void);
\fBbool has_il(void);
\fBchar killchar(void);
-\fBint killwchar(wchar_t *\fIch\fP);
+\fBint killwchar(wchar_t *\fIwc\fP);
\fBchar *longname(void);
\fBattr_t term_attrs(void);
\fBchtype termattrs(void);
@@ -68,9 +68,9 @@ .SS "erasechar, erasewchar"
The \fBerasechar\fP routine returns the user's current erase character.
.PP
The \fBerasewchar\fP routine stores the current erase character
-in the location referenced by \fIch\fP.
+in the location referenced by \fIwc\fP.
If no erase character has been defined, the routine fails
-and the location referenced by \fIch\fP is not changed.
+and the location referenced by \fIwc\fP is not changed.
.SS "has_ic, has_il"
The \fBhas_ic\fP routine is true if the terminal has insert- and delete-
character capabilities.
@@ -84,9 +84,9 @@ .SS "killchar, killwchar"
The \fBkillchar\fP routine returns the user's current line kill character.
.PP
The \fBkillwchar\fP routine stores the current line-kill character
-in the location referenced by \fIch\fP.
+in the location referenced by \fIwc\fP.
If no line-kill character has been defined,
-the routine fails and the location referenced by \fIch\fP is not changed.
+the routine fails and the location referenced by \fIwc\fP is not changed.
.SS longname
The \fBlongname\fP routine returns a pointer to a static area
containing a verbose description of the current terminal.
diff --git a/man/curs_trace.3x b/man/curs_trace.3x
index b985ffb32..01650fed4 100644
--- a/man/curs_trace.3x
+++ b/man/curs_trace.3x
@@ -82,7 +82,7 @@ .SH SYNOPSIS
\fBchar *_traceattr2(int \fIbuffer\fP, chtype \fIch\fP);
\fBchar *_tracecchar_t(const cchar_t *\fIstring\fP);
\fBchar *_tracecchar_t2(int \fIbuffer\fP, const cchar_t *\fIstring\fP);
-\fBchar *_tracechar(int \fIch\fP);
+\fBchar *_tracechar(int \fIc\fP);
\fBchar *_tracechtype(chtype \fIch\fP);
\fBchar *_tracechtype2(int \fIbuffer\fP, chtype \fIch\fP);
.PP
diff --git a/man/curs_util.3x b/man/curs_util.3x
index c81b856c7..c9e844522 100644
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -63,7 +63,7 @@ .SH SYNOPSIS
.nf
\fB#include <curses.h>
.PP
-\fBconst char *unctrl(chtype \fIc\fP);
+\fBconst char *unctrl(chtype \fIch\fP);
\fBwchar_t *wunctrl(cchar_t *\fIwch\fP);
.PP
\fBconst char *keyname(int \fIc\fP);
@@ -86,7 +86,7 @@ .SH SYNOPSIS
.SH DESCRIPTION
.SS unctrl
The \fBunctrl\fP routine returns a character string which is a printable
-representation of the character \fIc\fP:
+representation of the character \fIch\fP:
.bP
Printable characters are displayed as themselves,
e.g., a one-character string containing the key.
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 082/100] man/*.3x: Name metasyntactic variables more consistently (2/3).,
G. Branden Robinson <=