diff options
Diffstat (limited to 'lib/libform')
| -rw-r--r-- | lib/libform/Makefile | 2 | ||||
| -rw-r--r-- | lib/libform/form.3 | 171 | ||||
| -rw-r--r-- | lib/libform/form.3tbl | 172 | ||||
| -rw-r--r-- | lib/libform/form_driver.3 | 5 | ||||
| -rw-r--r-- | lib/libform/form_field_buffer.3 | 4 | ||||
| -rw-r--r-- | lib/libform/form_field_new.3 | 5 | ||||
| -rw-r--r-- | lib/libform/form_field_validation.3 | 5 |
7 files changed, 184 insertions, 180 deletions
diff --git a/lib/libform/Makefile b/lib/libform/Makefile index 0f3eafacbdb..579cd9418ec 100644 --- a/lib/libform/Makefile +++ b/lib/libform/Makefile @@ -8,7 +8,7 @@ SRCS= fld_arg.c fld_attr.c fld_current.c fld_def.c fld_dup.c fld_ftchoice.c \ fty_alpha.c fty_enum.c fty_int.c fty_ipv4.c fty_num.c fty_regex.c HDRS= form.h CFLAGS+=-I${.CURDIR}/../libmenu -I${.CURDIR}/../libcurses -DHAVE_CONFIG_H -MAN= form.3 form_cursor.3 form_data.3 form_driver.3 form_field.3 \ +MAN= form.3tbl form_cursor.3 form_data.3 form_driver.3 form_field.3 \ form_field_attributes.3 form_field_buffer.3 form_field_info.3 \ form_field_just.3 form_field_new.3 form_field_opts.3 \ form_field_userptr.3 form_field_validation.3 form_fieldtype.3 \ diff --git a/lib/libform/form.3 b/lib/libform/form.3 deleted file mode 100644 index d0ba0e1112b..00000000000 --- a/lib/libform/form.3 +++ /dev/null @@ -1,171 +0,0 @@ -'\" t -.\" $OpenBSD: form.3,v 1.4 1997/12/03 05:46:26 millert Exp $ -.TH forms 3 "" -.SH NAME -\fBforms\fR - curses extension for programming forms -.SH SYNOPSIS -\fB#include <form.h>\fR -.br -.SH DESCRIPTION -The \fBforms\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 \fBforms\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 \fBforms\fR library, link with the options -\fB-lform -lcurses\fR. - -.SS Current Default Values for Field Attributes - -The \fBforms\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 -= -\fBcurrent_field\fR form_page(3) -\fBdata_ahead\fR form_data(3) -\fBdata_behind\fR form_data(3) -\fBdup_field\fR form_field_new(3) -\fBdynamic_fieldinfo\fR form_field_info(3) -\fBfield_arg\fR form_field_validation(3) -\fBfield_back\fR form_field_attributes(3) -\fBfield_buffer\fR form_field_buffer(3) -\fBfield_count\fR form_field(3) -\fBfield_fore\fR form_field_attributes(3) -\fBfield_index\fR form_page(3) -\fBfield_info\fR form_field_info(3) -\fBfield_init\fR form_hook(3) -\fBfield_just\fR form_field_just(3) -\fBfield_opts\fR form_field_opts(3) -\fBfield_opts_off\fR form_field_opts(3) -\fBfield_opts_on\fR form_field_opts(3) -\fBfield_pad\fR form_field_attributes(3) -\fBfield_status\fR form_field_buffer(3) -\fBfield_term\fR form_hook(3) -\fBfield_type\fR form_field_validation(3) -\fBfield_userptr\fR form_field_userptr(3) -\fBform_driver\fR form_driver(3) -\fBform_fields\fR form_field(3) -\fBform_init\fR form_hook(3) -\fBform_opts\fR form_opts(3) -\fBform_opts_off\fR form_opts(3) -\fBform_opts_on\fR form_opts(3) -\fBform_page\fR form_page(3) -\fBform_request_by_name\fR form_requestname(3) -\fBform_request_name\fR form_requestname(3) -\fBform_sub\fR form_win(3) -\fBform_term\fR form_hook(3) -\fBform_userptr\fR form_userptr(3) -\fBform_win\fR form_win(3) -\fBfree_field\fR form_field_new(3) -\fBfree_form\fR form_new(3) -\fBlink_field\fR form_field_new(3) -\fBlink_fieldtype\fR link_fieldtype(3) -\fBmove_field\fR form_field(3) -\fBnew_field\fR form_field_new(3) -\fBnew_form\fR form_new(3) -\fBnew_page\fR form_new_page(3) -\fBpos_form_cursor\fR form_cursor(3) -\fBpost_form\fR form_post(3) -\fBscale_form\fR form_win(3) -\fBset_current_field\fR form_page(3) -\fBset_field_back\fR form_field_attributes(3) -\fBset_field_buffer\fR form_field_buffer(3) -\fBset_field_fore\fR form_field_attributes(3) -\fBset_field_init\fR form_hook(3) -\fBset_field_just\fR form_field_just(3) -\fBset_field_opts\fR form_field_opts(3) -\fBset_field_pad\fR form_field_attributes(3) -\fBset_field_status\fR form_field_buffer(3) -\fBset_field_term\fR form_hook(3) -\fBset_field_type\fR form_field_validation(3) -\fBset_field_userptr\fR form_field_userptr(3) -\fBset_fieldtype_arg\fR form_fieldtype(3) -\fBset_fieldtype_choice\fR form_fieldtype(3) -\fBset_form_fields\fR form_field(3) -\fBset_form_init\fR form_hook(3) -\fBset_form_opts\fR form_field_opts(3) -\fBset_form_page\fR form_page(3) -\fBset_form_sub\fR form_win(3) -\fBset_form_term\fR form_hook(3) -\fBset_form_userptr\fR form_userptr(3) -\fBset_form_win\fR form_win(3) -\fBset_max_field\fR form_field_buffer(3) -\fBset_new_page\fR form_new_page(3) -\fBunpost_form\fR form_post(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: 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: diff --git a/lib/libform/form_driver.3 b/lib/libform/form_driver.3 index 4c1bac32be3..8e65d15797d 100644 --- a/lib/libform/form_driver.3 +++ b/lib/libform/form_driver.3 @@ -1,5 +1,6 @@ '\" t -.\" $OpenBSD: form_driver.3,v 1.4 1997/12/03 05:46:27 millert Exp $ +.\" $OpenBSD: form_driver.3,v 1.5 1997/12/14 23:19:27 millert Exp $ +.\" Id: form_driver.3x,v 0.5 1997/12/14 01:26:33 tom Exp $ .TH form_driver 3 "" .SH NAME \fBform_driver\fR - command-processing loop of the form system @@ -227,7 +228,7 @@ Contents of field is invalid. \fBE_REQUEST_DENIED\fR The form driver could not process the request. .SH SEE ALSO -\fBcurses\fR(3), \fBforms\fR(3x). +\fBcurses\fR(3), \fBforms\fR(3). .SH NOTES The header file \fB<form.h>\fR automatically includes the header files \fB<curses.h>\fR. diff --git a/lib/libform/form_field_buffer.3 b/lib/libform/form_field_buffer.3 index 14de9c767eb..7a98d54268f 100644 --- a/lib/libform/form_field_buffer.3 +++ b/lib/libform/form_field_buffer.3 @@ -1,5 +1,5 @@ '\" t -.\" $OpenBSD: form_field_buffer.3,v 1.4 1997/12/03 05:46:29 millert Exp $ +.\" $OpenBSD: form_field_buffer.3,v 1.5 1997/12/14 23:19:28 millert Exp $ .TH form_field_buffer 3 "" .SH NAME \fBform_field_buffer\fR - field buffer control @@ -20,7 +20,7 @@ int set_max_field(FIELD *field, int max); The function \fBset_field_buffer\fR sets the numbered buffer of the given field to contain a given string. Buffer 0 is the displayed value of the field; other numbered buffers may be allocated by applications through the \fBnbuf\fR -argument of (see \fBfield_new\fR(3)) but are not manipulated by the forms +argument of (see \fBform_field_new\fR(3)) but are not manipulated by the forms library. The function \fBfield_buffer\fR returns the foreground attribute. The function \fBset_field_status\fR sets the associated status flag of diff --git a/lib/libform/form_field_new.3 b/lib/libform/form_field_new.3 index 907b16ebd19..3675b2e9296 100644 --- a/lib/libform/form_field_new.3 +++ b/lib/libform/form_field_new.3 @@ -1,5 +1,6 @@ '\" t -.\" $OpenBSD: form_field_new.3,v 1.4 1997/12/03 05:46:30 millert Exp $ +.\" $OpenBSD: form_field_new.3,v 1.5 1997/12/14 23:19:28 millert Exp $ +.\" Id: form_field_new.3x,v 0.6 1997/12/06 22:07:19 tom Exp $ .TH form_field_new 3 "" .SH NAME \fBform_field_new\fR - create and destroy form fields @@ -55,7 +56,7 @@ These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. It may be unwise to count on the set of attributes copied by -\fBdup_field\fR(3x) being portable; the System V forms library documents are +\fBdup_field\fR(3) being portable; the System V forms library documents are not very explicit on what gets copied and was not. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric diff --git a/lib/libform/form_field_validation.3 b/lib/libform/form_field_validation.3 index 834566906db..dfa7d4d8820 100644 --- a/lib/libform/form_field_validation.3 +++ b/lib/libform/form_field_validation.3 @@ -1,5 +1,6 @@ '\" t -.\" $OpenBSD: form_field_validation.3,v 1.4 1997/12/03 05:46:31 millert Exp $ +.\" $OpenBSD: form_field_validation.3,v 1.5 1997/12/14 23:19:29 millert Exp $ +.\" Id: form_field_validation.3x,v 0.9 1997/12/06 22:08:27 tom Exp $ .TH form_field_validation 3 "" .SH NAME \fBform_field_validation\fR - data type validation for fields @@ -55,7 +56,7 @@ For details of the precision handling see \fBprintf's\fR man-page. TYPE_REGEXP Regular expression data. Requires a regular expression \fB(char *)\fR third argument; the data is valid if the regular expression matches it. Regular expressions -are in the format of \fBregcomp\fR(3x) and \fBregexec\fR(3). Please notice +are in the format of \fBregcomp\fR(3) and \fBregexec\fR(3). Please notice that the regular expression must match the whole field. If you have for example an eight character wide field, a regular expression "^[0-9]*$" always means that you have to fill all eight positions with digits. If you want to |