diff options
Diffstat (limited to 'lib/libmenu/menu.3tbl')
| -rw-r--r-- | lib/libmenu/menu.3tbl | 73 |
1 files changed, 38 insertions, 35 deletions
diff --git a/lib/libmenu/menu.3tbl b/lib/libmenu/menu.3tbl index cf7e1e6d5cd..828ba82080f 100644 --- a/lib/libmenu/menu.3tbl +++ b/lib/libmenu/menu.3tbl @@ -1,8 +1,8 @@ '\" t -.\" $OpenBSD: menu.3tbl,v 1.5 2000/07/24 04:06:12 millert Exp $ +.\" $OpenBSD: menu.3tbl,v 1.6 2010/01/12 23:22:08 nicm Exp $ .\" .\"*************************************************************************** -.\" Copyright (c) 1998,2000 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 * @@ -29,7 +29,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $From: menu.3x,v 1.14 2000/07/15 22:55:59 tom Exp $ +.\" $Id: menu.3tbl,v 1.6 2010/01/12 23:22:08 nicm Exp $ .TH menu 3 "" .SH NAME \fBmenu\fR - curses extension for programming menus @@ -41,25 +41,25 @@ The \fBmenu\fR library provides terminal-independent facilities for composing menu systems on character-cell terminals. The library includes: item routines, which create and modify menu items; and menu routines, which group items into menus, display menus on the screen, and handle interaction with the user. - +.PP The \fBmenu\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 \fBmenu\fR library, link with the options \fB-lmenu -lcurses\fR. - +. .SS Current Default Values for Item Attributes - +. The \fBmenu\fR library maintains a default value for item attributes. You can get or set this default by calling the appropriate \fBget_\fR or \fBset_\fR routine with a \fBNULL\fR item pointer. Changing this default with a \fBset_\fR function affects future item creations, but does not change the rendering of items already created. - +. .SS Routine Name Index - +. The following table lists each \fBmenu\fR routine and the name of the manual page on which it is described. - +. .TS l l . \fBcurses\fR Routine Name Manual Page Name @@ -133,57 +133,60 @@ unpost_menu \fBmenu_post\fR(3) 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 +.B E_OK The routine succeeded. .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 menu 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 -Menu is too large for its window. +.B E_NO_MATCH +Character failed to match. .TP 5 -\fBE_NOT_POSTED\fR -The menu has not been posted. +.B E_NO_ROOM +Menu is too large for its window. .TP 5 -\fBE_UNKNOWN_COMMAND\fR -The menu driver code saw an unknown request code. +.B E_NOT_CONNECTED +No items are connected to the menu. .TP 5 -\fBE_NO_MATCH\fR -Character failed to match. +.B E_NOT_POSTED +The menu has not been posted. .TP 5 -\fBE_NOT_SELECTABLE\fR +.B E_NOT_SELECTABLE The designated item cannot be selected. .TP 5 -\fBE_NOT_CONNECTED\fR -No items are connected to the menu. +.B E_POSTED +The menu is already posted. .TP 5 -\fBE_REQUEST_DENIED\fR +.B E_REQUEST_DENIED The menu 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 menu driver code saw an unknown request code. .SH SEE ALSO -\fBcurses\fR(3) and 3 pages whose names begin "menu_" for detailed +\fBcurses\fR(3) and related pages whose names begin "menu_" for detailed descriptions of the entry points. .SH NOTES The header file \fB<menu.h>\fR automatically includes the header files \fB<curses.h>\fR and \fB<eti.h>\fR. - -In your library list, libmenu.a should be before libcurses.a; that is, -you want to say `-lmenu -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, libmenu.a should be before libncurses.a; that is, +you want to say `-lmenu -lncurses', not the other way around (which would +usually give a link-error). .SH PORTABILITY These routines emulate the System V menu 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: |