ncurses 6.0 - patch 20150822

[ncurses.git] / man / menu_new.3x

diff --git a/man/menu_new.3x b/man/menu_new.3x
index 9053fdd5579d8fc1d6d40dab23a1cb6454ec903f..11976547fc757bec1838bedb170d71f3ffdd347b 100644 (file)
--- a/man/menu_new.3x
+++ b/man/menu_new.3x
@@ -1,7 +1,36 @@
 '\" t
 '\" t

+.\"***************************************************************************
+.\" Copyright (c) 1998-2006,2010 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            *
+.\" "Software"), to deal in the Software without restriction, including      *
+.\" without limitation the rights to use, copy, modify, merge, publish,      *
+.\" distribute, distribute with modifications, sublicense, and/or sell       *
+.\" copies of the Software, and to permit persons to whom the Software is    *
+.\" furnished to do so, subject to the following conditions:                 *
+.\"                                                                          *
+.\" The above copyright notice and this permission notice shall be included  *
+.\" in all copies or substantial portions of the Software.                   *
+.\"                                                                          *
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+.\"                                                                          *
+.\" Except as contained in this notice, the name(s) of the above copyright   *
+.\" holders shall not be used in advertising or otherwise to promote the     *
+.\" sale, use or other dealings in this Software without prior written       *
+.\" authorization.                                                           *
+.\"***************************************************************************
+.\"
+.\" $Id: menu_new.3x,v 1.11 2010/12/04 18:40:45 tom Exp $

 .TH menu_new 3X ""
 .SH NAME
 .TH menu_new 3X ""
 .SH NAME

-\fBmenu_new\fR - create and destroy menus
+\fBmenu_new\fR \- create and destroy menus

 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br


@@ -12,24 +41,31 @@ int free_menu(MENU *menu);
 .SH DESCRIPTION
 The function \fBnew_menu\fR creates a new menu connected to a specified item
 pointer array (which must be \fBNULL\fR-terminated).
 .SH DESCRIPTION
 The function \fBnew_menu\fR creates a new menu connected to a specified item
 pointer array (which must be \fBNULL\fR-terminated).

-
+.PP

 The function \fBfree_menu\fR disconnects \fImenu\fR from its item array
 and frees the storage allocated for the menu.
 .SH RETURN VALUE
 The function \fBnew_menu\fR returns \fBNULL\fR on error.
 The function \fBfree_menu\fR disconnects \fImenu\fR from its item array
 and frees the storage allocated for the menu.
 .SH RETURN VALUE
 The function \fBnew_menu\fR returns \fBNULL\fR on error.

-
+It sets errno according to the function's failure:
+.TP 5
+.B E_NOT_CONNECTED
+No items are connected to the menu.
+.TP 5
+.B E_SYSTEM_ERROR
+System error occurred, e.g., malloc failure.
+.PP

 The function \fBfree_menu\fR returns one of the following:
 .TP 5
 The function \fBfree_menu\fR returns one of the following:
 .TP 5

-\fBE_OK\fR
+.B E_OK

 The routine succeeded.
 .TP 5
 The routine succeeded.
 .TP 5

-\fBE_SYSTEM_ERROR\fR
+.B E_SYSTEM_ERROR

 System error occurred (see \fBerrno\fR).
 .TP 5
 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
 Routine detected an incorrect or out-of-range argument.
 .TP 5

-\fBE_POSTED\fR
+.B E_POSTED

 The menu has already been posted.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).
 The menu has already been posted.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).


@@ -42,9 +78,3 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: