bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH v2 03/18] Set more literals in bold.


From: G. Branden Robinson
Subject: [PATCH v2 03/18] Set more literals in bold.
Date: Sat, 23 Sep 2023 06:56:28 -0500

Set "ENODEV", "ENOMEM", "NCURSES_VERSION", "WINDOW", and "NULL" literals
in bold.  Including terminfo capability names.

* man/curs_getyx.3x:
* man/curs_inopts.3x:
* man/curs_legacy.3x:
* man/curs_mouse.3x:
* man/curs_opaque.3x:
* man/curs_print.3x:
* man/curs_slk.3x:
* man/curs_util.3x:
* man/define_key.3x:
* man/key_defined.3x:
* man/keybound.3x:
* man/keyok.3x:
* man/new_pair.3x: Do it.
---
 man/curs_getyx.3x    |  8 ++++----
 man/curs_inopts.3x   |  2 +-
 man/curs_legacy.3x   |  2 +-
 man/curs_mouse.3x    |  6 +++---
 man/curs_opaque.3x   | 10 +++++-----
 man/curs_print.3x    |  4 ++--
 man/curs_slk.3x      | 44 ++++++++++++++++++++++----------------------
 man/curs_terminfo.3x |  2 +-
 man/curs_util.3x     |  2 +-
 man/define_key.3x    |  2 +-
 man/key_defined.3x   |  2 +-
 man/keybound.3x      |  6 +++---
 man/keyok.3x         |  2 +-
 man/new_pair.3x      |  2 +-
 14 files changed, 47 insertions(+), 47 deletions(-)

diff --git a/man/curs_getyx.3x b/man/curs_getyx.3x
index ebed93b9..11501d2d 100644
--- a/man/curs_getyx.3x
+++ b/man/curs_getyx.3x
@@ -81,16 +81,16 @@ .SH PORTABILITY
 for compatibility with older versions of curses.
 .PP
 Although X/Open Curses does not address this,
-many implementations provide members of the WINDOW structure
+many implementations provide members of the \fBWINDOW\fP structure
 containing values corresponding to these macros.
