ncurses 6.4 - patch 20231016

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

diff --git a/man/form_opts.3x b/man/form_opts.3x
index 7fc52367e23ecbec51c89f0f3fb09d75504e844a..a662e71b81523e088b576735fa699bb8f9a8c6b9 100644 (file)
--- a/man/form_opts.3x
+++ b/man/form_opts.3x
@@ -1,6 +1,6 @@
-'\" t

 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2015,2018 Free Software Foundation, Inc.              *
+.\" 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  *
 .\" 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,58 +27,56 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: form_opts.3x,v 1.13 2018/07/28 21:34:06 tom Exp $
-.TH form_opts 3X ""
+.\" $Id: form_opts.3x,v 1.30 2023/10/07 21:19:07 tom Exp $
+.TH form_opts 3X 2023-10-07 "ncurses 6.4" "Library calls"

 .SH NAME
 \fBset_form_opts\fP,
 \fBform_opts_on\fP,
 \fBform_opts_off\fP,
 .SH NAME
 \fBset_form_opts\fP,
 \fBform_opts_on\fP,
 \fBform_opts_off\fP,

-\fBform_opts\fR \- set and get form options
+\fBform_opts\fP \-
+set and get form options

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <form.h>\fR
-.br
-int set_form_opts(FORM *form, Field_Options opts);
-.br
-int form_opts_on(FORM *form, Field_Options opts);
-.br
-int form_opts_off(FORM *form, Field_Options opts);
-.br
-Field_Options form_opts(const FORM *form);
-.br
+.nf
+\fB#include <form.h>
+.PP
+\fBint set_form_opts(FORM *\fIform\fP, Field_Options \fIopts\fP);
+\fBField_Options form_opts(const FORM *\fIform\fP);
+.PP
+\fBint form_opts_on(FORM *\fIform\fP, Field_Options \fIopts\fP);
+\fBint form_opts_off(FORM *\fIform\fP, Field_Options \fIopts\fP);
+.fi

 .SH DESCRIPTION
 .SH DESCRIPTION

-The function \fBset_form_opts\fR sets all the given form's option bits (form
+The function \fBset_form_opts\fP sets all the given form's option bits (form

 option bits may be logically-OR'ed together).
 .PP
 option bits may be logically-OR'ed together).
 .PP

-The function \fBform_opts_on\fR turns on the given option bits, and leaves
+The function \fBform_opts_on\fP turns on the given option bits, and leaves

 others alone.
 .PP
 others alone.
 .PP

-The function \fBform_opts_off\fR turns off the given option bits, and leaves
+The function \fBform_opts_off\fP turns off the given option bits, and leaves

 others alone.
 .PP
 others alone.
 .PP

-The function \fBform_opts\fR returns the form's current option bits.
+The function \fBform_opts\fP returns the form's current option bits.

 .PP
 The following options are defined (all are on by default):
 .TP 5
 O_NL_OVERLOAD
 .PP
 The following options are defined (all are on by default):
 .TP 5
 O_NL_OVERLOAD

-Overload the \fBREQ_NEW_LINE\fR forms driver request so that calling it at the
+Overload the \fBREQ_NEW_LINE\fP forms driver request so that calling it at the

 end of a field goes to the next field.
 .TP 5
 O_BS_OVERLOAD
 end of a field goes to the next field.
 .TP 5
 O_BS_OVERLOAD

-Overload the \fBREQ_DEL_PREV\fR forms driver request so that calling it at the
+Overload the \fBREQ_DEL_PREV\fP forms driver request so that calling it at the

 beginning of a field goes to the previous field.
 .SH RETURN VALUE
 beginning of a field goes to the previous field.
 .SH RETURN VALUE

-Except for \fBform_opts\fR, each routine returns one of the following:
+Except for \fBform_opts\fP, each routine returns one of the following:

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

-System error occurred (see \fBerrno\fR).
-.SH SEE ALSO
-\fBcurses\fR(3X), \fBform\fR(3X).
+System error occurred (see \fBerrno\fP(3)).

 .SH NOTES
 .SH NOTES

-The header file \fB<form.h>\fR automatically includes the header file
-\fB<curses.h>\fR.
+The header file \fB<form.h>\fP automatically includes the header file
+\fB<curses.h>\fP.

 .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


@@ -86,3 +84,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)