X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu.3x;h=68117bc0505454afeab8b329f1cab9c9544f2fca;hp=8279844a39e25e8dffca48338861700aba9edd7c;hb=fae162795e065e5901068152e91f2962b6b247f3;hpb=c633e5103a29a38532cf1925257b91cea33fd090 diff --git a/man/menu.3x b/man/menu.3x index 8279844a..68117bc0 100644 --- a/man/menu.3x +++ b/man/menu.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2000 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2014,2017 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,37 +28,49 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu.3x,v 1.14 2000/07/15 22:55:59 tom Exp $ +.\" $Id: menu.3x,v 1.27 2020/02/02 23:34:34 tom Exp $ .TH menu 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .SH NAME -\fBmenu\fR - curses extension for programming menus +\fBmenu\fR \- curses extension for programming menus .SH SYNOPSIS \fB#include \fR .br .SH DESCRIPTION The \fBmenu\fR library provides terminal-independent facilities for composing -menu systems on character-cell terminals. The library includes: item routines, +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. - +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 +. +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 +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 @@ -128,63 +141,73 @@ top_row \fBmitem_current\fR(3X) unpost_menu \fBmenu_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. +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. -.SH SEE ALSO -\fBcurses\fR(3X) and 3X pages whose names begin "menu_" for detailed -descriptions of the entry points. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). +.TP 5 +.B E_UNKNOWN_COMMAND +The menu driver code saw an unknown request code. .SH NOTES The header file \fB\fR automatically includes the header files \fB\fR and \fB\fR. - +.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 -give you a link error using GNU \fBld\fR(1) and many other linkers). +you should say \*(``\-lmenu \-lncurses\*('', not the other way around +(which would give a link-error when using static libraries). .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +These routines emulate the System V menu library. +They were not supported on Version 7 or BSD versions. +.PP +The menu facility was documented in SVr4.2 in +\fICharacter User Interface Programming (UNIX SVR4.2)\fP. +.PP +It is not part of X/Open Curses. +.PP +Aside from ncurses, there are few implementations: +.bP +systems based on SVr4 source code, e.g., Solaris. +.bP +NetBSD curses. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for ncurses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for ncurses by Eric S. Raymond. +.SH SEE ALSO +\fBcurses\fR(3X) and related pages whose names begin \*(``menu_\*('' +for detailed descriptions of the entry points. +.PP +This describes \fBncurses\fR +version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).