X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_opts.3x;h=db6c491eed73f399df3b2cf90a0ff36760600e63;hp=7921b3772563a47ad2d4707090e08a2505a1b663;hb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/form_opts.3x b/man/form_opts.3x index 7921b377..db6c491e 100644 --- a/man/form_opts.3x +++ b/man/form_opts.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 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 * @@ -27,33 +28,36 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_opts.3x,v 1.6 1998/11/29 01:07:53 Rick.Ohnemus Exp $ +.\" $Id: form_opts.3x,v 1.17 2020/10/18 00:03:49 tom Exp $ .TH form_opts 3X "" .SH NAME -\fBform_opts\fR - set and get form options +\fBset_form_opts\fP, +\fBform_opts_on\fP, +\fBform_opts_off\fP, +\fBform_opts\fR \- set and get form options .SH SYNOPSIS \fB#include \fR +.sp +\fBint set_form_opts(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP .br -int set_form_opts(FORM *form, OPTIONS opts); +\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 -int form_opts_on(FORM *form, OPTIONS opts); -.br -int form_opts_off(FORM *form, OPTIONS opts); -.br -OPTIONS form_opts(const FORM *form); +\fBint form_opts_off(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP .br .SH DESCRIPTION The function \fBset_form_opts\fR 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 others alone. - +.PP The function \fBform_opts_off\fR turns off the given option bits, and leaves others alone. - +.PP The function \fBform_opts\fR returns the form's current option bits. - +.PP The following options are defined (all are on by default): .TP 5 O_NL_OVERLOAD @@ -66,25 +70,20 @@ beginning of a field goes to the previous field. .SH RETURN VALUE Except for \fBform_opts\fR, each routine returns one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +.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\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +These routines emulate the System V forms library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.