ncurses 6.2 - patch 20201212

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

diff --git a/man/form.3x b/man/form.3x
index 64759f2f69677f73025c8dd740e9144fb8ae1c05..685ad71f104745a01aca40d371bb47859241f148 100644 (file)
--- a/man/form.3x
+++ b/man/form.3x
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
+.\" Copyright 1998-2016,2017 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,12 +28,16 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form.3x,v 1.29 2017/02/18 16:46:53 tom Exp $
+.\" $Id: form.3x,v 1.36 2020/12/12 16:34:33 tom Exp $
 .TH form 3X ""
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
 .el       .ds '' ''
+.de bP
+.ie n  .IP \(bu 4
+.el    .IP \(bu 2
+..
 .SH NAME
 \fBform\fR \- curses extension for programming forms
 .SH SYNOPSIS
@@ -40,7 +45,8 @@
 .br
 .SH DESCRIPTION
 The \fBform\fR library provides terminal-independent facilities for composing
-form screens on character-cell terminals.  The library includes: field
+form screens on character-cell terminals.
+The library includes: field
 routines, which create and modify form fields; and form routines, which group
 fields into forms, display forms on the screen, and handle interaction with the
 user.
@@ -60,10 +66,12 @@ before using any of these functions.
 .
 .SS Current Default Values for Field Attributes
 .
-The \fBform\fR library maintains a default value for field attributes.  You
+The \fBform\fR library maintains a default value for field attributes.
+You
 can get or set this default by calling the appropriate \fBset_\fR
 or retrieval
-routine with a \fBNULL\fR field pointer.  Changing this default with a
+routine with a \fBNULL\fR field pointer.
+Changing this default with a
 \fBset_\fR function affects future field creations, but does not change the
 rendering of fields already created.
 .
@@ -71,6 +79,8 @@ rendering of fields already created.
 .
 The following table lists each \fBform\fR routine and the name of
 the manual page on which it is described.
+Routines flagged with \*(``*\*(''
+are ncurses-specific, not present in SVr4.
 .
 .TS
 l l
@@ -107,8 +117,8 @@ form_opts   \fBform_opts\fR(3X)
 form_opts_off  \fBform_opts\fR(3X)
 form_opts_on   \fBform_opts\fR(3X)
 form_page      \fBform_page\fR(3X)
-form_request_by_name   \fBform_requestname\fR(3X)
-form_request_name      \fBform_requestname\fR(3X)
+form_request_by_name   \fBform_requestname\fR(3X)*
+form_request_name      \fBform_requestname\fR(3X)*
 form_sub       \fBform_win\fR(3X)
 form_term      \fBform_hook\fR(3X)
 form_userptr   \fBform_userptr\fR(3X)
@@ -150,12 +160,12 @@ set_form_userptr  \fBform_userptr\fR(3X)
 set_form_win   \fBform_win\fR(3X)
 set_max_field  \fBform_field_buffer\fR(3X)
 set_new_page   \fBform_new_page\fR(3X)
-unfocus_current_field  \fBform_page\fR(3X)
+unfocus_current_field  \fBform_page\fR(3X)*
 unpost_form    \fBform_post\fR(3X)
 .TE
 .SH RETURN VALUE
 Routines that return pointers return \fBNULL\fR on error,
-and set errno to the corresponding error-code returned by functions
+and set \fBerrno\fP to the corresponding error-code returned by functions
 returning an integer.
 Routines that return
 an integer return one of the following error codes:
@@ -191,7 +201,7 @@ The form is already posted.
 The form driver could not process the request.
 .TP 5
 .B E_SYSTEM_ERROR
-System error occurred (see \fBerrno\fR).
+System error occurred (see \fBerrno\fR(3)).
 .TP 5
 .B E_UNKNOWN_COMMAND
 The form driver code saw an unknown request code.
@@ -203,17 +213,31 @@ In your library list, libform.a should be before libncurses.a; that is,
 you want to say \*(``\-lform \-lncurses\*('', not the other way around
 (which would give you a link error when using static libraries).
 .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.
 .PP
-A few functions are extensions added for ncurses, e.g.,
+The menu facility was documented in SVr4.2 in
+\fICharacter User Interface Programming (UNIX SVR4.2)\fP.
+.PP
+It is not part of X/Open Curses.
+.PP
+Aside from ncurses, there are few implementations:
+.bP
+systems based on SVr4 source code, e.g., Solaris.
+.bP
+NetBSD curses.
+.PP
+A few functions in this implementation are extensions added for ncurses,
+but not provided by other implementations, e.g.,
 \fBform_driver_w\fP,
 \fBunfocus_current_field\fP.
 .SH AUTHORS
-Juergen Pfeifer.  Manual pages and adaptation for ncurses by Eric
+Juergen Pfeifer.
+Manual pages and adaptation for ncurses by Eric
 S. Raymond.
 .SH SEE ALSO
-\fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
+\fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed
 descriptions of the entry points.
 .PP
 This describes \fBncurses\fR