ncurses 6.0 - patch 20170527
[ncurses.git] / man / form_win.3x
index a43f9c087397757546641fe28f2f8669457d031c..32af49b68040c4505d9aea0497c0a5ee0d8737df 100644 (file)
@@ -1,7 +1,36 @@
 '\" t
 '\" t
+.\"***************************************************************************
+.\" Copyright (c) 1998-2006,2010 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            *
+.\" "Software"), to deal in the Software without restriction, including      *
+.\" without limitation the rights to use, copy, modify, merge, publish,      *
+.\" distribute, distribute with modifications, sublicense, and/or sell       *
+.\" copies of the Software, and to permit persons to whom the Software is    *
+.\" furnished to do so, subject to the following conditions:                 *
+.\"                                                                          *
+.\" The above copyright notice and this permission notice shall be included  *
+.\" in all copies or substantial portions of the Software.                   *
+.\"                                                                          *
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+.\"                                                                          *
+.\" Except as contained in this notice, the name(s) of the above copyright   *
+.\" holders shall not be used in advertising or otherwise to promote the     *
+.\" sale, use or other dealings in this Software without prior written       *
+.\" authorization.                                                           *
+.\"***************************************************************************
+.\"
+.\" $Id: form_win.3x,v 1.13 2010/12/04 18:38:55 tom Exp $
 .TH form_win 3X ""
 .SH NAME
 .TH form_win 3X ""
 .SH NAME
-\fBform_win\fR - make and break form window and subwindow associations
+\fBform_win\fR \- make and break form window and subwindow associations
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br
@@ -19,36 +48,38 @@ int scale_form(const FORM *form, int *rows, int *columns);
 Every form has an associated pair of \fBcurses\fR windows.  The form window
 displays any title and border associated with the window; the form subwindow
 displays the items of the form that are currently available for selection.
 Every form has an associated pair of \fBcurses\fR windows.  The form window
 displays any title and border associated with the window; the form subwindow
 displays the items of the form that are currently available for selection.
-
+.PP
 The first four functions get and set those windows.  It is not necessary to set
 either window; by default, the driver code uses \fBstdscr\fR for both.
 The first four functions get and set those windows.  It is not necessary to set
 either window; by default, the driver code uses \fBstdscr\fR for both.
-
+.PP
 In the \fBset_\fR functions, window argument of \fBNULL\fR is treated as though
 it were \fBstsdcr\fR.  A form argument of \fBNULL\fR is treated as a request
 to change the system default form window or subwindow.
 In the \fBset_\fR functions, window argument of \fBNULL\fR is treated as though
 it were \fBstsdcr\fR.  A form argument of \fBNULL\fR is treated as a request
 to change the system default form window or subwindow.
-
-The function \fBscale_window\fR returns the minimum size required for the
-subwindow of \fIform\fR. 
+.PP
+The function \fBscale_form\fR returns the minimum size required for the
+subwindow of \fIform\fR.
 .SH RETURN VALUE
 Routines that return pointers return \fBNULL\fR on error.  Routines that return
 an integer return one of the following error codes:
 .TP 5
 .SH RETURN VALUE
 Routines that return pointers return \fBNULL\fR on error.  Routines that return
 an integer return one of the following error codes:
 .TP 5
-\fBE_OK\fR
+.B E_OK
 The routine succeeded.
 .TP 5
 The routine succeeded.
 .TP 5
-\fBE_SYSTEM_ERROR\fR
+.B E_SYSTEM_ERROR
 System error occurred (see \fBerrno\fR).
 .TP 5
 System error occurred (see \fBerrno\fR).
 .TP 5
-\fBE_BAD_ARGUMENT\fR
+.B E_BAD_ARGUMENT
 Routine detected an incorrect or out-of-range argument.
 .TP 5
 Routine detected an incorrect or out-of-range argument.
 .TP 5
-\fBE_POSTED\fR
+.B E_POSTED
 The form has already been posted.
 .TP 5
 The form has already been posted.
 .TP 5
-\fBE_NOT_CONNECTED\fR
+.B E_NOT_CONNECTED
 No items are connected to the form.
 .SH SEE ALSO
 No items are connected to the form.
 .SH SEE ALSO
-\fBcurses\fR(3X), \fBform\fR(3X).
+\fBcurses\fR(3X),
+\fBcurs_variables\fR(3X),
+\fBform\fR(3X).
 .SH NOTES
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
 .SH NOTES
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
@@ -58,9 +89,3 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: