ncurses 6.4 - patch 20240420

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

diff --git a/man/form_field_new.3x b/man/form_field_new.3x
index 9a18da18b85b9ac0967956fa5c9439fc3eca1bf0..9cf08adb521c0c02c8a9629cb1e9d416f369829a 100644 (file)
--- 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-2023,2024 Thomas E. Dickey                                *

 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" 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.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: form_field_new.3x,v 1.23 2020/10/17 23:06:36 tom Exp $
-.TH form_field_new 3X ""
+.\" $Id: form_field_new.3x,v 1.41 2024/03/16 15:35:01 tom Exp $
+.TH form_field_new 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .SH NAME
 .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
 .SH SYNOPSIS

-\fB#include <form.h>\fR
-.sp
-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 <form.h>
+.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
 .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
 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,
 Most
 attributes (including current contents, size, validation type, buffer count,
 growth threshold, justification, foreground, background, pad character,


@@ -61,14 +59,14 @@ options, and user pointer) are copied.
 Field status and the field page bit are
 not copied.
 .PP
 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
 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
 .SH RETURN VALUE

-The functions \fBnew_field\fR, \fBdup_field\fR, \fBlink_field\fR return
-\fBNULL\fR on error.
+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
 They set \fBerrno\fP according to their success:
 .TP 5
 .B E_OK


@@ -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
 .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.
 .TP 5
 .B E_OK
 The routine succeeded.


@@ -90,19 +88,17 @@ Routine detected an incorrect or out-of-range argument.
 .TP 5
 .B E_CONNECTED
 field is connected.
 .TP 5
 .B E_CONNECTED
 field is connected.

-.SH SEE ALSO
-\fBcurses\fR(3X), \fBform\fR(3X).
-.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
 Version 7 or BSD versions.
 .PP
 It may be unwise to count on the set of attributes copied by
 .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.
 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)