diff options
Diffstat (limited to 'contrib/ncurses/man/form_opts.3x')
| -rw-r--r-- | contrib/ncurses/man/form_opts.3x | 53 |
1 files changed, 25 insertions, 28 deletions
diff --git a/contrib/ncurses/man/form_opts.3x b/contrib/ncurses/man/form_opts.3x index db6c491eed73..74a36d2b3d8e 100644 --- a/contrib/ncurses/man/form_opts.3x +++ b/contrib/ncurses/man/form_opts.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2019,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 * @@ -28,58 +27,53 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_opts.3x,v 1.17 2020/10/18 00:03:49 tom Exp $ -.TH form_opts 3X "" +.\" $Id: form_opts.3x,v 1.34 2024/03/16 15:35:01 tom Exp $ +.TH form_opts 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .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 -\fB#include <form.h>\fR -.sp -\fBint set_form_opts(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP -.br -\fBField_Options form_opts(const FORM *\fP\fIform\fP\fB);\fP -.sp -\fBint form_opts_on(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP -.br -\fBint form_opts_off(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP -.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 -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 -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 -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 -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 -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 -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 -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 -System error occurred (see \fBerrno\fR(3)). -.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. +System error occurred (see \fBerrno\fP(3)). .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -87,3 +81,6 @@ Version 7 or BSD versions. .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) |