diff options
Diffstat (limited to 'doc/html/man/menu.3x.html')
| -rw-r--r-- | doc/html/man/menu.3x.html | 161 |
1 files changed, 84 insertions, 77 deletions
diff --git a/doc/html/man/menu.3x.html b/doc/html/man/menu.3x.html index c974468d9a4c..7770423bfd0d 100644 --- a/doc/html/man/menu.3x.html +++ b/doc/html/man/menu.3x.html @@ -1,8 +1,7 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2018,2019 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 * @@ -28,59 +27,56 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: menu.3x,v 1.21 2010/12/04 18:40:45 tom Exp @ + * @Id: menu.3x,v 1.26 2019/01/20 20:32:23 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>menu 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>menu 3x</H1> -<HR> +<H1 class="no-header">menu 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> +<STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> -</PRE> -<H2>NAME</H2><PRE> +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> <STRONG>menu</STRONG> - curses extension for programming menus -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> -</PRE> -<H2>DESCRIPTION</H2><PRE> - The <STRONG>menu</STRONG> library provides terminal-independent facilities - for composing menu systems on character-cell terminals. - The library includes: item routines, which create and mod- - ify menu items; and menu routines, which group items into - menus, display menus on the screen, and handle interaction - with the user. - - The <STRONG>menu</STRONG> library uses the <STRONG>curses</STRONG> libraries, and a curses - initialization routine such as <STRONG>initscr</STRONG> must be called - before using any of these functions. To use the <STRONG>menu</STRONG> - library, link with the options <STRONG>-lmenu</STRONG> <STRONG>-lcurses</STRONG>. - - <STRONG>Current</STRONG> <STRONG>Default</STRONG> <STRONG>Values</STRONG> <STRONG>for</STRONG> <STRONG>Item</STRONG> <STRONG>Attributes</STRONG> - The <STRONG>menu</STRONG> library maintains a default value for item - attributes. You can get or set this default by calling - the appropriate <STRONG>get_</STRONG> or <STRONG>set_</STRONG> routine with a <STRONG>NULL</STRONG> item - pointer. Changing this default with a <STRONG>set_</STRONG> function - affects future item creations, but does not change the - rendering of items already created. - - <STRONG>Routine</STRONG> <STRONG>Name</STRONG> <STRONG>Index</STRONG> - The following table lists each <STRONG>menu</STRONG> routine and the name - of the manual page on which it is described. +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + The <STRONG>menu</STRONG> 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 inter- + action with the user. + + The <STRONG>menu</STRONG> library uses the <STRONG>curses</STRONG> libraries, and a curses initialization + routine such as <STRONG>initscr</STRONG> must be called before using any of these func- + tions. To use the <STRONG>menu</STRONG> library, link with the options <STRONG>-lmenu</STRONG> <STRONG>-lcurses</STRONG>. + + +</PRE><H3><a name="h3-Current-Default-Values-for-Item-Attributes">Current Default Values for Item Attributes</a></H3><PRE> + The <STRONG>menu</STRONG> library maintains a default value for item attributes. You + can get or set this default by calling the appropriate <STRONG>get_</STRONG> or <STRONG>set_</STRONG> + routine with a <STRONG>NULL</STRONG> item pointer. Changing this default with a <STRONG>set_</STRONG> + function affects future item creations, but does not change the render- + ing of items already created. + + +</PRE><H3><a name="h3-Routine-Name-Index">Routine Name Index</a></H3><PRE> + The following table lists each <STRONG>menu</STRONG> routine and the name of the manual + page on which it is described. <STRONG>curses</STRONG> Routine Name Manual Page Name -------------------------------------------- @@ -112,10 +108,10 @@ menu_opts_on <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG> menu_pad <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> menu_pattern <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> - menu_request_by_name <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG> menu_request_name <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG> menu_spacing <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG> + menu_sub <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG> menu_term <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> menu_userptr <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG> @@ -151,21 +147,17 @@ unpost_menu <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG> -</PRE> -<H2>RETURN VALUE</H2><PRE> - Routines that return pointers return <STRONG>NULL</STRONG> on error. Rou- - tines that return an integer return one of the following - error codes: +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + Routines that return pointers return <STRONG>NULL</STRONG> on error. Routines that + return an integer return one of the following error codes: <STRONG>E_OK</STRONG> The routine succeeded. <STRONG>E_BAD_ARGUMENT</STRONG> - Routine detected an incorrect or out-of-range argu- - ment. + Routine detected an incorrect or out-of-range argument. <STRONG>E_BAD_STATE</STRONG> - Routine was called from an initialization or termina- - tion function. + Routine was called from an initialization or termination function. <STRONG>E_NO_MATCH</STRONG> Character failed to match. @@ -189,53 +181,68 @@ The menu driver could not process the request. <STRONG>E_SYSTEM_ERROR</STRONG> - System error occurred (see <STRONG>errno</STRONG>). + System error occurred (see <STRONG>errno(3)</STRONG>). <STRONG>E_UNKNOWN_COMMAND</STRONG> The menu driver code saw an unknown request code. -</PRE> -<H2>SEE ALSO</H2><PRE> - <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for - detailed descriptions of the entry points. +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header files + <STRONG><curses.h></STRONG> and <STRONG><eti.h></STRONG>. + In your library list, libmenu.a should be before libncurses.a; that is, + you should say "-lmenu -lncurses", not the other way around (which + would give a link-error when using static libraries). -</PRE> -<H2>NOTES</H2><PRE> - The header file <STRONG><menu.h></STRONG> automatically includes the header - files <STRONG><curses.h></STRONG> and <STRONG><eti.h></STRONG>. - In your library list, libmenu.a should be before libn- - curses.a; that is, you want to say `-lmenu -lncurses', not - the other way around (which would usually give a link- - error). +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + These routines emulate the System V menu library. They were not sup- + ported on Version 7 or BSD versions. + The menu facility was documented in SVr4.2 in <EM>Character</EM> <EM>User</EM> <EM>Interface</EM> + <EM>Programming</EM> <EM>(UNIX</EM> <EM>SVR4.2)</EM>. -</PRE> -<H2>PORTABILITY</H2><PRE> - These routines emulate the System V menu library. They - were not supported on Version 7 or BSD versions. + It is not part of X/Open Curses. + Aside from ncurses, there are few implementations: -</PRE> -<H2>AUTHORS</H2><PRE> - Juergen Pfeifer. Manual pages and adaptation for ncurses - by Eric S. Raymond. + <STRONG>o</STRONG> systems based on SVr4 source code, e.g., Solaris. + <STRONG>o</STRONG> NetBSD curses. -</PRE> -<H2>SEE ALSO</H2><PRE> - This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20131221). + +</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for ncurses by Eric S. + Raymond. + + +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for detailed + descriptions of the entry points. + + This describes <STRONG>ncurses</STRONG> version 6.1 (patch 20200118). - <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> + <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> </PRE> -<HR> -<ADDRESS> -Man(1) output converted with -<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> -</ADDRESS> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a> +<ul> +<li><a href="#h3-Current-Default-Values-for-Item-Attributes">Current Default Values for Item Attributes</a></li> +<li><a href="#h3-Routine-Name-Index">Routine Name Index</a></li> +</ul> +</li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-AUTHORS">AUTHORS</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +</ul> +</div> </BODY> </HTML> |