diff options
Diffstat (limited to 'lib/libform/form.3tbl')
| -rw-r--r-- | lib/libform/form.3tbl | 172 |
1 files changed, 172 insertions, 0 deletions
diff --git a/lib/libform/form.3tbl b/lib/libform/form.3tbl new file mode 100644 index 00000000000..ac06e9e2f61 --- /dev/null +++ b/lib/libform/form.3tbl @@ -0,0 +1,172 @@ +'\" t +.\" $OpenBSD: form.3tbl,v 1.1 1997/12/14 23:19:27 millert Exp $ +.\" Id: form.3x,v 0.8 1997/12/14 01:44:04 tom Exp $ +.TH form 3 "" +.SH NAME +\fBform\fR - curses extension for programming forms +.SH SYNOPSIS +\fB#include <form.h>\fR +.br +.SH DESCRIPTION +The \fBform\fR 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. + +The \fBform\fR library uses the \fBcurses\fR libraries, and a curses +initialization routine such as \fBinitscr\fR must be called before using any of +these functions. To use the \fBform\fR library, link with the options +\fB-lform -lcurses\fR. + +.SS Current Default Values for Field Attributes + +The \fBform\fR library maintains a default value for field attributes. You +can get or set this default by calling the appropriate \fBget_\fR or \fBset_\fR +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. + +.SS Routine Name Index + +The following table lists each \fBform\fR routine and the name of +the manual page on which it is described. + +.TS +l l +l l . +\fBcurses\fR Routine Name Manual Page Name += +current_field \fBform_page\fR(3) +data_ahead \fBform_data\fR(3) +data_behind \fBform_data\fR(3) +dup_field \fBform_field_new\fR(3) +dynamic_fieldinfo \fBform_field_info\fR(3) +field_arg \fBform_field_validation\fR(3) +field_back \fBform_field_attributes\fR(3) +field_buffer \fBform_field_buffer\fR(3) +field_count \fBform_field\fR(3) +field_fore \fBform_field_attributes\fR(3) +field_index \fBform_page\fR(3) +field_info \fBform_field_info\fR(3) +field_init \fBform_hook\fR(3) +field_just \fBform_field_just\fR(3) +field_opts \fBform_field_opts\fR(3) +field_opts_off \fBform_field_opts\fR(3) +field_opts_on \fBform_field_opts\fR(3) +field_pad \fBform_field_attributes\fR(3) +field_status \fBform_field_buffer\fR(3) +field_term \fBform_hook\fR(3) +field_type \fBform_field_validation\fR(3) +field_userptr \fBform_field_userptr\fR(3) +form_driver \fBform_driver\fR(3) +form_fields \fBform_field\fR(3) +form_init \fBform_hook\fR(3) +form_opts \fBform_opts\fR(3) +form_opts_off \fBform_opts\fR(3) +form_opts_on \fBform_opts\fR(3) +form_page \fBform_page\fR(3) +form_request_by_name \fBform_requestname\fR(3) +form_request_name \fBform_requestname\fR(3) +form_sub \fBform_win\fR(3) +form_term \fBform_hook\fR(3) +form_userptr \fBform_userptr\fR(3) +form_win \fBform_win\fR(3) +free_field \fBform_field_new\fR(3) +free_form \fBform_new\fR(3) +link_field \fBform_field_new\fR(3) +link_fieldtype \fBform_fieldtype\fR(3) +move_field \fBform_field\fR(3) +new_field \fBform_field_new\fR(3) +new_form \fBform_new\fR(3) +new_page \fBform_new_page\fR(3) +pos_form_cursor \fBform_cursor\fR(3) +post_form \fBform_post\fR(3) +scale_form \fBform_win\fR(3) +set_current_field \fBform_page\fR(3) +set_field_back \fBform_field_attributes\fR(3) +set_field_buffer \fBform_field_buffer\fR(3) +set_field_fore \fBform_field_attributes\fR(3) +set_field_init \fBform_hook\fR(3) +set_field_just \fBform_field_just\fR(3) +set_field_opts \fBform_field_opts\fR(3) +set_field_pad \fBform_field_attributes\fR(3) +set_field_status \fBform_field_buffer\fR(3) +set_field_term \fBform_hook\fR(3) +set_field_type \fBform_field_validation\fR(3) +set_field_userptr \fBform_field_userptr\fR(3) +set_fieldtype_arg \fBform_fieldtype\fR(3) +set_fieldtype_choice \fBform_fieldtype\fR(3) +set_form_fields \fBform_field\fR(3) +set_form_init \fBform_hook\fR(3) +set_form_opts \fBform_field_opts\fR(3) +set_form_page \fBform_page\fR(3) +set_form_sub \fBform_win\fR(3) +set_form_term \fBform_hook\fR(3) +set_form_userptr \fBform_userptr\fR(3) +set_form_win \fBform_win\fR(3) +set_max_field \fBform_field_buffer\fR(3) +set_new_page \fBform_new_page\fR(3) +unpost_form \fBform_post\fR(3) +.TE +.SH RETURN VALUE +Routines that return pointers return \fBNULL\fR on error. Routines that return +an integer return one of the following error codes: +.TP 5 +\fBE_OK\fR +The routine succeeded. +.TP 5 +\fBE_CONNECTED\fR +The field is already connected to a form. +.TP 5 +\fBE_SYSTEM_ERROR\fR +System error occurred (see \fBerrno\fR). +.TP 5 +\fBE_BAD_ARGUMENT\fR +Routine detected an incorrect or out-of-range argument. +.TP 5 +\fBE_POSTED\fR +The form is already posted. +.TP 5 +\fBE_BAD_STATE\fR +Routine was called from an initialization or termination function. +.TP 5 +\fBE_NO_ROOM\fR +Form is too large for its window. +.TP 5 +\fBE_NOT_POSTED\fR +The form has not been posted. +.TP 5 +\fBE_UNKNOWN_COMMAND\fR +The form driver code saw an unknown request code. +.TP 5 +\fBE_INVALID_FIELD\fR +Contents of a field are not valid. +.TP 5 +\fBE_NOT_CONNECTED\fR +No fields are connected to the form. +.TP 5 +\fBE_REQUEST_DENIED\fR +The form driver could not process the request. +.SH SEE ALSO +\fBcurses\fR(3) and 3 pages whose names begin "form_" for detailed +descriptions of the entry points. +.SH NOTES +The header file \fB<form.h>\fR automatically includes the header files +\fB<curses.h>\fR and \fB<eti.h>\fR. + +In your library list, libform.a should be before libcurses.a; that is, +you want to say `-lform -lcurses', not the other way around (which would +give you a link error using GNU \fBld\fR(1) and many other linkers). +.SH PORTABILITY +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 ncurses by Eric +S. Raymond. +.\"# +.\"# The following sets edit modes for GNU EMACS +.\"# Local Variables: +.\"# mode:nroff +.\"# fill-column:79 +.\"# End: |