X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu.3x;h=2c2b7efa5936059c72eaab32228e52dc278acf32;hp=79613ea52b4f34ee12e444bc649e1807b39d52bd;hb=8d8a3537cd58af7879c6e1921235daeed2b74926;hpb=8d3ea9021573747ecd129228ba7782a03243f62c diff --git a/man/menu.3x b/man/menu.3x index 79613ea5..2c2b7efa 100644 --- a/man/menu.3x +++ b/man/menu.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2014,2017 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 * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu.3x,v 1.24 2017/11/25 20:24:22 tom Exp $ +.\" $Id: menu.3x,v 1.26 2019/01/20 20:32:23 tom Exp $ .TH menu 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -44,20 +44,24 @@ .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 +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. . @@ -136,7 +140,8 @@ 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 .B E_OK @@ -170,7 +175,7 @@ The menu is already posted. The menu driver could not process the request. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fR(3)). .TP 5 .B E_UNKNOWN_COMMAND The menu driver code saw an unknown request code. @@ -182,7 +187,8 @@ 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). .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 @@ -196,8 +202,8 @@ 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. +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.