diff options
Diffstat (limited to 'contrib/ncurses/man/form.3x')
| -rw-r--r-- | contrib/ncurses/man/form.3x | 76 |
1 files changed, 42 insertions, 34 deletions
diff --git a/contrib/ncurses/man/form.3x b/contrib/ncurses/man/form.3x index 811b9ff..264662e 100644 --- a/contrib/ncurses/man/form.3x +++ b/contrib/ncurses/man/form.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2002 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2002,2006 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 * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form.3x,v 1.15 2002/01/19 22:48:05 tom Exp $ +.\" $Id: form.3x,v 1.20 2006/11/04 18:50:09 tom Exp $ .TH form 3X "" .SH NAME \fBform\fR - curses extension for programming forms @@ -40,26 +40,26 @@ 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, 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 \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 . @@ -101,11 +101,13 @@ 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) @@ -138,60 +140,66 @@ set_new_page \fBform_new_page\fR(3X) unpost_form \fBform_post\fR(3X) .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(3X) 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. - +.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 GNU \fBld\fR(1) and many other linkers). +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 @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: |
