ncurses 6.5 - patch 20240518

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

diff --git a/man/form_new.3x b/man/form_new.3x
index e606853f3896cd81fb93f3777e45a8f6e33583bb..dc45e183f8aa616497b9bc603385f05756ebc84d 100644 (file)
--- a/man/form_new.3x
+++ b/man/form_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,26 +27,27 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: form_new.3x,v 1.14 2020/10/17 23:08:09 tom Exp $
-.TH form_new 3X ""
+.\" $Id: form_new.3x,v 1.32 2024/03/16 15:35:01 tom Exp $
+.TH form_new 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .SH NAME
 .SH NAME

-\fBnew_form\fR,
-\fBfree_form\fP \- create and destroy forms
+\fBnew_form\fP,
+\fBfree_form\fP \-
+create and destroy forms

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <form.h>\fR
-.sp
-FORM *new_form(FIELD **fields);
-.br
-int free_form(FORM *form);
-.br
+.nf
+\fB#include <form.h>
+.PP
+\fBFORM *new_form(FIELD **\fIfields\fP);
+\fBint free_form(FORM *\fIform\fP);
+.fi

 .SH DESCRIPTION
 .SH DESCRIPTION

-The function \fBnew_form\fR creates a new form connected to a specified field
-pointer array (which must be \fBNULL\fR-terminated).
+The function \fBnew_form\fP creates a new form connected to a specified field
+pointer array (which must be \fBNULL\fP-terminated).

 .PP
 .PP

-The function \fBfree_form\fR disconnects \fIform\fR from its field array
+The function \fBfree_form\fP disconnects \fIform\fP from its field array

 and frees the storage allocated for the form.
 .SH RETURN VALUE
 and frees the storage allocated for the form.
 .SH RETURN VALUE

-The function \fBnew_form\fR returns \fBNULL\fR on error.
+The function \fBnew_form\fP returns \fBNULL\fP on error.

 It sets \fBerrno\fP according to the function's success:
 .TP 5
 .B E_OK
 It sets \fBerrno\fP according to the function's success:
 .TP 5
 .B E_OK


@@ -62,7 +62,7 @@ The field is already connected to a form.
 .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_form\fR returns one of the following:
+The function \fBfree_form\fP returns one of the following:

 .TP 5
 .B E_OK
 The routine succeeded.
 .TP 5
 .B E_OK
 The routine succeeded.


@@ -72,11 +72,6 @@ Routine detected an incorrect or out-of-range argument.
 .TP 5
 .B E_POSTED
 The form has already been posted.
 .TP 5
 .B E_POSTED
 The form has already been posted.

-.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
 .SH PORTABILITY
 These routines emulate the System V forms library.
 They were not supported on


@@ -84,3 +79,6 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.
 Manual pages and adaptation for new curses by Eric S. Raymond.
 .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)