ncurses 6.1 - patch 20190727

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

diff --git a/man/form_field_info.3x b/man/form_field_info.3x
index f64c662e6059d259295de70a27e47f423ce765e4..565b4391f55614e5fadf409a48c1726a392f0b72 100644 (file)
--- a/man/form_field_info.3x
+++ b/man/form_field_info.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998 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,54 +27,57 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_field_info.3x,v 1.5 1998/11/29 01:06:24 Rick.Ohnemus Exp $
+.\" $Id: form_field_info.3x,v 1.15 2019/01/20 20:31:42 tom Exp $
 .TH form_field_info 3X ""
 .SH NAME
-\fBform_field_info\fR - retrieve field characteristics
+\fBdynamic_field_info\fP,
+\fBfield_info\fR \- retrieve field characteristics
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br
 int field_info(const FIELD *field, int *rows, int *cols,
               int *frow, int *fcol, int *nrow, int *nbuf);
 .br
-int dynamic_field_info(const FIELD *field, int *rows, int *cols, *max);
+int dynamic_field_info(const FIELD *field, int *rows, int *cols, int *max);
 .br
 .SH DESCRIPTION
 The function \fBfield_info\fR returns the sizes and other attributes passed in
-to the field at its creation time.  The attributes are: height, width, row of
+to the field at its creation time.
+The attributes are: height, width, row of
 upper-left corner, column of upper-left corner, number off-screen rows, and
 number of working buffers.
-
+.PP
 The function \fBdynamic_field_info\fR returns the actual size of the field, and
-its maximum possible size.  If the field has no size limit, the location
-addressed by the third argument will be set to 0.  (A field can be made dynamic
-by turning off the \fBO_STATIC\fR).
+its maximum possible size.
+If the field has no size limit, the location
+addressed by the third argument will be set to 0.
+A field can be made dynamic
+by turning off the \fBO_STATIC\fR option with \fBfield_opts_off\fR.
 .SH RETURN VALUE
 These routines return one of the following:
 .TP 5
-\fBE_OK\fR
+.B E_OK
 The routine succeeded.
 .TP 5
-\fBE_SYSTEM_ERROR\fR
-System error occurred (see \fBerrno\fR).
+.B E_SYSTEM_ERROR
+System error occurred (see \fBerrno\fR(3)).
 .TP 5
-\fBE_BAD_ARGUMENT\fR
+.B E_BAD_ARGUMENT
 Routine detected an incorrect or out-of-range argument.
 .SH SEE ALSO
-\fBcurses\fR(3X) and 3X pages whose names begin "form_" for detailed
+\fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
 descriptions of the entry points.
 .SH NOTES
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\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.
+.PP
+A null (zero pointer) is accepted for any of the return values,
+to ignore that value.
+Not all implementations allow this, e.g., Solaris 2.7 does not.
 .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:
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.