X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fwresize.3x;h=6990a38c124acd48541dfbd8c0a6738a14d0a12f;hb=bf2c36c4930ac5bb04cd2b1ba209cd09b6f510ab;hp=54c1fc6bccc588bf096bbc9c0844a6f1b7b51f20;hpb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045;p=ncurses.git diff --git a/man/wresize.3x b/man/wresize.3x index 54c1fc6b..6990a38c 100644 --- a/man/wresize.3x +++ b/man/wresize.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 2018-2022,2023 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,38 +29,44 @@ .\" .\" Author: Thomas E. Dickey 1996 .\" -.\" $Id: wresize.3x,v 1.17 2020/10/17 23:56:38 tom Exp $ -.TH wresize 3X "" +.\" $Id: wresize.3x,v 1.34 2023/11/25 14:26:30 tom Exp $ +.TH wresize 3X 2023-11-25 "ncurses 6.4" "Library calls" .SH NAME -\fBwresize\fR \- resize a curses window +\fB\%wresize\fP \- +resize a \fIcurses\fR window .SH SYNOPSIS -\fB#include \fR -.sp -\fBint wresize(WINDOW *\fP\fIwin\fP\fB, int \fP\fIlines\fP\fB, int \fP\fIcolumns\fP\fB);\fR +.nf +\fB#include +.PP +\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\fR -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\fR) 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\fR upon failure and \fBOK\fR 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\fR screen dimensions to -simplify the logic of \fBresizeterm\fR. +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 \fIcurses\fP. .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). +\fI\%ncurses\fP introduced this extension in mid-1995. +NetBSD \fIcurses\fP adopted it in 2001, +and \fI\%PDCurses\fP in 2003. +.SH AUTHORS +Thomas Dickey +(from an equivalent function written in 1988 for BSD \fIcurses\fP). .SH SEE ALSO -\fBresizeterm\fR(3X). -.SH AUTHOR -Thomas Dickey (from an equivalent function written in 1988 for BSD curses). +\fB\%resizeterm\fP(3X)