X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform.3x;fp=man%2Fform.3x;h=5808d1e9427579add0088e9934f0664d243bc4b8;hp=685ad71f104745a01aca40d371bb47859241f148;hb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;hpb=e6bb3226cdd35f5fd9f45bb1685cc2203c889480 diff --git a/man/form.3x b/man/form.3x index 685ad71f..5808d1e9 100644 --- a/man/form.3x +++ b/man/form.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" 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 * @@ -28,7 +28,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form.3x,v 1.36 2020/12/12 16:34:33 tom Exp $ +.\" $Id: form.3x,v 1.38 2021/12/25 21:49:32 tom Exp $ .TH form 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -39,21 +39,21 @@ .el .IP \(bu 2 .. .SH NAME -\fBform\fR \- curses extension for programming forms +\fBform\fP \- curses extension for programming forms .SH SYNOPSIS -\fB#include \fR +\fB#include \fP .br .SH DESCRIPTION -The \fBform\fR library provides terminal-independent facilities for composing +The \fBform\fP library provides terminal-independent facilities for composing 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. .PP -The \fBform\fR library uses the \fBcurses\fR libraries. -To use the \fBform\fR library, link with the options -\fB\-lform \-lcurses\fR. +The \fBform\fP library uses the \fBcurses\fP libraries. +To use the \fBform\fP library, link with the options +\fB\-lform \-lcurses\fP. .PP Your program should set up the locale, e.g., .sp @@ -61,23 +61,23 @@ Your program should set up the locale, e.g., .sp so that input/output processing will work. .PP -A curses initialization routine such as \fBinitscr\fR must be called +A curses initialization routine such as \fBinitscr\fP must be called before using any of these functions. . .SS Current Default Values for Field Attributes . -The \fBform\fR library maintains a default value for field attributes. +The \fBform\fP library maintains a default value for field attributes. You -can get or set this default by calling the appropriate \fBset_\fR +can get or set this default by calling the appropriate \fBset_\fP or retrieval -routine with a \fBNULL\fR field pointer. +routine with a \fBNULL\fP field pointer. Changing this default with a -\fBset_\fR function affects future field creations, but does not change the +\fBset_\fP function affects future field creations, but does not change the rendering of fields already created. . .SS Routine Name Index . -The following table lists each \fBform\fR routine and the name of +The following table lists each \fBform\fP routine and the name of the manual page on which it is described. Routines flagged with \*(``*\*('' are ncurses-specific, not present in SVr4. @@ -85,86 +85,86 @@ are ncurses-specific, not present in SVr4. .TS l l l l . -\fBcurses\fR Routine Name Manual Page Name +\fBcurses\fP Routine Name Manual Page Name = -current_field \fBform_page\fR(3X) -data_ahead \fBform_data\fR(3X) -data_behind \fBform_data\fR(3X) -dup_field \fBform_field_new\fR(3X) -dynamic_field_info \fBform_field_info\fR(3X) -field_arg \fBform_field_validation\fR(3X) -field_back \fBform_field_attributes\fR(3X) -field_buffer \fBform_field_buffer\fR(3X) -field_count \fBform_field\fR(3X) -field_fore \fBform_field_attributes\fR(3X) -field_index \fBform_page\fR(3X) -field_info \fBform_field_info\fR(3X) -field_init \fBform_hook\fR(3X) -field_just \fBform_field_just\fR(3X) -field_opts \fBform_field_opts\fR(3X) -field_opts_off \fBform_field_opts\fR(3X) -field_opts_on \fBform_field_opts\fR(3X) -field_pad \fBform_field_attributes\fR(3X) -field_status \fBform_field_buffer\fR(3X) -field_term \fBform_hook\fR(3X) -field_type \fBform_field_validation\fR(3X) -field_userptr \fBform_field_userptr\fR(3X) -form_driver \fBform_driver\fR(3X) -form_driver_w \fBform_driver\fR(3X)* -form_fields \fBform_field\fR(3X) -form_init \fBform_hook\fR(3X) -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_sub \fBform_win\fR(3X) -form_term \fBform_hook\fR(3X) -form_userptr \fBform_userptr\fR(3X) -form_win \fBform_win\fR(3X) -free_field \fBform_field_new\fR(3X) -free_fieldtype \fBform_fieldtype\fR(3X) -free_form \fBform_new\fR(3X) -link_field \fBform_field_new\fR(3X) -link_fieldtype \fBform_fieldtype\fR(3X) -move_field \fBform_field\fR(3X) -new_field \fBform_field_new\fR(3X) -new_fieldtype \fBform_fieldtype\fR(3X) -new_form \fBform_new\fR(3X) -new_page \fBform_new_page\fR(3X) -pos_form_cursor \fBform_cursor\fR(3X) -post_form \fBform_post\fR(3X) -scale_form \fBform_win\fR(3X) -set_current_field \fBform_page\fR(3X) -set_field_back \fBform_field_attributes\fR(3X) -set_field_buffer \fBform_field_buffer\fR(3X) -set_field_fore \fBform_field_attributes\fR(3X) -set_field_init \fBform_hook\fR(3X) -set_field_just \fBform_field_just\fR(3X) -set_field_opts \fBform_field_opts\fR(3X) -set_field_pad \fBform_field_attributes\fR(3X) -set_field_status \fBform_field_buffer\fR(3X) -set_field_term \fBform_hook\fR(3X) -set_field_type \fBform_field_validation\fR(3X) -set_field_userptr \fBform_field_userptr\fR(3X) -set_fieldtype_arg \fBform_fieldtype\fR(3X) -set_fieldtype_choice \fBform_fieldtype\fR(3X) -set_form_fields \fBform_field\fR(3X) -set_form_init \fBform_hook\fR(3X) -set_form_opts \fBform_field_opts\fR(3X) -set_form_page \fBform_page\fR(3X) -set_form_sub \fBform_win\fR(3X) -set_form_term \fBform_hook\fR(3X) -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)* -unpost_form \fBform_post\fR(3X) +current_field \fBform_page\fP(3X) +data_ahead \fBform_data\fP(3X) +data_behind \fBform_data\fP(3X) +dup_field \fBform_field_new\fP(3X) +dynamic_field_info \fBform_field_info\fP(3X) +field_arg \fBform_field_validation\fP(3X) +field_back \fBform_field_attributes\fP(3X) +field_buffer \fBform_field_buffer\fP(3X) +field_count \fBform_field\fP(3X) +field_fore \fBform_field_attributes\fP(3X) +field_index \fBform_page\fP(3X) +field_info \fBform_field_info\fP(3X) +field_init \fBform_hook\fP(3X) +field_just \fBform_field_just\fP(3X) +field_opts \fBform_field_opts\fP(3X) +field_opts_off \fBform_field_opts\fP(3X) +field_opts_on \fBform_field_opts\fP(3X) +field_pad \fBform_field_attributes\fP(3X) +field_status \fBform_field_buffer\fP(3X) +field_term \fBform_hook\fP(3X) +field_type \fBform_field_validation\fP(3X) +field_userptr \fBform_field_userptr\fP(3X) +form_driver \fBform_driver\fP(3X) +form_driver_w \fBform_driver\fP(3X)* +form_fields \fBform_field\fP(3X) +form_init \fBform_hook\fP(3X) +form_opts \fBform_opts\fP(3X) +form_opts_off \fBform_opts\fP(3X) +form_opts_on \fBform_opts\fP(3X) +form_page \fBform_page\fP(3X) +form_request_by_name \fBform_requestname\fP(3X)* +form_request_name \fBform_requestname\fP(3X)* +form_sub \fBform_win\fP(3X) +form_term \fBform_hook\fP(3X) +form_userptr \fBform_userptr\fP(3X) +form_win \fBform_win\fP(3X) +free_field \fBform_field_new\fP(3X) +free_fieldtype \fBform_fieldtype\fP(3X) +free_form \fBform_new\fP(3X) +link_field \fBform_field_new\fP(3X) +link_fieldtype \fBform_fieldtype\fP(3X) +move_field \fBform_field\fP(3X) +new_field \fBform_field_new\fP(3X) +new_fieldtype \fBform_fieldtype\fP(3X) +new_form \fBform_new\fP(3X) +new_page \fBform_new_page\fP(3X) +pos_form_cursor \fBform_cursor\fP(3X) +post_form \fBform_post\fP(3X) +scale_form \fBform_win\fP(3X) +set_current_field \fBform_page\fP(3X) +set_field_back \fBform_field_attributes\fP(3X) +set_field_buffer \fBform_field_buffer\fP(3X) +set_field_fore \fBform_field_attributes\fP(3X) +set_field_init \fBform_hook\fP(3X) +set_field_just \fBform_field_just\fP(3X) +set_field_opts \fBform_field_opts\fP(3X) +set_field_pad \fBform_field_attributes\fP(3X) +set_field_status \fBform_field_buffer\fP(3X) +set_field_term \fBform_hook\fP(3X) +set_field_type \fBform_field_validation\fP(3X) +set_field_userptr \fBform_field_userptr\fP(3X) +set_fieldtype_arg \fBform_fieldtype\fP(3X) +set_fieldtype_choice \fBform_fieldtype\fP(3X) +set_form_fields \fBform_field\fP(3X) +set_form_init \fBform_hook\fP(3X) +set_form_opts \fBform_field_opts\fP(3X) +set_form_page \fBform_page\fP(3X) +set_form_sub \fBform_win\fP(3X) +set_form_term \fBform_hook\fP(3X) +set_form_userptr \fBform_userptr\fP(3X) +set_form_win \fBform_win\fP(3X) +set_max_field \fBform_field_buffer\fP(3X) +set_new_page \fBform_new_page\fP(3X) +unfocus_current_field \fBform_page\fP(3X)* +unpost_form \fBform_post\fP(3X) .TE .SH RETURN VALUE -Routines that return pointers return \fBNULL\fR on error, +Routines that return pointers return \fBNULL\fP on error, and set \fBerrno\fP to the corresponding error-code returned by functions returning an integer. Routines that return @@ -201,13 +201,13 @@ 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(3)). +System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_UNKNOWN_COMMAND The form driver code saw an unknown request code. .SH NOTES -The header file \fB\fR automatically includes the header files -\fB\fR and \fB\fR. +The header file \fB\fP automatically includes the header files +\fB\fP and \fB\fP. .PP In your library list, libform.a should be before libncurses.a; that is, you want to say \*(``\-lform \-lncurses\*('', not the other way around @@ -237,8 +237,8 @@ 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\fP(3X) and related pages whose names begin \*(``form_\*('' for detailed descriptions of the entry points. .PP -This describes \fBncurses\fR +This describes \fBncurses\fP version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).