ncurses 6.1 - patch 20190121

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

diff --git a/man/form_field_info.3x b/man/form_field_info.3x
index 6a1af6c3139b0b012865ac08c4f8796d7e04872d..565b4391f55614e5fadf409a48c1726a392f0b72 100644 (file)
--- a/man/form_field_info.3x
+++ b/man/form_field_info.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -27,10 +27,11 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: form_field_info.3x,v 1.12 2010/12/04 18:40:45 tom Exp $
+.\" $Id: form_field_info.3x,v 1.15 2019/01/20 20:31:42 tom Exp $

 .TH form_field_info 3X ""
 .SH NAME
 .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
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br


@@ -41,12 +42,14 @@ 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
 .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
 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
+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.
 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.


@@ -57,7 +60,7 @@ These routines return one of the following:
 The routine succeeded.
 .TP 5
 .B E_SYSTEM_ERROR
 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.
 .TP 5
 .B E_BAD_ARGUMENT
 Routine detected an incorrect or out-of-range argument.


@@ -68,12 +71,13 @@ descriptions of the entry points.
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
 .SH PORTABILITY
 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
 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.
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.