ncurses 6.4 - patch 20240113

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

diff --git a/man/wresize.3x b/man/wresize.3x
index 861f4beaf127c238983b98d3f145d7578b7d2180..6990a38c124acd48541dfbd8c0a6738a14d0a12f 100644 (file)
--- a/man/wresize.3x
+++ b/man/wresize.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
+.\" 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  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -28,38 +29,44 @@
 .\"
 .\" Author: Thomas E. Dickey 1996
 .\"
 .\"
 .\" Author: Thomas E. Dickey 1996
 .\"

-.\" $Id: wresize.3x,v 1.12 2010/08/14 23:12:04 Tim.van.der.Molen 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
 .SH NAME

-\fBwresize\fR \- resize a curses window
+\fB\%wresize\fP \-
+resize a \fIcurses\fR window

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <curses.h>\fR
-.sp
-\fBint wresize(WINDOW *win, int lines, int columns);\fR
+.nf
+\fB#include <curses.h>
+.PP
+\fBint wresize(WINDOW *\fIwin\fP, int \fIlines\fP, int \fIcolumns\fP);
+.fi

 .SH DESCRIPTION
 .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
 .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
 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.
 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
+\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
 .SH SEE ALSO

-\fBresizeterm\fR(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:
+\fB\%resizeterm\fP(3X)