X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform.3x.html;h=be7690c2cbcc214de3efbc4fdfa954b6dbb7ff71;hb=4c9f63c460cb7134f142aa65f6866c175ed77605;hp=6251f05d2ffe5c3190d59ee2e9f98ade94d4fcc4;hpb=048a1c1a65c6d98d92fca97f8d175d10d21091d0;p=ncurses.git diff --git a/doc/html/man/form.3x.html b/doc/html/man/form.3x.html index 6251f05d..be7690c2 100644 --- a/doc/html/man/form.3x.html +++ b/doc/html/man/form.3x.html @@ -1,7 +1,8 @@ -
- +-form(3x) form(3x) +form(3x) form(3x) @@ -55,15 +56,14 @@
- The form 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 inter- - action with the user. + The form 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 form library uses the curses libraries. To use the - form library, link with the options -lform -lcurses. + The form library uses the curses libraries. To use the form library, + link with the options -lform -lcurses. Your program should set up the locale, e.g., @@ -71,22 +71,22 @@ so that input/output processing will work. - A curses initialization routine such as initscr must be - called before using any of these functions. + A curses initialization routine such as initscr must be called before + using any of these functions.
- The form library maintains a default value for field - attributes. You can get or set this default by calling - the appropriate set_ or retrieval routine with a NULL - field pointer. Changing this default with a set_ function - affects future field creations, but does not change the - rendering of fields already created. + The form library maintains a default value for field attributes. You + can get or set this default by calling the appropriate set_ or + retrieval routine with a NULL field pointer. Changing this default + with a set_ function affects future field creations, but does not + change the rendering of fields already created.
- The following table lists each form routine and the name - of the manual page on which it is described. + The following table lists each form routine and the name of the manual + page on which it is described. Routines flagged with "*" are ncurses- + specific, not present in SVr4. curses Routine Name Manual Page Name -------------------------------------------------- @@ -111,8 +111,8 @@ field_status form_field_buffer(3x) field_term form_hook(3x) field_type form_field_validation(3x) - field_userptr form_field_userptr(3x) + form_driver form_driver(3x) form_driver_w form_driver(3x)* form_fields form_field(3x) @@ -121,8 +121,8 @@ form_opts_off form_opts(3x) form_opts_on form_opts(3x) form_page form_page(3x) - form_request_by_name form_requestname(3x) - form_request_name form_requestname(3x) + form_request_by_name form_requestname(3x)* + form_request_name form_requestname(3x)* form_sub form_win(3x) form_term form_hook(3x) form_userptr form_userptr(3x) @@ -164,25 +164,23 @@ set_form_win form_win(3x) set_max_field form_field_buffer(3x) set_new_page form_new_page(3x) - unfocus_current_field form_page(3x) + unfocus_current_field form_page(3x)* unpost_form form_post(3x)
- Routines that return pointers return NULL 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: + Routines that return pointers return NULL 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: E_OK The routine succeeded. E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. + Routine detected an incorrect or out-of-range argument. E_BAD_STATE - Routine was called from an initialization or termina- - tion function. + Routine was called from an initialization or termination function. E_CONNECTED The field is already connected to a form. @@ -206,44 +204,55 @@ The form driver could not process the request. E_SYSTEM_ERROR - System error occurred (see errno). + System error occurred (see errno(3)). E_UNKNOWN_COMMAND The form driver code saw an unknown request code.
- The header file <form.h> automatically includes the header - files <curses.h> and <eti.h>. + The header file <form.h> automatically includes the header files + <curses.h> and <eti.h>. - In your library list, libform.a should be before libn- - curses.a; that is, you want to say `-lform -lncurses', not - the other way around (which would give you a link error - using most linkers). + 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 when using static libraries).
- These routines emulate the System V forms library. They - were not supported on Version 7 or BSD versions. + These routines emulate the System V forms library. They were not + supported on Version 7 or BSD versions. + + The menu facility was documented in SVr4.2 in Character User Interface + Programming (UNIX SVR4.2). + + It is not part of X/Open Curses. + + Aside from ncurses, there are few implementations: + + o systems based on SVr4 source code, e.g., Solaris. + + o NetBSD curses. - A few functions are extensions added for ncurses, e.g., + A few functions in this implementation are extensions added for + ncurses, but not provided by other implementations, e.g., form_driver_w, unfocus_current_field.
- Juergen Pfeifer. Manual pages and adaptation for ncurses - by Eric S. Raymond. + Juergen Pfeifer. Manual pages and adaptation for ncurses by Eric S. + Raymond.
- curses(3x) and related pages whose names begin "form_" for - detailed descriptions of the entry points. + curses(3x) and related pages whose names begin "form_" for detailed + descriptions of the entry points. - This describes ncurses version 6.0 (patch 20170204). + This describes ncurses version 6.3 (patch 20220416). - form(3x) + form(3x)