ncurses 6.3 - patch 20220416

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

diff --git a/man/mitem_new.3x b/man/mitem_new.3x
index c08d05ed6119e352cabfe38525ec23eaaae2b363..7a0178ac66c008f8c7dfd26de6d2ee12a6f9b951 100644 (file)
--- a/man/mitem_new.3x
+++ b/man/mitem_new.3x
@@ -1,54 +1,91 @@
 '\" t
 '\" t

+.\"***************************************************************************
+.\" Copyright 2018-2021,2022 Thomas E. Dickey                                *
+.\" Copyright 1998-2010,2015 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: mitem_new.3x,v 1.22 2022/02/12 20:02:20 tom Exp $

 .TH mitem_new 3X ""
 .SH NAME
 .TH mitem_new 3X ""
 .SH NAME

-\fBmitem_new\fR - create and destroy menu items
+\fBnew_item\fP,
+\fBfree_item\fP \- create and destroy menu items

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <menu.h>\fR
+\fB#include <menu.h>\fP
+.sp
+\fBITEM *new_item(const char *\fIname\fB, const char *\fIdescription\fB);\fR

 .br
 .br

-ITEM *new_item(const char *name, const char *description);
-.br
-int free_item(ITEM *item);
+\fBint free_item(ITEM *\fIitem\fB);\fR

 .br
 .SH DESCRIPTION
 .br
 .SH DESCRIPTION

-The function \fBnew_item\fR allocates a new item and initializes it from the
-\fBname\fR and \fBdescription\fR pointers. Please notice that the item stores
-only the pointers to the name and description. Those pointers must be valid
-during the lifetime of the item. So you should be very carefull with names
+The function \fBnew_item\fP allocates a new item and initializes it from the
+\fBname\fP and \fBdescription\fP pointers.
+Please notice that the item stores
+only the pointers to the name and description.
+Those pointers must be valid
+during the lifetime of the item.
+So you should be very careful with names

 or descriptions allocated on the stack of some routines.
 .br
 or descriptions allocated on the stack of some routines.
 .br

-The function \fBfree_item\fR de-allocates an item. Please notice that it
+The function \fBfree_item\fP de-allocates an item.
+Please notice that it

 is the responsibility of the application to release the memory for the
 name or the description of the item.
 .SH RETURN VALUE
 is the responsibility of the application to release the memory for the
 name or the description of the item.
 .SH RETURN VALUE

-The function \fBnew_item\fR returns \fBNULL\fR on error.
-
-The function \fBfree_item\fR returns one of the following:
+The function \fBnew_item\fP returns \fBNULL\fP on error.
+It sets \fBerrno\fP according to the function's failure:

 .TP 5
 .TP 5

-\fBE_OK\fR
-The routine succeeded.
+.B E_BAD_ARGUMENT
+Routine detected an incorrect or out-of-range argument.

 .TP 5
 .TP 5

-\fBE_SYSTEM_ERROR\fR
-System error occurred (see \fBerrno\fR).
+.B E_SYSTEM_ERROR
+System error occurred, e.g., malloc failure.
+.PP
+The function \fBfree_item\fP returns one of the following:

 .TP 5
 .TP 5

-\fBE_BAD_ARGUMENT\fR
+.B E_OK
+The routine succeeded.
+.TP 5
+.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_CONNECTED\fR
+.B E_CONNECTED

 Item is connected to a menu.
 Item is connected to a menu.

+.TP 5
+.B E_SYSTEM_ERROR
+System error occurred (see \fBerrno\fP(3)).

 .SH SEE ALSO
 .SH SEE ALSO

-\fBcurses\fR(3X), \fBmenu\fR(3X).
+\fBcurses\fP(3X), \fBmenu\fP(3X).

 .SH NOTES
 .SH NOTES

-The header file \fB<menu.h>\fR automatically includes the header file
-\fB<curses.h>\fR.
+The header file \fB<menu.h>\fP automatically includes the header file
+\fB<curses.h>\fP.

 .SH PORTABILITY
 .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.
 .SH AUTHORS
 Version 7 or BSD versions.
 .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:
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.