[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 25/61] man/wresize.3x: Fix style nits.
From: |
G. Branden Robinson |
Subject: |
[PATCH 25/61] man/wresize.3x: Fix style nits. |
Date: |
Fri, 24 Nov 2023 12:04:03 -0600 |
* Tighten description.
* Promote function cross references to man page cross references.
* Set "curses" and "ncurses" in italics instead of roman or bold.
* Protect "ncurses" from hyphenation.
* Favor active voice over passive.
* Break input lines after commas and around multi-word parentheticals.
---
man/wresize.3x | 34 +++++++++++++++++++---------------
1 file changed, 19 insertions(+), 15 deletions(-)
diff --git a/man/wresize.3x b/man/wresize.3x
index 6a31db49..6efc285c 100644
--- a/man/wresize.3x
+++ b/man/wresize.3x
@@ -41,28 +41,32 @@ .SH SYNOPSIS
\fBint wresize(WINDOW *\fIwin\fP, int \fIlines\fP, int \fIcolumns\fP);
.fi
.SH DESCRIPTION
-This is an extension to the curses library.
-It reallocates storage for an \fBncurses\fP
-window to adjust its dimensions to the specified values.
-If either dimension is larger than the current values, the
-window's data is filled with blanks that have the current background rendition
-(as set by \fBwbkgdset\fP) merged into them.
+This \fI\%ncurses\fP extension to standard \fIcurses\fP reallocates
+storage for a \fIcurses\fP window to adjust its dimensions to the
+specified values.
+If either dimension is larger than its current value,
+the expanded part of the window is filled with blanks merged with
+current background rendition
+(as set by \fB\%wbkgdset\fP(3X)).
.SH RETURN VALUE
-The function returns the integer \fBERR\fP upon failure and \fBOK\fP on
success.
-It will fail if either of the dimensions less than or equal to zero,
+\fB\%wresize\fP returns \fBERR\fP upon failure and \fBOK\fP on success.
+It will fail if either of the dimensions is less than or equal to zero,
or if an error occurs while (re)allocating memory for the window.
.SH NOTES
-The only restriction placed on the dimensions is that they be greater than
zero.
-The dimensions are not compared to \fBcurses\fP screen dimensions to
-simplify the logic of \fBresizeterm\fP.
+The only restriction placed on the dimensions is that they be greater
+than zero.
+They are \fInot\fP compared to the \fIcurses\fP screen dimensions;
+this keeps the logic of \fB\%resizeterm\fP(3X) simple.
The caller must ensure that the window's dimensions fit within the
actual screen dimensions.
.SH PORTABILITY
-It is not possible to resize windows with SVr4 curses.
+It is not possible to resize windows with SVr4 \fIcurses\fP.
.PP
-This extension of ncurses was introduced in mid-1995.
-It was adopted in NetBSD curses (2001) and PDCurses (2003).
+This extension of \fI\%ncurses\fP was introduced in mid-1995.
+NetBSD \fIcurses\fP adopted it in 2001,
+and \fI\%PDCurses\fP in 2003.
.SH AUTHOR
-Thomas Dickey (from an equivalent function written in 1988 for BSD curses).
+Thomas Dickey
+(from an equivalent function written in 1988 for BSD \fIcurses\fP).
.SH SEE ALSO
\fB\%resizeterm\fP(3X)
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 25/61] man/wresize.3x: Fix style nits.,
G. Branden Robinson <=