ncurses 6.1 - patch 20190121
[ncurses.git] / man / menu.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: menu.3x,v 1.26 2019/01/20 20:32:23 tom Exp $
31 .TH menu 3X ""
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .de bP
37 .ie n  .IP \(bu 4
38 .el    .IP \(bu 2
39 ..
40 .SH NAME
41 \fBmenu\fR \- curses extension for programming menus
42 .SH SYNOPSIS
43 \fB#include <menu.h>\fR
44 .br
45 .SH DESCRIPTION
46 The \fBmenu\fR library provides terminal-independent facilities for composing
47 menu systems on character-cell terminals.
48 The library includes: item routines,
49 which create and modify menu items; and menu routines, which group items into
50 menus, display menus on the screen, and handle interaction with the user.
51 .PP
52 The \fBmenu\fR library uses the \fBcurses\fR libraries, and a curses
53 initialization routine such as \fBinitscr\fR must be called before using any of
54 these functions.
55 To use the \fBmenu\fR library, link with the options
56 \fB\-lmenu \-lcurses\fR.
57 .
58 .SS Current Default Values for Item Attributes
59 .
60 The \fBmenu\fR library maintains a default value for item attributes.
61 You can
62 get or set this default by calling the appropriate \fBget_\fR or \fBset_\fR
63 routine with a \fBNULL\fR item pointer.
64 Changing this default with a
65 \fBset_\fR function affects future item creations, but does not change the
66 rendering of items already created.
67 .
68 .SS Routine Name Index
69 .
70 The following table lists each \fBmenu\fR routine and the name of
71 the manual page on which it is described.
72 .
73 .TS
74 l l .
75 \fBcurses\fR Routine Name       Manual Page Name
76 =
77 current_item    \fBmitem_current\fR(3X)
78 free_item       \fBmitem_new\fR(3X)
79 free_menu       \fBmenu_new\fR(3X)
80 item_count      \fBmenu_items\fR(3X)
81 item_description        \fBmitem_name\fR(3X)
82 item_index      \fBmitem_current\fR(3X)
83 item_init       \fBmenu_hook\fR(3X)
84 item_name       \fBmitem_name\fR(3X)
85 item_opts       \fBmitem_opts\fR(3X)
86 item_opts_off   \fBmitem_opts\fR(3X)
87 item_opts_on    \fBmitem_opts\fR(3X)
88 item_term       \fBmenu_hook\fR(3X)
89 item_userptr    \fBmitem_userptr\fR(3X)
90 item_value      \fBmitem_value\fR(3X)
91 item_visible    \fBmitem_visible\fR(3X)
92 menu_back       \fBmenu_attributes\fR(3X)
93 menu_driver     \fBmenu_driver\fR(3X)
94 menu_fore       \fBmenu_attributes\fR(3X)
95 menu_format     \fBmenu_format\fR(3X)
96 menu_grey       \fBmenu_attributes\fR(3X)
97 menu_init       \fBmenu_hook\fR(3X)
98 menu_items      \fBmenu_items\fR(3X)
99 menu_mark       \fBmenu_mark\fR(3X)
100 menu_opts       \fBmenu_opts\fR(3X)
101 menu_opts_off   \fBmenu_opts\fR(3X)
102 menu_opts_on    \fBmenu_opts\fR(3X)
103 menu_pad        \fBmenu_attributes\fR(3X)
104 menu_pattern    \fBmenu_pattern\fR(3X)
105 menu_request_by_name    \fBmenu_requestname\fR(3X)
106 menu_request_name       \fBmenu_requestname\fR(3X)
107 menu_spacing    \fBmenu_spacing\fR(3X)
108 menu_sub        \fBmenu_win\fR(3X)
109 menu_term       \fBmenu_hook\fR(3X)
110 menu_userptr    \fBmenu_userptr\fR(3X)
111 menu_win        \fBmenu_win\fR(3X)
112 new_item        \fBmitem_new\fR(3X)
113 new_menu        \fBmenu_new\fR(3X)
114 pos_menu_cursor \fBmenu_cursor\fR(3X)
115 post_menu       \fBmenu_post\fR(3X)
116 scale_menu      \fBmenu_win\fR(3X)
117 set_current_item        \fBmitem_current\fR(3X)
118 set_item_init   \fBmenu_hook\fR(3X)
119 set_item_opts   \fBmitem_opts\fR(3X)
120 set_item_term   \fBmenu_hook\fR(3X)
121 set_item_userptr        \fBmitem_userptr\fR(3X)
122 set_item_value  \fBmitem_value\fR(3X)
123 set_menu_back   \fBmenu_attributes\fR(3X)
124 set_menu_fore   \fBmenu_attributes\fR(3X)
125 set_menu_format \fBmenu_format\fR(3X)
126 set_menu_grey   \fBmenu_attributes\fR(3X)
127 set_menu_init   \fBmenu_hook\fR(3X)
128 set_menu_items  \fBmenu_items\fR(3X)
129 set_menu_mark   \fBmenu_mark\fR(3X)
130 set_menu_opts   \fBmitem_opts\fR(3X)
131 set_menu_pad    \fBmenu_attributes\fR(3X)
132 set_menu_pattern        \fBmenu_pattern\fR(3X)
133 set_menu_spacing        \fBmenu_spacing\fR(3X)
134 set_menu_sub    \fBmenu_win\fR(3X)
135 set_menu_term   \fBmenu_hook\fR(3X)
136 set_menu_userptr        \fBmenu_userptr\fR(3X)
137 set_menu_win    \fBmenu_win\fR(3X)
138 set_top_row     \fBmitem_current\fR(3X)
139 top_row         \fBmitem_current\fR(3X)
140 unpost_menu     \fBmenu_post\fR(3X)
141 .TE
142 .SH RETURN VALUE
143 Routines that return pointers return \fBNULL\fR on error.
144 Routines that return
145 an integer return one of the following error codes:
146 .TP 5
147 .B E_OK
148 The routine succeeded.
149 .TP 5
150 .B E_BAD_ARGUMENT
151 Routine detected an incorrect or out-of-range argument.
152 .TP 5
153 .B E_BAD_STATE
154 Routine was called from an initialization or termination function.
155 .TP 5
156 .B E_NO_MATCH
157 Character failed to match.
158 .TP 5
159 .B E_NO_ROOM
160 Menu is too large for its window.
161 .TP 5
162 .B E_NOT_CONNECTED
163 No items are connected to the menu.
164 .TP 5
165 .B E_NOT_POSTED
166 The menu has not been posted.
167 .TP 5
168 .B E_NOT_SELECTABLE
169 The designated item cannot be selected.
170 .TP 5
171 .B E_POSTED
172 The menu is already posted.
173 .TP 5
174 .B E_REQUEST_DENIED
175 The menu driver could not process the request.
176 .TP 5
177 .B E_SYSTEM_ERROR
178 System error occurred (see \fBerrno\fR(3)).
179 .TP 5
180 .B E_UNKNOWN_COMMAND
181 The menu driver code saw an unknown request code.
182 .SH NOTES
183 The header file \fB<menu.h>\fR automatically includes the header files
184 \fB<curses.h>\fR and \fB<eti.h>\fR.
185 .PP
186 In your library list, libmenu.a should be before libncurses.a; that is,
187 you should say \*(``\-lmenu \-lncurses\*('', not the other way around
188 (which would give a link-error when using static libraries).
189 .SH PORTABILITY
190 These routines emulate the System V menu library.
191 They were not supported on
192 Version 7 or BSD versions.
193 .PP
194 The menu facility was documented in SVr4.2 in
195 \fICharacter User Interface Programming (UNIX SVR4.2)\fP.
196 .PP
197 It is not part of X/Open Curses.
198 .PP
199 Aside from ncurses, there are few implementations:
200 .bP
201 systems based on SVr4 source code, e.g., Solaris.
202 .bP
203 NetBSD curses.
204 .SH AUTHORS
205 Juergen Pfeifer.
206 Manual pages and adaptation for ncurses by Eric S. Raymond.
207 .SH SEE ALSO
208 \fBcurses\fR(3X) and related pages whose names begin \*(``menu_\*(''
209 for detailed descriptions of the entry points.
210 .PP
211 This describes \fBncurses\fR
212 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).