summaryrefslogtreecommitdiff
path: root/lib/libcurses/wresize.3
diff options
context:
space:
mode:
authorTodd C. Miller <millert@cvs.openbsd.org>1997-11-26 04:02:03 +0000
committerTodd C. Miller <millert@cvs.openbsd.org>1997-11-26 04:02:03 +0000
commitbda33b7e716d56bf1a9ecccb7e2543889f9ab1d3 (patch)
tree7bc4bcdf70ecc1d045693a309e96b304e1b49c33 /lib/libcurses/wresize.3
parentcd15e61d557c4704743905eae7b88ae927cf0394 (diff)
ncurses 4.1 + changes to work with our terminfo libs (instead of
the ncurses ones). Changes are #ifdef EXTERN_TERMINFO. Post 4.1 patches will be applied in a separate commit.
Diffstat (limited to 'lib/libcurses/wresize.3')
-rw-r--r--lib/libcurses/wresize.360
1 files changed, 60 insertions, 0 deletions
diff --git a/lib/libcurses/wresize.3 b/lib/libcurses/wresize.3
new file mode 100644
index 00000000000..f95fbb733d5
--- /dev/null
+++ b/lib/libcurses/wresize.3
@@ -0,0 +1,60 @@
+.\"*****************************************************************************
+.\" Copyright 1996 by Thomas E. Dickey <dickey@clark.net> *
+.\" All Rights Reserved. *
+.\" *
+.\" Permission to use, copy, modify, and distribute this software and its *
+.\" documentation for any purpose and without fee is hereby granted, provided *
+.\" that the above copyright notice appear in all copies and that both that *
+.\" copyright notice and this permission notice appear in supporting *
+.\" documentation, and that the name of the above listed copyright holder(s) *
+.\" not be used in advertising or publicity pertaining to distribution of the *
+.\" software without specific, written prior permission. THE ABOVE LISTED *
+.\" COPYRIGHT HOLDER(S) DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, *
+.\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO *
+.\" EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR ANY *
+.\" SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER *
+.\" RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF *
+.\" CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN *
+.\" CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. *
+.\"*****************************************************************************
+.\" Id: wresize.3x,v 1.2 1996/09/07 14:51:04 tom Exp $
+.TH wresize 3X ""
+.
+.SH NAME
+\fBwresize\fR - resize a curses window
+.
+.SH SYNOPSIS
+\fB#include <curses.h>\fR
+
+\fBint wresize(WINDOW *win, int lines, int columns);\fR
+.
+.SH DESCRIPTION
+The \fBwresize\fR function reallocates storage for an \fBcurses\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 \fBwbkgndset\fR) merged into them.
+.
+.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,
+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 caller must ensure that the window's dimensions fit within the
+actual screen dimensions.
+.
+.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: