X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_win.3x;h=ecd0a9303ffd634a220117ceb4833837b790dd0b;hp=32af49b68040c4505d9aea0497c0a5ee0d8737df;hb=0de8912c1c0746eb37b733e9e6fdf852aab9506a;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96 diff --git a/man/form_win.3x b/man/form_win.3x index 32af49b6..ecd0a930 100644 --- a/man/form_win.3x +++ b/man/form_win.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2018,2019 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 * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_win.3x,v 1.13 2010/12/04 18:38:55 tom Exp $ +.\" $Id: form_win.3x,v 1.15 2019/01/20 20:31:42 tom Exp $ .TH form_win 3X "" .SH NAME \fBform_win\fR \- make and break form window and subwindow associations @@ -45,11 +45,13 @@ WINDOW *form_sub(const FORM *form); int scale_form(const FORM *form, int *rows, int *columns); .br .SH DESCRIPTION -Every form has an associated pair of \fBcurses\fR windows. The form window +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 +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 @@ -59,14 +61,15 @@ to change the system default form window or subwindow. 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 +Routines that return pointers return \fBNULL\fR on error. +Routines that return an integer return one of the following error codes: .TP 5 .B E_OK The routine succeeded. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fR(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. @@ -84,8 +87,9 @@ No items are connected to the form. The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +These routines emulate the System V forms library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.