ncurses 6.3 - patch 20220129

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

diff --git a/man/form_driver.3x b/man/form_driver.3x
index 3b8308a927485820b2be7c015b4f6a5d2f97481e..9b9d9382702ac098646df62d8a3982ec412a71bb 100644 (file)
--- a/man/form_driver.3x
+++ b/man/form_driver.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2020,2021 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,18 +27,18 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: form_driver.3x,v 1.32 2019/01/20 20:31:42 tom Exp $
+.\" $Id: form_driver.3x,v 1.38 2021/12/25 21:49:32 tom Exp $

 .TH form_driver 3X ""
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME
 .TH form_driver 3X ""
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME

-\fBform_driver\fR,
-\fBform_driver_w\fR \- command-processing loop of the form system
+\fBform_driver\fP,
+\fBform_driver_w\fP \- command-processing loop of the form system

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <form.h>\fR
-.br
+\fB#include <form.h>\fP
+.sp

 \fBint form_driver(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB);\fP
 .br
 \fBint form_driver_w(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB, wchar_t \fP\fIwch\fP\fB);\fP
 \fBint form_driver(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB);\fP
 .br
 \fBint form_driver_w(FORM *\fP\fIform\fP\fB, int \fP\fIc\fP\fB, wchar_t \fP\fIwch\fP\fB);\fP


@@ -45,7 +46,7 @@
 .SH DESCRIPTION
 .SS form_driver
 Once a form has been posted (displayed), you should funnel input events to it
 .SH DESCRIPTION
 .SS form_driver
 Once a form has been posted (displayed), you should funnel input events to it

-through \fBform_driver\fR.  This routine has three major input cases:
+through \fBform_driver\fP.  This routine has three major input cases:

 .bP
 The input is a form navigation request.
 Navigation request codes are constants defined in \fB<form.h>\fP,
 .bP
 The input is a form navigation request.
 Navigation request codes are constants defined in \fB<form.h>\fP,


@@ -72,7 +73,7 @@ The form driver requests are as follows:
 l l
 _ _
 l l.
 l l
 _ _
 l l.

-\fIName\fR     \fIDescription\fR
+\fBName\fP     \fBDescription\fP

 REQ_BEG_FIELD  Move to the beginning of the field.
 REQ_BEG_LINE   Move to the beginning of the line.
 REQ_CLR_EOF    Clear to end of field from cursor.
 REQ_BEG_FIELD  Move to the beginning of the field.
 REQ_BEG_LINE   Move to the beginning of the line.
 REQ_CLR_EOF    Clear to end of field from cursor.


@@ -199,7 +200,7 @@ the form cursor is positioned to that field.
 .bP
 If you double-click a field,
 the form cursor is positioned to that field
 .bP
 If you double-click a field,
 the form cursor is positioned to that field

-and \fBE_UNKNOWN_COMMAND\fR is returned.
+and \fBE_UNKNOWN_COMMAND\fP is returned.

 This return value makes sense,
 because a double click usually means that an field-specific action should
 be returned.
 This return value makes sense,
 because a double click usually means that an field-specific action should
 be returned.


@@ -207,21 +208,21 @@ It is exactly the purpose of this return value to signal that an
 application specific command should be executed.
 .bP
 If a translation
 application specific command should be executed.
 .bP
 If a translation

-into a request was done, \fBform_driver\fR returns the result of this request.
+into a request was done, \fBform_driver\fP returns the result of this request.

 .RE
 .PP
 If you clicked outside the user window
 or the mouse event could not be translated
 .RE
 .PP
 If you clicked outside the user window
 or the mouse event could not be translated

-into a form request an \fBE_REQUEST_DENIED\fR is returned.
+into a form request an \fBE_REQUEST_DENIED\fP is returned.

 .SS Application-defined commands
 .PP
 If the second argument is neither printable nor one of the above
 pre-defined form requests, the driver assumes it is an application-specific
 .SS Application-defined commands
 .PP
 If the second argument is neither printable nor one of the above
 pre-defined form requests, the driver assumes it is an application-specific

-command and returns \fBE_UNKNOWN_COMMAND\fR.  Application-defined commands
-should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these
+command and returns \fBE_UNKNOWN_COMMAND\fP.  Application-defined commands
+should be defined relative to \fBMAX_COMMAND\fP, the maximum value of these

 pre-defined requests.
 .SH RETURN VALUE
 pre-defined requests.
 .SH RETURN VALUE

-\fBform_driver\fR returns one of the following error codes:
+\fBform_driver\fP returns one of the following error codes:

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


@@ -245,22 +246,22 @@ No fields are connected to the form.
 The form driver could not process the request.
 .TP 5
 .B E_SYSTEM_ERROR
 The form driver could not process the request.
 .TP 5
 .B E_SYSTEM_ERROR

-System error occurred (see \fBerrno\fR(3)).
+System error occurred (see \fBerrno\fP(3)).

 .TP 5
 .B E_UNKNOWN_COMMAND
 The form driver code saw an unknown request code.
 .
 .SH SEE ALSO
 .TP 5
 .B E_UNKNOWN_COMMAND
 The form driver code saw an unknown request code.
 .
 .SH SEE ALSO

-\fBcurses\fR(3X),
-\fBform\fR(3X),
-\fBform_field_buffer\fR(3X),
-\fBform_field_validation\fR(3X),
-\fBform_fieldtype\fR(3X),
-\fBform_variables\fR(3X),
-\fBgetch\fR(3X).
+\fBcurses\fP(3X),
+\fBform\fP(3X),
+\fBform_fieldtype\fP(3X),
+\fBform_field_buffer\fP(3X),
+\fBform_field_validation\fP(3X),
+\fBform_variables\fP(3X),
+\fBgetch\fP(3X).

 .SH NOTES
 .SH NOTES

-The header file \fB<form.h>\fR automatically includes the header files
-\fB<curses.h>\fR.
+The header file \fB<form.h>\fP automatically includes the header files
+\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