diff options
Diffstat (limited to 'lib/libform/form.3tbl')
| -rw-r--r-- | lib/libform/form.3tbl | 100 |
1 files changed, 58 insertions, 42 deletions
diff --git a/lib/libform/form.3tbl b/lib/libform/form.3tbl index bc11d367eca..9e2c7ae7fc0 100644 --- a/lib/libform/form.3tbl +++ b/lib/libform/form.3tbl @@ -1,8 +1,8 @@ '\" t -.\" $OpenBSD: form.3tbl,v 1.5 1999/07/11 14:14:03 millert Exp $ +.\" $OpenBSD: form.3tbl,v 1.6 2010/01/12 23:22:07 nicm Exp $ .\" .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2008 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 * @@ -29,7 +29,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $From: form.3x,v 1.13 1999/07/10 21:53:03 tom Exp $ +.\" $Id: form.3tbl,v 1.6 2010/01/12 23:22:07 nicm Exp $ .TH form 3 "" .SH NAME \fBform\fR - curses extension for programming forms @@ -42,26 +42,34 @@ 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 +.PP +The \fBform\fR library uses the \fBcurses\fR libraries. +To use the \fBform\fR library, link with the options \fB-lform -lcurses\fR. - +.PP +Your program should set up the locale, e.g., +.sp + \fBsetlocale(LC_ALL, "");\fP +.sp +so that input/output processing will work. +.PP +A curses initialization routine such as \fBinitscr\fR 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. 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 \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 . @@ -71,7 +79,7 @@ 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) +dynamic_field_info \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) @@ -103,11 +111,13 @@ 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_fieldtype \fBform_fieldtype\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_fieldtype \fBform_fieldtype\fR(3) new_form \fBform_new\fR(3) new_page \fBform_new_page\fR(3) pos_form_cursor \fBform_cursor\fR(3) @@ -140,60 +150,66 @@ 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 +Routines that return pointers return \fBNULL\fR on error, +and set errno to the corresponding error-code returned by functions +returning an integer. +Routines that return an integer return one of the following error codes: .TP 5 -\fBE_OK\fR +.B E_OK 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 +.B E_BAD_ARGUMENT 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 +.B E_BAD_STATE 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. +.B E_CONNECTED +The field is already connected to a form. .TP 5 -\fBE_INVALID_FIELD\fR +.B E_INVALID_FIELD Contents of a field are not valid. .TP 5 -\fBE_NOT_CONNECTED\fR +.B E_NOT_CONNECTED No fields are connected to the form. .TP 5 -\fBE_REQUEST_DENIED\fR +.B E_NOT_POSTED +The form has not been posted. +.TP 5 +.B E_NO_ROOM +Form is too large for its window. +.TP 5 +.B E_POSTED +The form is already posted. +.TP 5 +.B E_REQUEST_DENIED The form driver could not process the request. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR). +.TP 5 +.B E_UNKNOWN_COMMAND +The form driver code saw an unknown request code. .SH SEE ALSO -\fBcurses\fR(3) and 3 pages whose names begin with "form_" for detailed +\fBcurses\fR(3) and related 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). +.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 (which would +give you a link error using most 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. +.SH SEE ALSO +This describes \fBncurses\fR +version 5.7. .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: |