X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_field_new.3x;h=cf603edf3b0a6963ec2ed924e77ce33a8b7a2232;hb=64845eab0d05cd928ed2455d5bc5b58e0b33c893;hp=18ad3b9dd6fc239df2531e1a94140b76e9bb6b63;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git
diff --git a/man/form_field_new.3x b/man/form_field_new.3x
index 18ad3b9d..cf603edf 100644
--- a/man/form_field_new.3x
+++ b/man/form_field_new.3x
@@ -1,6 +1,5 @@
-'\" t
.\"***************************************************************************
-.\" Copyright 2018,2020 Thomas E. Dickey *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey *
.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
@@ -28,32 +27,31 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: form_field_new.3x,v 1.21 2020/02/02 23:34:34 tom Exp $
-.TH form_field_new 3X ""
+.\" $Id: form_field_new.3x,v 1.37 2023/10/07 21:19:07 tom Exp $
+.TH form_field_new 3X 2023-10-07 "ncurses 6.4" "Library calls"
.SH NAME
-\fBnew_field\fR,
-\fBdup_field\fR,
-\fBlink_field\fR,
-\fBfree_field\fR \- create and destroy form fields
+\fBnew_field\fP,
+\fBdup_field\fP,
+\fBlink_field\fP,
+\fBfree_field\fP \-
+create and destroy form fields
.SH SYNOPSIS
-\fB#include
\fR
-.br
-FIELD *new_field(int height, int width,
- int toprow, int leftcol,
- int offscreen, int nbuffers);
-.br
-FIELD *dup_field(FIELD *field, int toprow, int leftcol);
-.br
-FIELD *link_field(FIELD *field, int toprow, int leftcol);
-.br
-int free_field(FIELD *field);
-.br
+.nf
+\fB#include
+.PP
+\fBFIELD *new_field(int \fIheight\fP, int \fIwidth\fP,
+ \fBint \fItoprow\fB, int \fIleftcol\fB,\fR
+ \fBint \fIoffscreen\fB, int \fInbuffers\fB);\fR
+\fBFIELD *dup_field(FIELD *\fIfield\fB, int \fItoprow\fB, int \fIleftcol\fB);\fR
+\fBFIELD *link_field(FIELD *\fIfield\fB, int \fItoprow\fB, int \fIleftcol\fB);\fR
+\fBint free_field(FIELD *\fIfield\fB);\fR
+.fi
.SH DESCRIPTION
-The function \fBnew_field\fR allocates a new field and initializes it from the
+The function \fBnew_field\fP allocates a new field and initializes it from the
parameters given: height, width, row of upper-left corner, column of upper-left
corner, number off-screen rows, and number of additional working buffers.
.PP
-The function \fBdup_field\fR duplicates a field at a new location.
+The function \fBdup_field\fP duplicates a field at a new location.
Most
attributes (including current contents, size, validation type, buffer count,
growth threshold, justification, foreground, background, pad character,
@@ -61,15 +59,15 @@ options, and user pointer) are copied.
Field status and the field page bit are
not copied.
.PP
-The function \fBlink_field\fR acts like \fBdup_field\fR, but the new field
+The function \fBlink_field\fP acts like \fBdup_field\fP, but the new field
shares buffers with its parent.
Attribute data is separate.
.PP
-The function \fBfree_field\fR de-allocates storage associated with a field.
+The function \fBfree_field\fP de-allocates storage associated with a field.
.SH RETURN VALUE
-The function, \fBnew_field\fR, \fBdup_field\fR, \fBlink_field\fR return
-\fBNULL\fR on error.
-They set errno according to their success:
+The functions \fBnew_field\fP, \fBdup_field\fP, \fBlink_field\fP return
+\fBNULL\fP on error.
+They set \fBerrno\fP according to their success:
.TP 5
.B E_OK
The routine succeeded.
@@ -80,7 +78,7 @@ Routine detected an incorrect or out-of-range argument.
.B E_SYSTEM_ERROR
System error occurred, e.g., malloc failure.
.PP
-The function \fBfree_field\fR returns one of the following:
+The function \fBfree_field\fP returns one of the following:
.TP 5
.B E_OK
The routine succeeded.
@@ -90,19 +88,20 @@ Routine detected an incorrect or out-of-range argument.
.TP 5
.B E_CONNECTED
field is connected.
-.SH SEE ALSO
-\fBcurses\fR(3X), \fBform\fR(3X).
.SH NOTES
-The header file \fB\fR automatically includes the header file
-\fB\fR.
+The header file \fB\fP automatically includes the header file
+\fB\fP.
.SH PORTABILITY
These routines emulate the System V forms library.
They were not supported on
Version 7 or BSD versions.
.PP
It may be unwise to count on the set of attributes copied by
-\fBdup_field\fR being portable; the System V forms library documents are
+\fBdup_field\fP being portable; the System V forms library documents are
not very explicit about what gets copied and what does not.
.SH AUTHORS
Juergen Pfeifer.
Manual pages and adaptation for new curses by Eric S. Raymond.
+.SH SEE ALSO
+\fB\%curses\fP(3X),
+\fB\%form\fP(3X)