[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 02/45] man/curs_scroll.3x: Fix style and markup nits.
From: |
G. Branden Robinson |
Subject: |
[PATCH 02/45] man/curs_scroll.3x: Fix style and markup nits. |
Date: |
Sat, 25 May 2024 12:38:30 -0500 |
Style:
* Put a space after pointer star in function synopsis.
Markup:
* Favor man(7) font style macros over *roff font selection escape
sequences, except for man page cross references (because
man/make_sed.sh recognizes only certain patterns when rewriting such
cross references) and terms in the "NAME" section (because the
generated edit_man.sh script expects font selection escape sequences
when scraping terms thence to gather names for man page aliases).
* Use font selection escape sequences more idiomatically; employ `\fP`
to return to the previous font in summary description, not `\fR` to
select roman.
---
man/curs_scroll.3x | 59 +++++++++++++++++++++++++++++++++-------------
1 file changed, 42 insertions(+), 17 deletions(-)
diff --git a/man/curs_scroll.3x b/man/curs_scroll.3x
index 16d5a5010..4c4b1e570 100644
--- a/man/curs_scroll.3x
+++ b/man/curs_scroll.3x
@@ -48,18 +48,19 @@ .SH NAME
\fB\%scroll\fP,
\fB\%scrl\fP,
\fB\%wscrl\fP \-
-scroll a \fIcurses\fR window
+scroll a \fIcurses\fP window
.SH SYNOPSIS
.nf
\fB#include <curses.h>
.PP
-\fBint scroll(WINDOW *\fIwin\fP);
+\fBint scroll(WINDOW * \fIwin\fP);
.PP
\fBint scrl(int \fIn\fP);
-\fBint wscrl(WINDOW *\fIwin\fP, int \fIn\fP);
+\fBint wscrl(WINDOW * \fIwin\fP, int \fIn\fP);
.fi
.SH DESCRIPTION
-\fBscroll\fP scrolls the given window up one line.
+.B scroll
+scrolls the given window up one line.
That is,
every visible line we might number
.I i
@@ -73,18 +74,29 @@ .SH DESCRIPTION
the physical screen may be scrolled at the same time;
see \fB\%curscr\fP(3X).
.PP
-\fB\%scrl\fP and \fB\%wscrl\fP scroll
+.B \%scrl
+and
+.B \%wscrl
+scroll
.B \%stdscr
or the specified window up or down depending on the sign of
-.IR n .
+.IR n "."
.bP
For positive
-.IR n ,
-line \fIi\fP+\fIn\fP becomes \fIi\fP (scrolling up);
+.IR n ","
+line
+.IR i + n
+becomes
+.I i
+(scrolling up);
.bP
for negative
-.IR n ,
-line \fIi\fP-\fIn\fP becomes \fIi\fP (scrolling down).
+.IR n ","
+line
+.IR i \- n
+becomes
+.I i
+(scrolling down).
.PP
The cursor does not move.
These functions perform no operation unless scrolling is enabled for the
@@ -97,26 +109,39 @@ .SH "RETURN VALUE"
upon success.
.PP
.I \%ncurses
-returns \fBERR\fP if scrolling is not enabled in the window,
+returns
+.B ERR
+if scrolling is not enabled in the window,
for example with \fB\%scrollok\fP(3X),
or if the
.I \%WINDOW
pointer is null.
.SH NOTES
Unusually,
-there is no \fB\%wscroll\fP function;
-\fBscroll\fP behaves as one would expect \fB\%wscroll\fP to,
-accepting a \fI\%WINDOW\fP pointer argument.
+there is no
+.B \%wscroll
+function;
+.B scroll
+behaves as one would expect
+.B \%wscroll
+to,
+accepting a
+.I \%WINDOW
+pointer argument.
.PP
-\fB\%scrl\fP and \fB\%scroll\fP may be implemented as macros.
+.B \%scrl
+and
+.B \%wscrl
+may be implemented as macros.
.SH PORTABILITY
X/Open Curses,
Issue 4 describes these functions.
It defines no error conditions.
.PP
SVr4 specifies only
-\*(``an integer value other than \fBERR\fP\*('' as a successful return
-value.
+\*(``an integer value other than
+.BR ERR \*(''
+as a successful return value.
.PP
SVr4 indicates that the optimization of physically scrolling immediately
if the scroll region is the entire screen \*(``is\*('' performed,
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 02/45] man/curs_scroll.3x: Fix style and markup nits.,
G. Branden Robinson <=