-For best portability, do not rely on using the data in WINDOW,
-since some implementations make WINDOW opaque (do not allow
+For best portability, do not rely on using the data in \fBWINDOW\fP,
+since some implementations make \fBWINDOW\fP opaque (do not allow
 direct use of its members).
 .PP
 Besides the problem of opaque structures,
 the data stored in like-named members may not have like-values in
 different implementations.
-For example, the WINDOW._maxx and WINDOW._maxy values in ncurses
+For example, the \fBWINDOW._maxx\fP and \fBWINDOW._maxy\fP values in 
\fIncurses\fP
 have (at least since release 1.8.1) differed by one from some
 other implementations.
 The difference is hidden by means of the macro \fBgetmaxyx\fP.
diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x
index 01f0448c..6e8b7392 100644
--- a/man/curs_inopts.3x
+++ b/man/curs_inopts.3x
@@ -309,7 +309,7 @@ .SH EXTENSIONS
 These routines are specific to ncurses.
 They were not supported on Version 7, BSD or System V implementations.
 It is recommended that any code depending on ncurses extensions
-be conditioned using NCURSES_VERSION.
+be conditioned using \fBNCURSES_VERSION\fP.
 .SH PORTABILITY
 Except as noted in the section on extensions,
 these functions are described in the XSI Curses standard, Issue 4.
diff --git a/man/curs_legacy.3x b/man/curs_legacy.3x
index b36c9bb6..34b33343 100644
--- a/man/curs_legacy.3x
+++ b/man/curs_legacy.3x
@@ -100,7 +100,7 @@ .SH NOTES
 The standard forms such as \fBgetyx\fP must be implemented as macros,
 and (in this implementation) are defined in terms of the functions
 described here,
-to avoid reliance on internal details of the WINDOW structure.
+to avoid reliance on internal details of the \fB\%WINDOW\fP structure.
 .SH PORTABILITY
 These functions were supported on Version 7, BSD or System V implementations.
 None of those implementations checked the window parameter.
diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x
index dcbeaf01..35dd1be6 100644
--- a/man/curs_mouse.3x
+++ b/man/curs_mouse.3x
@@ -111,7 +111,7 @@ .SS mousemask
 or if the terminal does not support mouse-events,
 this function returns 0.
 .bP
-If \fIoldmask\fP is non-NULL,
+If \fIoldmask\fP is non-\fBNULL\fP,
 this function fills the indicated location with the previous value of the
 current screen's mouse event mask.
 .PP
@@ -206,7 +206,7 @@ .SS wmouse_trafo
 through the pointers.
 If the conversion was successful, the function returns \fBTRUE\fP.
 .bP
-If one of the parameters was NULL or the location is
+If one of the parameters was \fBNULL\fP or the location is
 not inside the window, \fBFALSE\fP is returned.
 .bP
 If \fIto_screen\fP is
@@ -216,7 +216,7 @@ .SS wmouse_trafo
 window \fIwin\fP encloses this point.
 In this case the function returns \fBTRUE\fP.
 .bP
-If one of the parameters is NULL or the point is not inside the
+If one of the parameters is \fBNULL\fP or the point is not inside the
 window, \fBFALSE\fP is returned.
 The referenced coordinates
 are only replaced by the converted coordinates if the transformation was
diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x
index bf64a398..cfb0502c 100644
--- a/man/curs_opaque.3x
+++ b/man/curs_opaque.3x
@@ -72,8 +72,8 @@ .SH SYNOPSIS
 .fi
 .SH DESCRIPTION
 This implementation provides functions which return properties
-set in the WINDOW structure, allowing it to be \*(``opaque\*('' if
-the symbol \fBNCURSES_OPAQUE\fP is defined:
+set in the \fBWINDOW\fP structure, allowing it to be \*(``opaque\*('' if
+the symbol \fB\%NCURSES_OPAQUE\fP is defined:
 .TP 5
 \fBis_cleared\fP
 returns the value set in \fBclearok\fP(3X)
@@ -117,8 +117,8 @@ .SH DESCRIPTION
 returns the delay timeout as set in \fBwtimeout\fP(3X).
 .TP 5
 \fBwgetparent\fP
-returns the parent WINDOW pointer for subwindows,
-or NULL for windows having no parent.
+returns the parent \fBWINDOW\fP pointer for subwindows,
+or \fBNULL\fP for windows having no parent.
 .TP 5
 \fBwgetscrreg\fP
 returns the top and bottom rows for the scrolling margin
@@ -131,7 +131,7 @@ .SH PORTABILITY
 These routines are specific to ncurses.
 They were not supported on Version 7, BSD or System V implementations.
 It is recommended that any code depending on ncurses extensions
-be conditioned using NCURSES_VERSION.
+be conditioned using \fBNCURSES_VERSION\fP.
 .SH SEE ALSO
 \fBcurses\fP(3X),
 \fBcurs_inopts\fP(3X),
diff --git a/man/curs_print.3x b/man/curs_print.3x
index 022cd98b..75d8c002 100644
--- a/man/curs_print.3x
+++ b/man/curs_print.3x
@@ -55,10 +55,10 @@ .SH RETURN VALUE
 In this case, \fBerrno\fP will contain either an error associated
 with \fBwrite\fP(2) or one of the following:
 .TP 5
-ENODEV
+\fBENODEV\fP
 Capabilities for printer redirection do not exist.
 .TP 5
-ENOMEM
+\fBENOMEM\fP
 Couldn't allocate sufficient memory to buffer the printer write.
 .PP
 When \fBmcprint\fP succeeds, it returns the number of characters actually
diff --git a/man/curs_slk.3x b/man/curs_slk.3x
index 8167174c..b38d6aed 100644
--- a/man/curs_slk.3x
+++ b/man/curs_slk.3x
@@ -88,7 +88,7 @@ .SH SYNOPSIS
 \fBint extended_slk_color(int \fIpair\fB);\fR
 .fi
 .SH DESCRIPTION
-The slk* functions manipulate the set of soft function-key labels that exist on
+The \fBslk\fP* functions manipulate the set of soft function-key labels that 
exist on
 many terminals.
 For those terminals that do not have soft labels,
 \fBcurses\fP takes over the bottom line of \fBstdscr\fP, reducing the size of
@@ -204,12 +204,12 @@ .SH RETURN VALUE
 \fBslk_attr_set\fP
 returns an error
 if the terminal or the softkeys were not initialized, or
-the color pair is outside the range 0..COLOR_PAIRS\-1.
+the color pair is outside the range 0..\fBCOLOR_PAIRS\fP\-1.
 .TP 5
 \fBslk_color\fP
 returns an error
 if the terminal or the softkeys were not initialized, or
-the color pair is outside the range 0..COLOR_PAIRS\-1.
+the color pair is outside the range 0..\fBCOLOR_PAIRS\fP\-1.
 .TP 5
 \fBslk_init\fP
 returns an error
@@ -227,27 +227,27 @@ .SH RETURN VALUE
 .RE
 .SH HISTORY
 SVr3 introduced these functions:
-  slk_clear
-  slk_init
-  slk_label
-  slk_noutrefresh
-  slk_refresh
-  slk_restore
-  slk_set
-  slk_touch
+  \fBslk_clear\fP
+  \fBslk_init\fP
+  \fBslk_label\fP
+  \fBslk_noutrefresh\fP
+  \fBslk_refresh\fP
+  \fBslk_restore\fP
+  \fBslk_set\fP
+  \fBslk_touch\fP
 .PP
 SVr4 added these functions:
-  slk_attroff
-  slk_attron
-  slk_attrset
-  slk_start
+  \fBslk_attroff\fP
+  \fBslk_attron\fP
+  \fBslk_attrset\fP
+  \fBslk_start\fP
 .PP
 X/Open Curses added these:
-  slk_attr_off
-  slk_attr_on
-  slk_attr_set
-  slk_color
-  slk_wset
+  \fBslk_attr_off\fP
+  \fBslk_attr_on\fP
+  \fBslk_attr_set\fP
+  \fBslk_color\fP
+  \fBslk_wset\fP
 .SH EXTENSIONS
 X/Open Curses documents the \fIopts\fP argument as reserved for future use,
 saying that it must be null.
@@ -300,11 +300,11 @@ .SH PORTABILITY
 (3 for the 3-2-3 layout, 2 for the 4-4 layout) which \fBslk_init\fP provided.
 .IP
 If \fIng\fP is neither 2 or 3,
-\fBslk_start\fP checks the terminfo \fIfln\fP (label_format) capability,
+\fBslk_start\fP checks the terminfo \fBfln\fP (label_format) capability,
 interpreting that as a comma-separated list of numbers,
 e.g., \*(``3,2,3\*('' for the 3-2-3 layout.
 .IP
-Finally, if there is no \fIfln\fP capability, \fBslk_start\fP returns ERR.
+Finally, if there is no \fBfln\fP capability, \fBslk_start\fP returns 
\fBERR\fP.
 .bP
 If \fBslk_start\fP is given a non-null \fIgp\fP,
 it copies the \fIng\fP elements of the group of soft-keys, up to 16.
diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index ba0d1d38..b887ab40 100644
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -567,7 +567,7 @@ .SH HISTORY
 .PP
 SVr3 extended terminfo by adding functions to retrieve capability values
 (like the termcap interface),
-and reusing tgoto and tputs:
+and reusing \fBtgoto\fP and \fBtputs\fP:
 .PP
 .TS
 l l
diff --git a/man/curs_util.3x b/man/curs_util.3x
index 1520d88c..25898333 100644
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -299,7 +299,7 @@ .SS nofilter/use_tioctl
 The \fBnofilter\fP and \fBuse_tioctl\fP routines are specific to \fBncurses\fP.
 They were not supported on Version 7, BSD or System V implementations.
 It is recommended that any code depending on \fBncurses\fP extensions
-be conditioned using NCURSES_VERSION.
+be conditioned using \fBNCURSES_VERSION\fP.
 .SS putwin/getwin file-format
 The \fBputwin\fP and \fBgetwin\fP functions have several issues with
 portability:
diff --git a/man/define_key.3x b/man/define_key.3x
index 26c21f28..56468db6 100644
--- a/man/define_key.3x
+++ b/man/define_key.3x
@@ -59,7 +59,7 @@ .SH PORTABILITY
 They were not supported on
 Version 7, BSD or System V implementations.
 It is recommended that
-any code depending on them be conditioned using NCURSES_VERSION.
+any code depending on them be conditioned using \fBNCURSES_VERSION\fP.
 .SH SEE ALSO
 \fBkeyok\fP(3X),
 \fBkey_defined\fP(3X).
diff --git a/man/key_defined.3x b/man/key_defined.3x
index 72d469fa..d63c9b8e 100644
--- a/man/key_defined.3x
+++ b/man/key_defined.3x
@@ -52,7 +52,7 @@ .SH PORTABILITY
 It was not supported on
 Version 7, BSD or System V implementations.
 It is recommended that
-any code depending on them be conditioned using NCURSES_VERSION.
+any code depending on them be conditioned using \fBNCURSES_VERSION\fP.
 .SH SEE ALSO
 \fBdefine_key\fP(3X).
 .SH AUTHOR
diff --git a/man/keybound.3x b/man/keybound.3x
index 62fbfce7..e63dfa86 100644
--- a/man/keybound.3x
+++ b/man/keybound.3x
@@ -43,8 +43,8 @@ .SH DESCRIPTION
 It permits an application to determine the string which is defined
 in the terminfo for specific keycodes.
 .SH RETURN VALUE
-The \fIkeycode\fP parameter must be greater than zero, else NULL is returned.
-If it does not correspond to a defined key, then NULL is returned.
+The \fIkeycode\fP parameter must be greater than zero, else \fBNULL\fP is 
returned.
+If it does not correspond to a defined key, then \fBNULL\fP is returned.
 The \fIcount\fP parameter is used to allow the application to iterate
 through multiple definitions, counting from zero.
 When successful,
@@ -54,7 +54,7 @@ .SH PORTABILITY
 It was not supported on
 Version 7, BSD or System V implementations.
 It is recommended that
-any code depending on them be conditioned using NCURSES_VERSION.
+any code depending on them be conditioned using \fBNCURSES_VERSION\fP.
 .SH SEE ALSO
 \fBdefine_key\fP(3X),
 \fBkeyok\fP(3X).
diff --git a/man/keyok.3x b/man/keyok.3x
index f3f43f2c..c330aa4c 100644
--- a/man/keyok.3x
+++ b/man/keyok.3x
@@ -54,7 +54,7 @@ .SH PORTABILITY
 It was not supported on
 Version 7, BSD or System V implementations.
 It is recommended that
-any code depending on them be conditioned using NCURSES_VERSION.
+any code depending on them be conditioned using \fBNCURSES_VERSION\fP.
 .SH SEE ALSO
 \fBdefine_key\fP(3X).
 .SH AUTHOR
diff --git a/man/new_pair.3x b/man/new_pair.3x
index 52d7b02b..813bd5dc 100644
--- a/man/new_pair.3x
+++ b/man/new_pair.3x
@@ -164,7 +164,7 @@ .SH PORTABILITY
 They were not supported on
 Version 7, BSD or System V implementations.
 It is recommended that
-any code depending on them be conditioned using NCURSES_VERSION.
+any code depending on them be conditioned using \fBNCURSES_VERSION\fP.
 .SH SEE ALSO
 \fBcurs_color\fP(3X).
 .SH AUTHOR
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]