[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 07/23] man/*: Fix `NULL` font style nit.
|
From: |
G. Branden Robinson |
|
Subject: |
[PATCH 07/23] man/*: Fix `NULL` font style nit. |
|
Date: |
Thu, 26 Dec 2024 21:34:28 -0600 |
Set libc symbol `NULL` in italics, not bold, just as we would a standard
C library (not ncurses) function name.
...except in examples and function synopses where it is used as a
literal.
(See "man/ncurses.3x: Fix font style nit.",
https://lists.gnu.org/archive/html/bug-ncurses/2024-09/msg00081.html).
---
man/curs_add_wch.3x | 2 +-
man/curs_add_wchstr.3x | 4 ++--
man/curs_addch.3x | 2 +-
man/curs_addchstr.3x | 4 ++--
man/curs_addstr.3x | 4 ++--
man/curs_addwstr.3x | 4 ++--
man/curs_attr.3x | 10 ++++++----
man/curs_bkgd.3x | 2 +-
man/curs_bkgrnd.3x | 4 ++--
man/curs_delch.3x | 2 +-
man/curs_deleteln.3x | 2 +-
man/curs_get_wch.3x | 2 +-
man/curs_getch.3x | 2 +-
man/curs_getstr.3x | 2 +-
man/curs_in_wch.3x | 2 +-
man/curs_inch.3x | 2 +-
man/curs_inchstr.3x | 4 +++-
man/curs_inopts.3x | 2 +-
man/curs_ins_wch.3x | 2 +-
man/curs_ins_wstr.3x | 4 ++--
man/curs_insch.3x | 2 +-
man/curs_insstr.3x | 4 ++--
man/curs_instr.3x | 4 ++--
man/curs_inwstr.3x | 4 ++--
man/curs_mouse.3x | 11 ++++++++---
man/curs_move.3x | 2 +-
man/curs_opaque.3x | 4 +++-
man/curs_pad.3x | 2 +-
man/curs_slk.3x | 4 +++-
man/curs_termattrs.3x | 4 +++-
man/curs_termcap.3x | 8 ++++----
man/curs_touch.3x | 3 ++-
man/curs_util.3x | 4 +++-
man/curs_window.3x | 4 +++-
man/define_key.3x | 4 ++--
man/form.3x | 8 ++++++--
man/form_field.3x | 11 +++++++----
man/form_field_buffer.3x | 4 +++-
man/form_field_new.3x | 3 ++-
man/form_field_userptr.3x | 3 ++-
man/form_field_validation.3x | 4 +++-
man/form_fieldtype.3x | 4 +++-
man/form_hook.3x | 23 +++++++++++++++--------
man/form_new.3x | 7 +++++--
man/form_page.3x | 4 +++-
man/form_requestname.3x | 4 +++-
man/form_userptr.3x | 3 ++-
man/form_win.3x | 12 +++++++++---
man/keybound.3x | 2 +-
man/menu.3x | 8 ++++++--
man/menu_hook.3x | 24 +++++++++++++++---------
man/menu_items.3x | 9 ++++++---
man/menu_mark.3x | 13 ++++++++-----
man/menu_new.3x | 7 +++++--
man/menu_pattern.3x | 5 ++++-
man/menu_requestname.3x | 4 +++-
man/menu_spacing.3x | 4 +++-
man/menu_userptr.3x | 3 ++-
man/menu_win.3x | 12 +++++++++---
man/mitem_current.3x | 6 ++++--
man/mitem_name.3x | 3 ++-
man/mitem_new.3x | 4 +++-
man/mitem_userptr.3x | 3 ++-
man/ncurses.3x | 2 +-
man/panel.3x | 5 +++--
65 files changed, 213 insertions(+), 117 deletions(-)
diff --git a/man/curs_add_wch.3x b/man/curs_add_wch.3x
index 0a69ebbef..3d6d67e73 100644
--- a/man/curs_add_wch.3x
+++ b/man/curs_add_wch.3x
@@ -394,7 +394,7 @@ .SH RETURN VALUE
.bP
.I win
is
-.BR NULL ","
+.IR NULL ","
.bP
wrapping to a new line is impossible because \fB\%scrollok\fP(3X) has
not been called on
diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x
index 145a270ff..4b462849a 100644
--- a/man/curs_add_wchstr.3x
+++ b/man/curs_add_wchstr.3x
@@ -120,12 +120,12 @@ .SH RETURN VALUE
.bP
.I win
is
-.B NULL
+.I NULL
or
.bP
.I wchstr
is
-.BR NULL "."
+.IR NULL "."
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_addch.3x b/man/curs_addch.3x
index 17ef31a98..9ad070f50 100644
--- a/man/curs_addch.3x
+++ b/man/curs_addch.3x
@@ -250,7 +250,7 @@ .SH RETURN VALUE
.bP
.I win
is
-.BR NULL ","
+.IR NULL ","
.bP
wrapping to a new line is impossible because \fB\%scrollok\fP(3X) has
not been called on
diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x
index 5d1a5c568..e6318b06f 100644
--- a/man/curs_addchstr.3x
+++ b/man/curs_addchstr.3x
@@ -120,12 +120,12 @@ .SH RETURN VALUE
.bP
.I win
is
-.B NULL
+.I NULL
or
.bP
.I chstr
is
-.BR NULL "."
+.IR NULL "."
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x
index a213544cf..99d21233a 100644
--- a/man/curs_addstr.3x
+++ b/man/curs_addstr.3x
@@ -107,11 +107,11 @@ .SH RETURN VALUE
.bP
.I win
is
-.BR NULL ","
+.IR NULL ","
.bP
.I str
is
-.BR NULL ","
+.IR NULL ","
or
.bP
an internal \fB\%waddch\fP(3X) call returns
diff --git a/man/curs_addwstr.3x b/man/curs_addwstr.3x
index c5db7c592..f7d5f3cad 100644
--- a/man/curs_addwstr.3x
+++ b/man/curs_addwstr.3x
@@ -117,11 +117,11 @@ .SH RETURN VALUE
.bP
.I win
is
-.BR NULL ","
+.IR NULL ","
.bP
.I wstr
is
-.BR NULL ","
+.IR NULL ","
or
.bP
an internal \fB\%wadd_wch\fP(3X) call returns
diff --git a/man/curs_attr.3x b/man/curs_attr.3x
index 37a466d9a..f9178bcb3 100644
--- a/man/curs_attr.3x
+++ b/man/curs_attr.3x
@@ -332,7 +332,7 @@ .SH RETURN VALUE
if
.I win
is
-.BR NULL "."
+.IR NULL "."
.PP
.B \%wcolor_set
returns
@@ -350,7 +350,7 @@ .SH RETURN VALUE
or
.I \%pair
parameter is
-.BR NULL "."
+.IR NULL "."
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
@@ -390,7 +390,8 @@ .SH EXTENSIONS
.PP
Each of the functions added by XSI Curses has a parameter \fIopts\fP,
which X/Open Curses still (after more than twenty years) documents
-as reserved for future use, saying that it should be \fBNULL\fP.
+as reserved for future use, saying that it should be
+.IR NULL "."
This implementation uses that parameter in ABI 6 for the functions which
have a color pair parameter to support \fIextended color pairs\fP:
.bP
@@ -418,7 +419,8 @@ .SH EXTENSIONS
For functions which turn attributes off, e.g.,
\fBwattr_off\fP,
the \fIopts\fP parameter is ignored except
-except to check that it is \fBNULL\fP.
+except to check that it is
+.IR NULL "."
.\" ---------------------------------------------------------------------------
.SH PORTABILITY
These functions are described in X/Open Curses, Issue 4.
diff --git a/man/curs_bkgd.3x b/man/curs_bkgd.3x
index d846ab672..b512586a5 100644
--- a/man/curs_bkgd.3x
+++ b/man/curs_bkgd.3x
@@ -200,7 +200,7 @@ .SH RETURN VALUE
if
.I win
is
-.BR NULL "."
+.IR NULL "."
.PP
.BR \%getbkgd 's
return value is as described above.
diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x
index 22e8f535a..8920c3637 100644
--- a/man/curs_bkgrnd.3x
+++ b/man/curs_bkgrnd.3x
@@ -202,12 +202,12 @@ .SH RETURN VALUE
.bP
.I win
is
-.BR NULL ","
+.IR NULL ","
or
.bP
.I wch
is
-.BR NULL "."
+.IR NULL "."
.SH NOTES
.BR \%bkgrnd ","
.BR \%bkgrndset ","
diff --git a/man/curs_delch.3x b/man/curs_delch.3x
index df6ff230a..75e85635b 100644
--- a/man/curs_delch.3x
+++ b/man/curs_delch.3x
@@ -83,7 +83,7 @@ .SH RETURN VALUE
if
.I win
is
-.BR NULL "."
+.IR NULL "."
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_deleteln.3x b/man/curs_deleteln.3x
index b85c30a28..fc8846816 100644
--- a/man/curs_deleteln.3x
+++ b/man/curs_deleteln.3x
@@ -110,7 +110,7 @@ .SH RETURN VALUE
they fail if
.I win
is
-.BR NULL "."
+.IR NULL "."
.SH NOTES
All of these functions except
.B \%winsdelln
diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x
index 56087beb2..f691530ed 100644
--- a/man/curs_get_wch.3x
+++ b/man/curs_get_wch.3x
@@ -194,7 +194,7 @@ .SH RETURN VALUE
Functions taking a
.I \%WINDOW
pointer argument fail if the pointer is
-.BR NULL "."
+.IR NULL "."
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index 0bc365962..f4b023b02 100644
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -478,7 +478,7 @@ .SH RETURN VALUE
Functions taking a
.I \%WINDOW
pointer argument fail if the pointer is
-.BR NULL "."
+.IR NULL "."
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x
index 6e426d766..51b613a6d 100644
--- a/man/curs_getstr.3x
+++ b/man/curs_getstr.3x
@@ -158,7 +158,7 @@ .SH RETURN VALUE
.bP
.I win
is
-.BR NULL ","
+.IR NULL ","
or
.bP
if an internal
diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x
index 88bf4074a..e5af2dc08 100644
--- a/man/curs_in_wch.3x
+++ b/man/curs_in_wch.3x
@@ -80,7 +80,7 @@ .SH RETURN VALUE
if
.I win
is
-.BR NULL "."
+.IR NULL "."
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_inch.3x b/man/curs_inch.3x
index a281537d2..f4ad7db76 100644
--- a/man/curs_inch.3x
+++ b/man/curs_inch.3x
@@ -87,7 +87,7 @@ .SH RETURN VALUE
if
.I win
is
-.BR NULL "."
+.IR NULL "."
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x
index a9903e880..428bcfe1f 100644
--- a/man/curs_inchstr.3x
+++ b/man/curs_inchstr.3x
@@ -69,7 +69,9 @@ .SH SYNOPSIS
\fBint mvwinchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, chtype
*\fIchstr\fP, int \fIn\fP);
.fi
.SH DESCRIPTION
-These routines return a NULL-terminated array of \fBchtype\fP quantities,
+These routines return a
+.IR NULL -terminated
+array of \fBchtype\fP quantities,
starting at the current cursor position in the named window and ending at the
right margin of the window.
.PP
diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x
index 5ee8e95d4..cb4460dab 100644
--- a/man/curs_inopts.3x
+++ b/man/curs_inopts.3x
@@ -515,7 +515,7 @@ .SH RETURN VALUE
.bP
.I win
is
-.B NULL
+.I NULL
(except for
.B \%intrflush
and
diff --git a/man/curs_ins_wch.3x b/man/curs_ins_wch.3x
index 5573a769f..040cea581 100644
--- a/man/curs_ins_wch.3x
+++ b/man/curs_ins_wch.3x
@@ -73,7 +73,7 @@ .SH "RETURN VALUE"
Functions taking a
.I \%WINDOW
pointer argument fail if the pointer is
-.BR NULL .
+.IR NULL .
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_ins_wstr.3x b/man/curs_ins_wstr.3x
index a2d49d1a1..8e657cc4f 100644
--- a/man/curs_ins_wstr.3x
+++ b/man/curs_ins_wstr.3x
@@ -119,11 +119,11 @@ .SH RETURN VALUE
.bP
.I win
is
-.BR NULL ","
+.IR NULL ","
.bP
.I wstr
is
-.BR NULL ","
+.IR NULL ","
.bP
the first wide character in
.I wstr
diff --git a/man/curs_insch.3x b/man/curs_insch.3x
index d88a64a9e..23d2f8391 100644
--- a/man/curs_insch.3x
+++ b/man/curs_insch.3x
@@ -77,7 +77,7 @@ .SH "RETURN VALUE"
Functions taking a
.I \%WINDOW
pointer argument fail if the pointer is
-.BR NULL .
+.IR NULL .
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_insstr.3x b/man/curs_insstr.3x
index 30c4da20d..184629ebc 100644
--- a/man/curs_insstr.3x
+++ b/man/curs_insstr.3x
@@ -119,11 +119,11 @@ .SH RETURN VALUE
.bP
.I win
is
-.BR NULL ","
+.IR NULL ","
.bP
.I str
is
-.BR NULL ","
+.IR NULL ","
or
.bP
an internal \fBwinsch\fP(3X) call returns
diff --git a/man/curs_instr.3x b/man/curs_instr.3x
index 9a858fb48..05d497b3d 100644
--- a/man/curs_instr.3x
+++ b/man/curs_instr.3x
@@ -115,12 +115,12 @@ .SH RETURN VALUE
.bP
.I win
is
-.B NULL
+.I NULL
or
.bP
.I str
is
-.BR NULL "."
+.IR NULL "."
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x
index f30ea5b9f..a3f27fa22 100644
--- a/man/curs_inwstr.3x
+++ b/man/curs_inwstr.3x
@@ -129,12 +129,12 @@ .SH RETURN VALUE
.bP
.I win
is
-.B NULL
+.I NULL
or
.bP
.I wstr
is
-.BR NULL "."
+.IR NULL "."
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x
index 41622522f..6778b2420 100644
--- a/man/curs_mouse.3x
+++ b/man/curs_mouse.3x
@@ -109,7 +109,8 @@ .SS mousemask
or if the terminal does not support mouse-events,
this function returns 0.
.bP
-If \fIoldmask\fP is non-\fBNULL\fP,
+If \fIoldmask\fP is
+.RI non- NULL ","
this function fills the indicated location with the previous value of the
current screen's mouse event mask.
.PP
@@ -216,7 +217,9 @@ .SS wmouse_trafo
through the pointers.
If the conversion was successful, the function returns \fBTRUE\fP.
.IP
-If one of the parameters was \fBNULL\fP or the location is
+If one of the parameters was
+.I NULL
+or the location is
not inside the window, \fBFALSE\fP is returned.
.bP
If \fIto_screen\fP is
@@ -226,7 +229,9 @@ .SS wmouse_trafo
window \fIwin\fP encloses this point.
In this case the function returns \fBTRUE\fP.
.IP
-If one of the parameters is \fBNULL\fP or the point is not inside the
+If one of the parameters is
+.I NULL
+or the point is not inside the
window, \fBFALSE\fP is returned.
.PP
The referenced coordinates
diff --git a/man/curs_move.3x b/man/curs_move.3x
index 001d5e91d..26b56fe77 100644
--- a/man/curs_move.3x
+++ b/man/curs_move.3x
@@ -88,7 +88,7 @@ .SH RETURN VALUE
fails if
.I win
is
-.BR NULL .
+.IR NULL .
.SH NOTES
.B \%move
may be implemented as a macro.
diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x
index fa623eea1..bd50c5204 100644
--- a/man/curs_opaque.3x
+++ b/man/curs_opaque.3x
@@ -136,7 +136,9 @@ .SH DESCRIPTION
.TP
\fBwgetparent\fP
returns the parent \fI\%WINDOW\fP pointer for subwindows,
-or \fBNULL\fP for windows having no parent.
+or
+.I NULL
+for windows having no parent.
.TP
\fBwgetscrreg\fP
stores the the top and bottom rows for the scrolling margin set by
diff --git a/man/curs_pad.3x b/man/curs_pad.3x
index 575722c32..56974b3d8 100644
--- a/man/curs_pad.3x
+++ b/man/curs_pad.3x
@@ -179,7 +179,7 @@ .SH RETURN VALUE
upon successful completion.
.PP
Functions that return pointers return
-.B NULL
+.I NULL
on error,
and set
.I \%errno
diff --git a/man/curs_slk.3x b/man/curs_slk.3x
index c7136b36d..e56de46f4 100644
--- a/man/curs_slk.3x
+++ b/man/curs_slk.3x
@@ -255,7 +255,9 @@ .SH RETURN VALUE
if the format parameter is outside the range 0..3.
.TP 5
\fBslk_label\fP
-returns \fBNULL\fP on error.
+returns
+.I NULL
+on error.
.TP 5
\fBslk_set\fP
returns
diff --git a/man/curs_termattrs.3x b/man/curs_termattrs.3x
index 019522e74..24b5a24be 100644
--- a/man/curs_termattrs.3x
+++ b/man/curs_termattrs.3x
@@ -110,7 +110,9 @@ .SS "termattrs, term_attrs"
.SS termname
The \fBtermname\fP routine returns the terminal name used by \fBsetupterm\fP.
.SH RETURN VALUE
-\fBlongname\fP and \fBtermname\fP return \fBNULL\fP on error.
+\fBlongname\fP and \fBtermname\fP return
+.I NULL
+on error.
.PP
Routines that return an integer return \fBERR\fP upon failure and \fBOK\fP
(SVr4 only specifies "an integer value other than \fBERR\fP") upon successful
diff --git a/man/curs_termcap.3x b/man/curs_termcap.3x
index 03215dac3..e68f7cf9a 100644
--- a/man/curs_termcap.3x
+++ b/man/curs_termcap.3x
@@ -185,7 +185,7 @@ .SS "Retrieving Capability Values"
.PP
\fB\%tgetstr\fP returns the string entry for \fIid\fP,
or
-.B NULL
+.I NULL
if it is not available.
Use \fB\%tputs\fP to output the string returned.
The
@@ -200,9 +200,9 @@ .SS "Retrieving Capability Values"
\fI\%ncurses\fP checks to ensure that
.I area
is not
-.BR NULL ,
+.IR NULL ","
and also that the resulting buffer pointer is not
-.BR NULL .
+.IR NULL "."
If either check fails,
.I area
is ignored.
@@ -318,7 +318,7 @@ .SH "RETURN VALUE"
are documented above.
.PP
\fB\%tgoto\fP returns
-.B NULL
+.I NULL
on error.
Error conditions include:
.bP
diff --git a/man/curs_touch.3x b/man/curs_touch.3x
index 1c8dadbd8..02fad657f 100644
--- a/man/curs_touch.3x
+++ b/man/curs_touch.3x
@@ -114,7 +114,8 @@ .SH PORTABILITY
for instance, defines both an actual function and macro for each.
The macros give the same result as the actual functions.
SVr4 \fIcurses\fP does not check the window parameter \fIwin\fP to ensure
-that it is not \fBNULL\fP;
+that it is not
+.IR NULL ";"
otherwise this implementation behaves the same as SVr4.
.PP
X/Open Curses, Issue 4 describes these functions.
diff --git a/man/curs_util.3x b/man/curs_util.3x
index cc9933c45..ad37c1188 100644
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -308,7 +308,9 @@ .SH RETURN VALUE
(SVr4 specifies only "an integer value other than \fBERR\fP")
upon successful completion.
.PP
-Routines that return pointers return \fBNULL\fP on error.
+Routines that return pointers return
+.I NULL
+on error.
.PP
In this implementation
.RS 3
diff --git a/man/curs_window.3x b/man/curs_window.3x
index 4920de461..1fc5f0a94 100644
--- a/man/curs_window.3x
+++ b/man/curs_window.3x
@@ -163,7 +163,9 @@ .SH RETURN VALUE
\fBOK\fP (SVr4 only specifies "an integer value other than \fBERR\fP") upon
successful completion.
.PP
-Routines that return pointers return \fBNULL\fP on error.
+Routines that return pointers return
+.I NULL
+on error.
.PP
X/Open defines no error conditions.
In this implementation
diff --git a/man/define_key.3x b/man/define_key.3x
index 0042d8de5..e061d8150 100644
--- a/man/define_key.3x
+++ b/man/define_key.3x
@@ -71,7 +71,7 @@ .SH DESCRIPTION
A
.I definition
of
-.B NULL
+.I NULL
removes any existing binding from
.IR key-code "."
Similarly,
@@ -88,7 +88,7 @@ .SH RETURN VALUE
.bP
.I definition
is
-.B NULL
+.I NULL
and
.I key-code
is nonpositive,
diff --git a/man/form.3x b/man/form.3x
index b17e41f7c..dbe60f435 100644
--- a/man/form.3x
+++ b/man/form.3x
@@ -79,7 +79,9 @@ .SS "Current Default Values for Field Attributes"
You
can get or set this default by calling the appropriate \fBset_\fP
or retrieval
-routine with a \fBNULL\fP field pointer.
+routine with a
+.I NULL
+field pointer.
Changing this default with a
\fBset_\fP function affects future field creations, but does not change the
rendering of fields already created.
@@ -173,7 +175,9 @@ .SS "Routine Name Index"
unpost_form \fBform_post\fP(3X)
.TE
.SH RETURN VALUE
-Routines that return pointers return \fBNULL\fP on error,
+Routines that return pointers return
+.I NULL
+on error,
and set \fBerrno\fP to the corresponding error-code returned by functions
returning an integer.
Routines that return
diff --git a/man/form_field.3x b/man/form_field.3x
index 9799d0c0c..8e97cf33a 100644
--- a/man/form_field.3x
+++ b/man/form_field.3x
@@ -44,7 +44,8 @@ .SH SYNOPSIS
.fi
.SH DESCRIPTION
The function \fBset_form_fields\fP changes the field pointer array of
-the given \fIform\fP. The array must be terminated by a \fBNULL\fP.
+the given \fIform\fP. The array must be terminated by a
+.IR NULL "."
.PP
The function \fBform_fields\fP returns the field array of the given form.
.PP
@@ -53,11 +54,13 @@ .SH DESCRIPTION
The function \fBmove_field\fP moves the given field (which must be
disconnected)
to a specified location on the screen.
.SH RETURN VALUE
-The function \fBform_fields\fP returns a pointer (which may be \fBNULL\fP).
+The function \fBform_fields\fP returns a pointer (which may be
+.IR NULL ")."
It does not set \fBerrno\fP.
.PP
-The function \fBfield_count\fP returns \fBERR\fP if the \fIform\fP parameter
-is \fBNULL\fP.
+The function \fBfield_count\fP returns \fBERR\fP if the \fIform\fP
+parameter is
+.IR NULL "."
.PP
The functions \fBset_form_fields\fP and \fBmove_field\fP return one of
the following codes on error:
diff --git a/man/form_field_buffer.3x b/man/form_field_buffer.3x
index ba176d3e1..1861bd427 100644
--- a/man/form_field_buffer.3x
+++ b/man/form_field_buffer.3x
@@ -104,7 +104,9 @@ .SH DESCRIPTION
The function \fBset_max_field\fP sets the maximum size for a dynamic field.
An argument of 0 turns off any maximum size threshold for that field.
.SH RETURN VALUE
-The \fBfield_buffer\fP function returns NULL on error.
+The \fBfield_buffer\fP function returns
+.I NULL
+on error.
It sets \fBerrno\fP according to their success:
.TP 5
.B E_OK
diff --git a/man/form_field_new.3x b/man/form_field_new.3x
index 9cf08adb5..64ce79752 100644
--- a/man/form_field_new.3x
+++ b/man/form_field_new.3x
@@ -66,7 +66,8 @@ .SH DESCRIPTION
The function \fBfree_field\fP de-allocates storage associated with a field.
.SH RETURN VALUE
The functions \fBnew_field\fP, \fBdup_field\fP, \fBlink_field\fP return
-\fBNULL\fP on error.
+.I NULL
+on error.
They set \fBerrno\fP according to their success:
.TP 5
.B E_OK
diff --git a/man/form_field_userptr.3x b/man/form_field_userptr.3x
index 6eea09201..a8e0a9b08 100644
--- a/man/form_field_userptr.3x
+++ b/man/form_field_userptr.3x
@@ -46,7 +46,8 @@ .SH DESCRIPTION
These functions get and set
that field.
.SH RETURN VALUE
-The function \fBfield_userptr\fP returns a pointer (which may be \fBNULL\fP).
+The function \fBfield_userptr\fP returns a pointer (which may be
+.IR NULL ")."
It does not set \fBerrno\fP.
.PP
The function \fBset_field_userptr\fP returns \fBE_OK\fP (success).
diff --git a/man/form_field_validation.3x b/man/form_field_validation.3x
index 54fa2a72a..720258f03 100644
--- a/man/form_field_validation.3x
+++ b/man/form_field_validation.3x
@@ -187,7 +187,9 @@ .SS TYPE_IPV4
This is an \fI\%ncurses\fP extension;
this field type may not be available in other curses implementations.
.SH RETURN VALUE
-The functions \fBfield_type\fP and \fBfield_arg\fP return \fBNULL\fP on error.
+The functions \fBfield_type\fP and \fBfield_arg\fP return
+.I NULL
+on error.
The function \fBset_field_type\fP returns one of the following:
.TP 5
.B E_OK
diff --git a/man/form_fieldtype.3x b/man/form_fieldtype.3x
index 81a58b1d8..b1cd21e54 100644
--- a/man/form_fieldtype.3x
+++ b/man/form_fieldtype.3x
@@ -102,7 +102,9 @@ .SS set_fieldtype_arg
Frees an argument-block structure.
.PP
You must supply the \fImake_arg\fP function.
-The other two are optional: you may supply NULL for them.
+The other two are optional: you may supply
+.I NULL
+for them.
In this case, the form library assumes
that \fImake_arg\fP does not allocate memory but simply loads the
argument into a single scalar value.
diff --git a/man/form_hook.3x b/man/form_hook.3x
index d93d8d875..029eabc06 100644
--- a/man/form_hook.3x
+++ b/man/form_hook.3x
@@ -55,28 +55,35 @@ .SS set_field_init
sets a hook to be called at form-post time
and each time the selected field changes (after the change).
.SS field_init
-returns the current field init hook, if any (\fBNULL\fP if there is no such
-hook).
+returns the current field init hook, if any
+.RI ( NULL
+if there is no such hook).
.SS set_field_term
sets a hook to be called at form-unpost time
and each time the selected field changes (before the change).
.SS field_term
-returns the current field term hook, if any (\fBNULL\fP if there is no such
-hook).
+returns the current field term hook, if any
+.RI ( NULL
+if there is no such hook).
.SS set_form_init
sets a hook to be called at form-post time and
just after a page change once it is posted.
.SS form_init
returns the current form init hook,
-if any (\fBNULL\fP if there is no such hook).
+if any
+.RI ( NULL
+if there is no such hook).
.SS set_form_term
sets a hook to be called at form-unpost time
and just before a page change once it is posted.
.SS form_term
-returns the current form term hook, if any (\fBNULL\fP if there is no such
-hook).
+returns the current form term hook, if any
+.RI ( NULL
+if there is no such hook).
.SH RETURN VALUE
-Routines that return pointers return \fBNULL\fP on error.
+Routines that return pointers return
+.I NULL
+on error.
Other routines
return one of the following:
.TP 5
diff --git a/man/form_new.3x b/man/form_new.3x
index dc45e183f..dcf15bd8f 100644
--- a/man/form_new.3x
+++ b/man/form_new.3x
@@ -42,12 +42,15 @@ .SH SYNOPSIS
.fi
.SH DESCRIPTION
The function \fBnew_form\fP creates a new form connected to a specified field
-pointer array (which must be \fBNULL\fP-terminated).
+pointer array (which must be
+.IR NULL -terminated).
.PP
The function \fBfree_form\fP disconnects \fIform\fP from its field array
and frees the storage allocated for the form.
.SH RETURN VALUE
-The function \fBnew_form\fP returns \fBNULL\fP on error.
+The function \fBnew_form\fP returns
+.I NULL
+on error.
It sets \fBerrno\fP according to the function's success:
.TP 5
.B E_OK
diff --git a/man/form_page.3x b/man/form_page.3x
index fa538c620..c3250af32 100644
--- a/man/form_page.3x
+++ b/man/form_page.3x
@@ -52,7 +52,9 @@ .SH DESCRIPTION
.PP
The function \fBunfocus_current_field\fP removes the focus from the current
field of the form.
-In such state, inquiries via \fBcurrent_field\fP shall return a NULL pointer.
+In such state, inquiries via \fBcurrent_field\fP shall return a
+.I NULL
+pointer.
.PP
The function \fBset_form_page\fP sets the form's page number (goes to page
\fIn\fP of the form).
diff --git a/man/form_requestname.3x b/man/form_requestname.3x
index 4075ea73c..e6117790c 100644
--- a/man/form_requestname.3x
+++ b/man/form_requestname.3x
@@ -47,7 +47,9 @@ .SH DESCRIPTION
with the given name and returns its request code.
Otherwise E_NO_MATCH is returned.
.SH RETURN VALUE
-\fBform_request_name\fP returns \fBNULL\fP on error and sets \fBerrno\fP
+\fBform_request_name\fP returns
+.I NULL
+on error and sets \fBerrno\fP
to \fBE_BAD_ARGUMENT\fP.
.PP
\fBform_request_by_name\fP returns \fBE_NO_MATCH\fP on error.
diff --git a/man/form_userptr.3x b/man/form_userptr.3x
index 11c990c00..d7d2feef4 100644
--- a/man/form_userptr.3x
+++ b/man/form_userptr.3x
@@ -45,7 +45,8 @@ .SH DESCRIPTION
application-specific data (that is, the form-driver code leaves it alone).
These functions get and set the form user pointer field.
.SH RETURN VALUE
-The function \fBform_userptr\fP returns a pointer (which may be \fBNULL\fP).
+The function \fBform_userptr\fP returns a pointer (which may be
+.IR NULL ")."
It does not set \fBerrno\fP.
.PP
The function \fBset_form_userptr\fP returns \fBE_OK\fP (success).
diff --git a/man/form_win.3x b/man/form_win.3x
index 4a75b294c..182079664 100644
--- a/man/form_win.3x
+++ b/man/form_win.3x
@@ -54,14 +54,20 @@ .SH DESCRIPTION
It is not necessary to set
either window; by default, the driver code uses \fBstdscr\fP for both.
.PP
-In the \fBset_\fP functions, window argument of \fBNULL\fP is treated as though
-it were \fBstsdcr\fP. A form argument of \fBNULL\fP is treated as a request
+In the \fBset_\fP functions, window argument of
+.I NULL
+is treated as though
+it were \fBstsdcr\fP. A form argument of
+.I NULL
+is treated as a request
to change the system default form window or subwindow.
.PP
The function \fBscale_form\fP returns the minimum size required for the
subwindow of \fIform\fP.
.SH RETURN VALUE
-Routines that return pointers return \fBNULL\fP on error.
+Routines that return pointers return
+.I NULL
+on error.
Routines that return
an integer return one of the following error codes:
.TP 5
diff --git a/man/keybound.3x b/man/keybound.3x
index 03725503a..bf6693209 100644
--- a/man/keybound.3x
+++ b/man/keybound.3x
@@ -78,7 +78,7 @@ .SH RETURN VALUE
that must be freed by the application.
.B \%keybound
returns
-.B NULL
+.I NULL
if
.I key-code
is not positive
diff --git a/man/menu.3x b/man/menu.3x
index 99d5c1e6a..e731e63bb 100644
--- a/man/menu.3x
+++ b/man/menu.3x
@@ -70,7 +70,9 @@ .SS "Current Default Values for Item Attributes"
The \fBmenu\fP library maintains a default value for item attributes.
You can
get or set this default by calling the appropriate \fBget_\fP or \fBset_\fP
-routine with a \fBNULL\fP item pointer.
+routine with a
+.I NULL
+item pointer.
Changing this default with a
\fBset_\fP function affects future item creations, but does not change the
rendering of items already created.
@@ -150,7 +152,9 @@ .SS "Routine Name Index"
unpost_menu \fBmenu_post\fP(3X)
.TE
.SH RETURN VALUE
-Routines that return pointers return \fBNULL\fP on error.
+Routines that return pointers return
+.I NULL
+on error.
Routines that return
an integer return one of the following error codes:
.TP 5
diff --git a/man/menu_hook.3x b/man/menu_hook.3x
index 839e199b8..22e4a03ae 100644
--- a/man/menu_hook.3x
+++ b/man/menu_hook.3x
@@ -55,27 +55,33 @@ .SH DESCRIPTION
The function \fBset_item_init\fP sets a hook to be called at menu-post time and
each time the selected item changes (after the change).
\fBitem_init\fP
-returns the current item init hook, if any (\fBNULL\fP if there is no such
-hook).
+returns the current item init hook, if any
+.RI ( NULL
+if there is no such hook).
.PP
The function \fBset_item_term\fP sets a hook to be called at menu-unpost time
and each time the selected item changes (before the change).
\fBitem_term\fP
-returns the current item term hook, if any (\fBNULL\fP if there is no such
-hook).
+returns the current item term hook, if any
+.RI ( NULL
+if there is no such hook).
.PP
The function \fBset_menu_init\fP sets a hook to be called at menu-post time and
just after the top row on the menu changes once it is posted.
\fBmenu_init\fP
-returns the current menu init hook, if any (\fBNULL\fP if there is no such
-hook).
+returns the current menu init hook, if any
+.RI ( NULL
+if there is no such hook).
.PP
The function \fBset_menu_term\fP sets a hook to be called at menu-unpost time
and just before the top row on the menu changes once it is posted.
-\fBmenu_term\fP returns the current menu term hook, if any (\fBNULL\fP if there
-is no such hook).
+\fBmenu_term\fP returns the current menu term hook, if any
+.RI ( NULL
+if there is no such hook).
.SH RETURN VALUE
-Routines that return pointers return \fBNULL\fP on error.
+Routines that return pointers return
+.I NULL
+on error.
Other routines
return one of the following:
.TP 5
diff --git a/man/menu_items.3x b/man/menu_items.3x
index 43409fef8..6ceda0699 100644
--- a/man/menu_items.3x
+++ b/man/menu_items.3x
@@ -44,17 +44,20 @@ .SH SYNOPSIS
.fi
.SH DESCRIPTION
The function \fBset_menu_items\fP changes the item pointer array of the given
-\fImenu\fP. The array must be terminated by a \fBNULL\fP.
+\fImenu\fP. The array must be terminated by a
+.IR NULL "."
.PP
The function \fBmenu_items\fP returns the item array of the given menu.
.PP
The function \fBitem_count\fP returns the count of items in \fImenu\fP.
.SH RETURN VALUE
-The function \fBmenu_items\fP returns a pointer (which may be \fBNULL\fP).
+The function \fBmenu_items\fP returns a pointer (which may be
+.IR NULL ")."
It does not set \fBerrno\fP.
.PP
The function \fBitem_count\fP returns \fBERR\fP (the general \fBcurses\fP error
-return value) if its \fImenu\fP parameter is \fBNULL\fP.
+return value) if its \fImenu\fP parameter is
+.I NULL "."
.PP
The function \fBset_menu_items\fP returns one of the following codes on error:
.TP 5
diff --git a/man/menu_mark.3x b/man/menu_mark.3x
index e3f3a9286..e49023e6e 100644
--- a/man/menu_mark.3x
+++ b/man/menu_mark.3x
@@ -51,13 +51,16 @@ .SH DESCRIPTION
menu is posted is likely to produce unhelpful behavior.
.PP
The default string is "\-" (a dash).
-Calling \fBset_menu_mark\fP with
-a non-\fBNULL\fP menu argument will change this default.
+Calling \fBset_menu_mark\fP with a
+.IR non- NULL
+menu argument will change this default.
.PP
-The function \fBmenu_mark\fP returns the menu's mark string (or \fBNULL\fP if
-there is none).
+The function \fBmenu_mark\fP returns the menu's mark string (or
+.I NULL
+if there is none).
.SH RETURN VALUE
-The function \fBmenu_mark\fP returns a pointer (which may be \fBNULL\fP).
+The function \fBmenu_mark\fP returns a pointer (which may be
+.IR NULL ")."
It does not set \fBerrno\fP.
.PP
The function \fBset_menu_mark\fP may return the following error codes:
diff --git a/man/menu_new.3x b/man/menu_new.3x
index 1a133745a..790b52e10 100644
--- a/man/menu_new.3x
+++ b/man/menu_new.3x
@@ -42,12 +42,15 @@ .SH SYNOPSIS
.fi
.SH DESCRIPTION
The function \fBnew_menu\fP creates a new menu connected to a specified item
-pointer array (which must be \fBNULL\fP-terminated).
+pointer array (which must be
+.IR NULL -terminated).
.PP
The function \fBfree_menu\fP disconnects \fImenu\fP from its item array
and frees the storage allocated for the menu.
.SH RETURN VALUE
-The function \fBnew_menu\fP returns \fBNULL\fP on error.
+The function \fBnew_menu\fP returns
+.I NULL
+on error.
It sets \fBerrno\fP according to the function's failure:
.TP 5
.B E_NOT_CONNECTED
diff --git a/man/menu_pattern.3x b/man/menu_pattern.3x
index a66a368dd..92ac59357 100644
--- a/man/menu_pattern.3x
+++ b/man/menu_pattern.3x
@@ -55,7 +55,10 @@ .SH DESCRIPTION
\fImenu\fP.
.SH RETURN VALUE
The function \fBmenu_pattern\fP returns a pointer,
-which is \fBNULL\fP if the \fImenu\fP parameter is \fBNULL\fP.
+which is
+.I NULL
+if the \fImenu\fP parameter is
+.IR NULL "."
Otherwise, it is a pointer to a string which is empty
if no pattern has been set.
It does not set \fBerrno\fP.
diff --git a/man/menu_requestname.3x b/man/menu_requestname.3x
index a0363fb28..23134823f 100644
--- a/man/menu_requestname.3x
+++ b/man/menu_requestname.3x
@@ -48,7 +48,9 @@ .SH DESCRIPTION
with the given name and returns its request code.
Otherwise E_NO_MATCH is returned.
.SH RETURN VALUE
-\fBmenu_request_name\fP returns \fBNULL\fP on error
+\fBmenu_request_name\fP returns
+.I NULL
+on error
and sets \fBerrno\fP to \fBE_BAD_ARGUMENT\fP.
.br
\fBmenu_request_by_name\fP returns \fBE_NO_MATCH\fP on error.
diff --git a/man/menu_spacing.3x b/man/menu_spacing.3x
index d15e77d54..b1bc26578 100644
--- a/man/menu_spacing.3x
+++ b/man/menu_spacing.3x
@@ -73,7 +73,9 @@ .SH DESCRIPTION
which is 1 for all of them.
.PP
The function \fBmenu_spacing\fP returns the spacing information for the menu.
-If a pointer is NULL, the corresponding information is simply not returned.
+If a pointer is
+.IR NULL ","
+the corresponding information is simply not returned.
.SH RETURN VALUE
Both routines return \fBE_OK\fP on success.
\fBset_menu_spacing\fP may return
diff --git a/man/menu_userptr.3x b/man/menu_userptr.3x
index 292bbd6b8..ac868fa30 100644
--- a/man/menu_userptr.3x
+++ b/man/menu_userptr.3x
@@ -45,7 +45,8 @@ .SH DESCRIPTION
application-specific data (that is, the menu-driver code leaves it alone).
These functions get and set the menu user pointer field.
.SH RETURN VALUE
-\fBmenu_userptr\fP returns a pointer (which may be \fBNULL\fP).
+\fBmenu_userptr\fP returns a pointer (which may be
+.IR NULL ")."
It does not set \fBerrno\fP.
.PP
\fBset_menu_userptr\fP returns \fBE_OK\fP (success).
diff --git a/man/menu_win.3x b/man/menu_win.3x
index 36f6129dc..3d3dca1a5 100644
--- a/man/menu_win.3x
+++ b/man/menu_win.3x
@@ -54,14 +54,20 @@ .SH DESCRIPTION
It is not necessary to set
either window; by default, the driver code uses \fBstdscr\fP for both.
.PP
-In the \fBset_\fP functions, window argument of \fBNULL\fP is treated as though
-it were \fBstsdcr\fP. A menu argument of \fBNULL\fP is treated as a request
+In the \fBset_\fP functions, window argument of
+.I NULL
+is treated as though
+it were \fBstsdcr\fP. A menu argument of
+.I NULL
+is treated as a request
to change the system default menu window or subwindow.
.PP
The function \fBscale_menu\fP returns the minimum size required for the
subwindow of \fImenu\fP.
.SH RETURN VALUE
-Routines that return pointers return \fBNULL\fP on error.
+Routines that return pointers return
+.I NULL
+on error.
Routines that return
an integer return one of the following error codes:
.TP 5
diff --git a/man/mitem_current.3x b/man/mitem_current.3x
index 42d36c397..0d94059d3 100644
--- a/man/mitem_current.3x
+++ b/man/mitem_current.3x
@@ -61,11 +61,13 @@ .SH DESCRIPTION
The function \fBitem_index\fP returns the (zero-origin) index of \fIitem\fP in
the menu's item pointer list.
.SH RETURN VALUE
-\fBcurrent_item\fP returns a pointer (which may be \fBNULL\fP).
+\fBcurrent_item\fP returns a pointer (which may be
+.IR NULL ")."
It does not set \fBerrno\fP.
.PP
\fBtop_row\fP and \fBitem_index\fP return \fBERR\fP (the general \fBcurses\fP
-error value) if their \fImenu\fP parameter is \fBNULL\fP.
+error value) if their \fImenu\fP parameter is
+.IR NULL "."
.PP
\fBset_current_item\fP and \fBset_top_row\fP return one of the following:
.TP 5
diff --git a/man/mitem_name.3x b/man/mitem_name.3x
index 3606bb5d2..cc879ea92 100644
--- a/man/mitem_name.3x
+++ b/man/mitem_name.3x
@@ -46,7 +46,8 @@ .SH DESCRIPTION
The function \fBitem_description\fP returns the description part of the given
item.
.SH RETURN VALUE
-These routines return a pointer (which may be \fBNULL\fP).
+These routines return a pointer (which may be
+.IR NULL ")."
They do not set \fBerrno\fP.
.SH PORTABILITY
These routines emulate the System V menu library.
diff --git a/man/mitem_new.3x b/man/mitem_new.3x
index 66bd29bce..585878906 100644
--- a/man/mitem_new.3x
+++ b/man/mitem_new.3x
@@ -55,7 +55,9 @@ .SH DESCRIPTION
is the responsibility of the application to release the memory for the
name or the description of the item.
.SH RETURN VALUE
-The function \fBnew_item\fP returns \fBNULL\fP on error.
+The function \fBnew_item\fP returns
+.I NULL
+on error.
It sets \fBerrno\fP according to the function's failure:
.TP 5
.B E_BAD_ARGUMENT
diff --git a/man/mitem_userptr.3x b/man/mitem_userptr.3x
index f0eab8bd8..c075ba4a6 100644
--- a/man/mitem_userptr.3x
+++ b/man/mitem_userptr.3x
@@ -46,7 +46,8 @@ .SH DESCRIPTION
These functions get and set
that field.
.SH RETURN VALUE
-The function \fBitem_userptr\fP returns a pointer (possibly \fBNULL\fP).
+The function \fBitem_userptr\fP returns a pointer (possibly
+.IR NULL ")."
It does not set \fBerrno\fP.
.PP
The \fBset_item_userptr\fP always returns \fBE_OK\fP (success).
diff --git a/man/ncurses.3x b/man/ncurses.3x
index cb0784bab..e015062b3 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -1099,7 +1099,7 @@ .SH RETURN VALUE
on failure;
see \fB\%curs_variables\fP(3X).
Functions that return pointers return
-.B NULL
+.I NULL
on failure.
Typically,
.I \%ncurses
diff --git a/man/panel.3x b/man/panel.3x
index 38bf5f346..f984a77ce 100644
--- a/man/panel.3x
+++ b/man/panel.3x
@@ -215,8 +215,9 @@ .SS update_panels
but \fB\%doupdate\fP is the function responsible for updating
the physical screen.
.SH "RETURN VALUE"
-Each routine that returns a pointer returns \fBNULL\fP if an error
-occurs.
+Each routine that returns a pointer returns
+.I NULL
+if an error occurs.
Each routine that returns an int value returns \fBOK\fP if it
executes successfully and \fBERR\fP if not.
.PP
--
2.30.2
signature.asc
Description: PGP signature
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 07/23] man/*: Fix `NULL` font style nit.,
G. Branden Robinson <=