[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 22/40] man/curs_*.3x: Fix style nit.
From: |
G. Branden Robinson |
Subject: |
[PATCH 22/40] man/curs_*.3x: Fix style nit. |
Date: |
Sat, 1 Feb 2025 11:32:26 -0600 |
Set macro names and other C symbols in italics, not bold, when referring
to them generically, as opposed to the ncurses topic/implementation, in
the "PORTABILITY" and "HISTORY" sections.
---
man/curs_add_wch.3x | 14 +++++++-------
man/curs_addch.3x | 40 ++++++++++++++++++++--------------------
man/curs_beep.3x | 2 +-
man/curs_get_wch.3x | 2 +-
man/curs_getcchar.3x | 2 +-
man/curs_getch.3x | 24 ++++++++++++------------
man/curs_initscr.3x | 40 ++++++++++++++++++++--------------------
7 files changed, 62 insertions(+), 62 deletions(-)
diff --git a/man/curs_add_wch.3x b/man/curs_add_wch.3x
index 9f23fdac9..45b98ac88 100644
--- a/man/curs_add_wch.3x
+++ b/man/curs_add_wch.3x
@@ -450,23 +450,23 @@ .SH PORTABILITY
locale.
X/Open Curses makes it clear that the WACS_ symbols should be defined as
a pointer to
-.B \%cchar_t
+.I \%cchar_t
data, e.g., in the discussion of
-.BR \%border_set "."
+.IR \%border_set "."
A few implementations are problematic:
.bP
NetBSD curses defines the symbols as a
-.B \%wchar_t
+.I \%wchar_t
within a
-.BR \%cchar_t "."
+.IR \%cchar_t "."
.bP
HP-UX curses equates some of the
-.B \%ACS_
+.I \%ACS_
symbols
to the analogous
-.B \%WACS_
+.I \%WACS_
symbols as if the
-.B \%ACS_
+.I \%ACS_
symbols were
wide characters.
The misdefined symbols are the arrows
diff --git a/man/curs_addch.3x b/man/curs_addch.3x
index 118647fc8..c9cdfb790 100644
--- a/man/curs_addch.3x
+++ b/man/curs_addch.3x
@@ -331,7 +331,7 @@ .SH PORTABILITY
locale.
.SS "ACS Symbols"
X/Open Curses states that the
-.B \%ACS_
+.I \%ACS_
definitions are
.I char
constants.
@@ -344,12 +344,12 @@ .SS "ACS Symbols"
others define them as elements of an array.
.IP
This implementation uses an array,
-.BR \%acs_map ,
+.IR \%acs_map ,
as did SVr4
.IR curses .
NetBSD also uses an array,
actually named
-.BR \%_acs_char ,
+.IR \%_acs_char ,
with a
.B \%#define
for compatibility.
@@ -357,11 +357,11 @@ .SS "ACS Symbols"
HP-UX
.I curses
equates some of the
-.B \%ACS_
+.I \%ACS_
symbols to the analogous
-.B \%WACS_
+.I \%WACS_
symbols as if the
-.B \%ACS_
+.I \%ACS_
symbols were wide characters
(see \fB\%curs_add_wch\fP(3X)).
The misdefined symbols are the arrows and others that are not used for
@@ -371,7 +371,7 @@ .SS "ACS Symbols"
(Issues\ 2 through 7)
has a typographical error
for the
-.B \%ACS_LANTERN
+.I \%ACS_LANTERN
symbol, equating its \*(``VT100+ Character\*('' to \*(``I\*(''
(capital I),
while the header files for SVr4
@@ -392,14 +392,14 @@ .SS "ACS Symbols"
description uses lowercase i.
.PP
Some ACS symbols
-.RB \%( ACS_S3 ,
-.BR \%ACS_S7 ,
-.BR \%ACS_LEQUAL ,
-.BR \%ACS_GEQUAL ,
-.BR \%ACS_PI ,
-.BR \%ACS_NEQUAL ,
+.RI \%( ACS_S3 ","
+.IR \%ACS_S7 ","
+.IR \%ACS_LEQUAL ","
+.IR \%ACS_GEQUAL ","
+.IR \%ACS_PI ","
+.IR \%ACS_NEQUAL ","
and
-.BR \%ACS_STERLING )
+.IR \%ACS_STERLING ")"
were not documented in any publicly released System\ V.
.\" And did not exist yet as late as SVr4.
.\" https://github.com/ryanwoodsmall/oldsysv/blob/master/\
@@ -421,7 +421,7 @@ .SS "ACS Symbols"
The
.I displayed
values of
-.B \%ACS_
+.I \%ACS_
constants depend on
.bP
the
@@ -442,7 +442,7 @@ .SS "ACS Symbols"
environment variable in \fB\%ncurses\fP(3X).
.SS "Character Set"
X/Open Curses assumes that the parameter passed to
-.B \%waddch
+.I \%waddch
contains a single character.
That character may have been more than eight bits wide in an SVr3 or
SVr4 implementation,
@@ -454,7 +454,7 @@ .SS "Character Set"
attributes and a color pair identifier into a
.I \%chtype
for passage to
-.B \%waddch
+.I \%waddch
is common.
A portable application uses only the macros discussed in
\fB\%curs_attr\fP(3X) to manipulate a
@@ -466,10 +466,10 @@ .SS "Character Set"
holds an eight-bit character,
but the library allows a multibyte character sequence to be passed via a
succession of calls to
-.BR \%waddch "."
+.IR \%waddch "."
Other implementations do not;
a
-.B \%waddch
+.I \%waddch
call transmits exactly one character,
which may be rendered in one or more screen locations depending on
whether it is printable
@@ -477,7 +477,7 @@ .SS "Character Set"
Depending on the locale,
.I \%ncurses
inspects the byte passed in each
-.B \%waddch
+.I \%waddch
call and checks whether the latest call continues a multibyte character.
When a character is
.IR complete ","
diff --git a/man/curs_beep.3x b/man/curs_beep.3x
index 3d29aa7c6..7eb008dcb 100644
--- a/man/curs_beep.3x
+++ b/man/curs_beep.3x
@@ -97,7 +97,7 @@ .SH PORTABILITY
On SVr4
.IR curses ","
they always return
-.BR OK ","
+.IR OK ","
and X/Open Curses specifies them as doing so.
.SH HISTORY
SVr2 (1984)
diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x
index ea7a793dd..3497039be 100644
--- a/man/curs_get_wch.3x
+++ b/man/curs_get_wch.3x
@@ -248,7 +248,7 @@ .SH PORTABILITY
.PP
See the \*(``PORTABILITY\*('' section of \fB\%wgetch\fP(3X) regarding
the interaction of
-.B \%wget_wch
+.I \%wget_wch
with signal handlers.
.SH HISTORY
X/Open Curses Issue\ 4 (1995) initially specified these functions.
diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x
index 1a802c65e..82a365b19 100644
--- a/man/curs_getcchar.3x
+++ b/man/curs_getcchar.3x
@@ -274,7 +274,7 @@ .SH PORTABILITY
attributes
(at least 15 bits' worth,
inferred from the count of specified
-.B WA_
+.I WA_
constants),
.\" See X/Open Curses Issue 7, p. 307.
.bP
diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index 2bc54c12e..f10869de5 100644
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -648,16 +648,16 @@ .SH PORTABILITY
\*(``an integer value other than
.IR ERR \*(''. \" Courier roman in source; SVID 4, vol. 3, p. 494
.PP
-.B \%wgetch
+.I \%wgetch
reads only single-byte characters.
.PP
The echo behavior of these functions on input of
-.B KEY_
+.I KEY_
or backspace characters is not documented in SVr4
.IR curses "."
.PP
The behavior of
-.B \%wgetch
+.I \%wgetch
in the presence of signal handlers is not documented in SVr4
.I curses
and is unspecified by X/Open Curses.
@@ -673,18 +673,18 @@ .SH PORTABILITY
.I curses
application prepares for two cases:
(a) signal receipt does not interrupt
-.BR \%wgetch ";"
+.IR \%wgetch ";"
or
(b) signal receipt interrupts
-.B \%wgetch
+.I \%wgetch
and causes it to return
-.B ERR
+.I ERR
with
-.B \%errno
+.I \%errno
set to
-.BR \%EINTR "."
+.IR \%EINTR "."
.PP
-.B \%KEY_MOUSE
+.I \%KEY_MOUSE
is mentioned in X/Open Curses,
along with a few related
.I \%term\%info
@@ -694,9 +694,9 @@ .SH PORTABILITY
.I \%ncurses
is an extension.
.PP
-.B \%KEY_RESIZE
+.I \%KEY_RESIZE
and
-.B \%has_key
+.I \%has_key
are extensions first implemented for
.IR \%ncurses "."
By 2022,
@@ -707,7 +707,7 @@ .SH PORTABILITY
.I curses
.\"
https://web.archive.org/web/20200923185647/https://man.netbsd.org/curses_input.3
had added them along with
-.BR \%KEY_MOUSE "."
+.IR \%KEY_MOUSE "."
.SH SEE ALSO
ECMA-6 \*(``7-bit coded Character Set\*(''
\%<https://\*:ecma\-international\*:.org/\
diff --git a/man/curs_initscr.3x b/man/curs_initscr.3x
index 18eebc7c9..ba3459ff7 100644
--- a/man/curs_initscr.3x
+++ b/man/curs_initscr.3x
@@ -413,21 +413,21 @@ .SH PORTABILITY
.SS Differences
X/Open Curses specifies that portable applications must not
call
-.B \%initscr
+.I \%initscr
more than once:
.bP
The portable way to use
-.B \%initscr
+.I \%initscr
is once only,
using
-.B \%refresh
+.I \%refresh
to restore the screen after
-.BR \%endwin "."
+.IR \%endwin "."
.bP
This implementation allows using
-.B \%initscr
+.I \%initscr
after
-.BR \%endwin "."
+.IR \%endwin "."
.PP
.I \%initscr
in BSD
@@ -448,11 +448,11 @@ .SS Differences
in X/Open Curses.
.PP
Calling
-.B \%endwin
-does not dispose of the memory allocated in
-.B \%initscr
+.I \%endwin
+does not dispose of the memory allocated by
+.I \%initscr
or
-.BR \%newterm "."
+.IR \%newterm "."
Deleting a
.I SCREEN
provides a way to do this:
@@ -460,12 +460,12 @@ .SS Differences
X/Open Curses does not say what happens to
.IR \%WINDOW s
when
-.B \%delscreen
+.I \%delscreen
\*(``frees storage associated with the
.IR SCREEN "\*(''"
nor does the SVr4 documentation help,
adding that it should be called after
-.B \%endwin
+.I \%endwin
if a
.I SCREEN
is no longer needed.
@@ -475,24 +475,24 @@ .SS Differences
are implicitly associated with a
.IR SCREEN "."
so that it is reasonable to expect
-.B \%delscreen
+.I \%delscreen
to deal with these.
.bP
SVr4 curses deletes the standard
.I \%WINDOW
structures
-.B \%stdscr
+.I \%stdscr
and
-.B \%curscr
+.I \%curscr
as well as a work area
-.BR \%newscr "."
+.IR \%newscr "."
SVr4 curses ignores other windows.
.bP
Since version 4.0 (1996),
.I \%ncurses
has maintained a list of all windows for each screen,
using that information to delete those windows when
-.B \%delscreen
+.I \%delscreen
is
called.
.bP
@@ -509,13 +509,13 @@ .SS "High-level versus Low-level"
For example,
.I SCREEN
(returned by
-.BR \%newterm ")"
+.IR \%newterm ")"
and
.I \%TERMINAL
(returned by \fB\%setupterm\fP(3X)) hold file
descriptors for the output stream.
If an application switches screens using
-.BR \%set_term ","
+.IR \%set_term ","
or switches terminals using \fB\%set_curterm\fP(3X),
applications which use the output file descriptor can have different
behavior depending on which structure holds the corresponding descriptor.
@@ -545,7 +545,7 @@ .SS "Unset \fITERM\fP Variable"
If the
.I TERM
variable is missing or empty,
-.B \%initscr
+.I \%initscr
uses the value \*(``unknown\*('',
which normally corresponds to a terminal entry with the
.B \%generic
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 22/40] man/curs_*.3x: Fix style nit.,
G. Branden Robinson <=