ncurses 4.1
[ncurses.git] / man / resizeterm.3x
1 .\"*****************************************************************************
2 .\" Copyright 1996 by Thomas E. Dickey <dickey@clark.net>                      *
3 .\" All Rights Reserved.                                                       *
4 .\"                                                                            *
5 .\" Permission to use, copy, modify, and distribute this software and its      *
6 .\" documentation for any purpose and without fee is hereby granted, provided  *
7 .\" that the above copyright notice appear in all copies and that both that    *
8 .\" copyright notice and this permission notice appear in supporting           *
9 .\" documentation, and that the name of the above listed copyright holder(s)   *
10 .\" not be used in advertising or publicity pertaining to distribution of the  *
11 .\" software without specific, written prior permission. THE ABOVE LISTED      *
12 .\" COPYRIGHT HOLDER(S) DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,  *
13 .\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO     *
14 .\" EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR ANY         *
15 .\" SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER       *
16 .\" RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF       *
17 .\" CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN        *
18 .\" CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.                   *
19 .\"*****************************************************************************
20 .\" $Id: resizeterm.3x,v 1.3 1996/12/28 20:00:50 tom Exp $
21 .TH resizeterm 3X ""
22 .
23 .SH NAME
24 \fBresizeterm\fR - change the curses terminal size
25 .
26 .SH SYNOPSIS
27 \fB#include <curses.h>\fR
28
29 \fBint resizeterm(int lines, int columns);\fR
30 .
31 .SH DESCRIPTION
32 This is an extension to the curses library.
33 It provides callers with a hook into the \fBncurses\fR data to resize windows,
34 primarily for use by programs running in an X Window terminal (e.g., xterm).
35 The function \fBresizeterm\fR resizes the standard and current windows
36 to the specified dimensions, and adjusts other bookkeeping data used by
37 the \fBncurses\fR library that record the window dimensions.
38
39 When resizing the windows, the function blank-fills the areas that are
40 extended. The calling application should fill in these areas with
41 appropriate data.
42
43 The function attempts to resize all windows.
44 However, due to the calling convention of pads,
45 it is not possible to resize these
46 without additional interaction with the application.
47 .
48 .SH RETURN VALUE
49 The function returns the integer \fBERR\fR upon failure and \fBOK\fR on success.
50 It will fail if either of the dimensions less than or equal to zero,
51 or if an error occurs while (re)allocating memory for the windows. 
52 .
53 .SH NOTES
54 While this function is intended to be used to support a signal handler
55 (i.e., for SIGWINCH), care should be taken to avoid invoking it in a
56 context where \fBmalloc\fR or \fBrealloc\fR may have been interrupted,
57 since it uses those functions.
58 .
59 .SH SEE ALSO
60 \fBwresize\fR(3x).
61 .
62 .SH AUTHOR
63 Thomas Dickey (from an equivalent function written in 1988 for BSD curses).
64 .\"#
65 .\"# The following sets edit modes for GNU EMACS
66 .\"# Local Variables:
67 .\"# mode:nroff
68 .\"# fill-column:79
69 .\"# End: