ncurses 6.3 - patch 20211225

[ncurses.git] / man / wresize.3x

diff --git a/man/wresize.3x b/man/wresize.3x
index 62933f1a153dc8d7aa7952a911658076edd2a6d5..d20115a77178792087fc279b1a96d8de1b82bfe9 100644 (file)
--- a/man/wresize.3x
+++ b/man/wresize.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
+.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
@@ -26,39 +27,40 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" Author: Thomas E. Dickey <dickey@clark.net> 1996
+.\" Author: Thomas E. Dickey 1996
 .\"
-.\" $Id: wresize.3x,v 1.7 2002/02/16 22:40:59 tom Exp $
+.\" $Id: wresize.3x,v 1.19 2021/12/25 21:42:57 tom Exp $
 .TH wresize 3X ""
 .SH NAME
-\fBwresize\fR - resize a curses window
+\fBwresize\fP \- resize a curses window
 .SH SYNOPSIS
-\fB#include <curses.h>\fR
-
-\fBint wresize(WINDOW *win, int lines, int columns);\fR
+\fB#include <curses.h>\fP
+.sp
+\fBint wresize(WINDOW *\fP\fIwin\fP\fB, int \fP\fIlines\fP\fB, int \fP\fIcolumns\fP\fB);\fP
 .SH DESCRIPTION
-The \fBwresize\fR function reallocates storage for an \fBncurses\fR
+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 \fBwbkgndset\fR) merged into them.
+(as set by \fBwbkgdset\fP) merged into them.
 .SH RETURN VALUE
-The function returns the integer \fBERR\fR upon failure and \fBOK\fR on success.
+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,
 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\fR screen dimensions to
-simplify the logic of \fBresizeterm\fR.
+The dimensions are not compared to \fBcurses\fP screen dimensions to
+simplify the logic of \fBresizeterm\fP.
 The caller must ensure that the window's dimensions fit within the
 actual screen dimensions.
+.SH PORTABILITY
+.PP
+It is not possible to resize windows with SVr4 curses.
+.PP
+This extension of ncurses was introduced in mid-1995.
+It was adopted in NetBSD curses (2001) and PDCurses (2003).
 .SH SEE ALSO
-\fBresizeterm\fR(3X).
+\fBresizeterm\fP(3X).
 .SH AUTHOR
 Thomas Dickey (from an equivalent function written in 1988 for BSD curses).
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: