form_opts(3)

form_opts3

Set and get form options

Usage

#include <form.h>

int set_form_opts(FORM *form, Field_Options opts); Field_Options form_opts(const FORM *form);

int form_opts_on(FORM *form, Field_Options opts); int form_opts_off(FORM *form, Field_Options opts);

Overview

The function set_form_opts sets all the given form's option bits (form option bits may be logically “or”-ed together).

The function form_opts_on turns on the given option bits, and leaves others alone.

The function form_opts_off turns off the given option bits, and leaves others alone.

The function form_opts returns the form's current option bits.

The following options are defined (all are on by default):

O_NL_OVERLOAD

Overload the REQ_NEW_LINE forms driver request so that calling it at the end of a field goes to the next field.

O_BS_OVERLOAD

Overload the REQ_DEL_PREV forms driver request so that calling it at the beginning of a field goes to the previous field.

Return value

Except for form_opts, each routine returns one of the following:

E_OK

The routine succeeded.

E_SYSTEM_ERROR

System error occurred (see errno(3)).

Portability

These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions.

Releases

66 releases since FreeBSD 4.3-RELEASE; the text changed 11 times.

  1. 4.3–6.2
  2. 6.3
  3. 6.4
  4. 7.0
  5. 7.1–10.4
  6. 11.0–12.4
  7. 13.0–13.5
  8. 14.0–14.1
  9. 14.2–14.4
  10. 14.5
  11. 15.0
  12. 15.1–16.0

Authors

Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's man source.