diff options
Diffstat (limited to 'lib/libmenu/menu_opts.3')
| -rw-r--r-- | lib/libmenu/menu_opts.3 | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/lib/libmenu/menu_opts.3 b/lib/libmenu/menu_opts.3 index c9eecc8f1be..dfa3e2a7959 100644 --- a/lib/libmenu/menu_opts.3 +++ b/lib/libmenu/menu_opts.3 @@ -1,8 +1,8 @@ '\" t -.\" $OpenBSD: menu_opts.3,v 1.7 1999/05/12 13:26:49 aaron Exp $ +.\" $OpenBSD: menu_opts.3,v 1.8 2010/01/12 23:22:08 nicm Exp $ .\" .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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,33 +29,33 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $From: menu_opts.3x,v 1.7 1998/11/29 01:10:21 Rick.Ohnemus Exp $ +.\" $Id: menu_opts.3,v 1.8 2010/01/12 23:22:08 nicm Exp $ .TH menu_opts 3 "" .SH NAME \fBmenu_opts\fR - set and get menu options .SH SYNOPSIS \fB#include <menu.h>\fR .br -int set_menu_opts(MENU *menu, OPTIONS opts); +int set_menu_opts(MENU *menu, Menu_Options opts); .br -int menu_opts_on(MENU *menu, OPTIONS opts); +int menu_opts_on(MENU *menu, Menu_Options opts); .br -int menu_opts_off(MENU *menu, OPTIONS opts); +int menu_opts_off(MENU *menu, Menu_Options opts); .br -OPTIONS menu_opts(const MENU *menu); +Menu_Options menu_opts(const MENU *menu); .br .SH DESCRIPTION The function \fBset_menu_opts\fR sets all the given menu's option bits (menu option bits may be logically OR'ed together). - +.PP The function \fBmenu_opts_on\fR turns on the given option bits, and leaves others alone. - +.PP The function \fBmenu_opts_off\fR turns off the given option bits, and leaves others alone. - +.PP The function \fBmenu_opts\fR returns the menu's current option bits. - +.PP The following options are defined (all are on by default): .TP 5 O_ONEVALUE @@ -79,13 +79,13 @@ requests to the other end of the menu. .SH RETURN VALUE Except for \fBmenu_opts\fR, each routine returns one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR +.B E_SYSTEM_ERROR System error occurred (see \fBerrno\fR). .TP 5 -\fBE_POSTED\fR +.B E_POSTED The menu is already posted. .SH SEE ALSO \fBcurses\fR(3), \fBmenu\fR(3). |