[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 22/23] man/curs_pad.3x: Fix markup nits.
From: |
G. Branden Robinson |
Subject: |
[PATCH 22/23] man/curs_pad.3x: Fix markup nits. |
Date: |
Sat, 22 Jun 2024 12:50:29 -0500 |
* Favor man(7) font style macros over *roff font selection escape
sequences.
* Drop unnecessary font restoration escape sequences (`\fP`) from macro
arguments.
* Break input lines after commas.
---
man/curs_pad.3x | 52 +++++++++++++++++++++++++++++++++----------------
1 file changed, 35 insertions(+), 17 deletions(-)
diff --git a/man/curs_pad.3x b/man/curs_pad.3x
index f42968bdc..5c4206f0f 100644
--- a/man/curs_pad.3x
+++ b/man/curs_pad.3x
@@ -87,7 +87,8 @@ .SH DESCRIPTION
.B \%pnoutrefresh
instead.
.SS newpad
-\fB\%newpad\fP creates and returns a pointer to a new pad data structure
+.B \%newpad
+creates and returns a pointer to a new pad data structure
with the given number of lines,
.IR nlines ,
and columns,
@@ -114,7 +115,7 @@ .SS subpad
before calling
.BR \%prefresh .
.SS "prefresh, pnoutrefresh"
-.B \%prefresh\fP
+.B \%prefresh
and
.B \%pnoutrefresh
are analogous to \fB\%wrefresh\fP(3X) and \fB\%wnoutrefresh\fP(3X)
@@ -156,7 +157,7 @@ .SS pechochar
written to the pad is used to populate the arguments to
.BR \%prefresh .
.SS pecho_wchar
-.B \%pecho_wchar\fP
+.B \%pecho_wchar
is functionally equivalent to calling \fB\%wadd_wch\fP(3X) followed by
.BR \%prefresh .
It suggests to the
@@ -168,20 +169,28 @@ .SS pecho_wchar
written to the pad is used to populate the arguments to
.BR \%prefresh .
.SH RETURN VALUE
-Functions that return an integer return \fBERR\fP upon failure and
-\fBOK\fP
+Functions that return an integer return
+.B ERR
+upon failure and
+.B OK
(SVr4 specifies only
-\*(``an integer value other than \fBERR\fP\*('')
+\*(``an integer value other than
+.BR ERR \*('')
upon successful completion.
.PP
-Functions that return pointers return \fBNULL\fP on error,
-and set \fB\%errno\fP to \fB\%ENOMEM\fP.
+Functions that return pointers return
+.B NULL
+on error,
+and set
+.I \%errno
+to
+.BR \%ENOMEM "."
.PP
X/Open Curses does not specify any error conditions.
In this implementation
.RS 3
.TP 5
-\fB\%prefresh\fP and \fB\%pnoutrefresh\fP
+.BR prefresh\ and\ pnoutrefresh
return
.B ERR
if the window pointer is null, or
@@ -189,24 +198,33 @@ .SH RETURN VALUE
if the area to refresh extends off-screen or
if the minimum coordinates are greater than the maximum.
.TP 5
-\fBpechochar\fP
+.B pechochar
returns
.B ERR
-if the window is not really a pad, and the associated call
-to \fB\%wechochar\fP returns
+if the window is not really a pad,
+and the associated call to
+.B \%wechochar
+returns
.BR ERR "."
.TP 5
-\fBpecho_wchar\fP
+.B pecho_wchar
returns
.B ERR
-if the window is not really a pad, and the associated call
-to \fB\%wecho_wchar\fP returns
+if the window is not really a pad,
+and the associated call to
+.B \%wecho_wchar
+returns
.BR ERR "."
.RE
.SH NOTES
-\fB\%pechochar\fP may be a macro.
+.B \%pechochar
+may be a macro.
.SH PORTABILITY
-BSD \fIcurses\fP has no \fIpad\fP feature.
+BSD
+.I curses
+has no
+.I pad
+feature.
.PP
SVr2 \fIcurses\fP (1986) provided the \fB\%newpad\fP and related functions,
documenting them in a single line each.
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 22/23] man/curs_pad.3x: Fix markup nits.,
G. Branden Robinson <=