lib/libncurses/man/mitem_name.3

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: mitem_name.3x,v 1.5 1998/11/29 01:11:29 Rick.Ohnemus Exp $
  31 .\" $DragonFly: src/lib/libncurses/man/mitem_name.3,v 1.1 2005/03/12 19:13:54 eirikn Exp $
  32 .TH mitem_name 3X ""
  33 .SH NAME
  34 \fBmitem_name\fR - get menu item name and description fields
  35 .SH SYNOPSIS
  36 \fB#include <menu.h>\fR
  37 .br
  38 const char *item_name(const ITEM *item);
  39 .br
  40 const char *item_description(const ITEM *item);
  41 .br
  42 .SH DESCRIPTION
  43 The function \fBitem_name\fR returns the name part of the given item.
  44 .br
  45 The function \fBitem_description\fR returns the description part of the given
  46 item.
  47 .SH RETURN VALUE
  48 These routines returns \fBNULL\fR on error.
  49 .SH SEE ALSO
  50 \fBcurses\fR(3X), \fBmenu\fR(3X).
  51 .SH NOTES
  52 The header file \fB<menu.h>\fR automatically includes the header file
  53 \fB<curses.h>\fR.
  54 .SH PORTABILITY
  55 These routines emulate the System V menu library.  They were not supported on
  56 Version 7 or BSD versions.
  57 .SH AUTHORS
  58 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  59 S. Raymond.
  60 .\"#
  61 .\"# The following sets edit modes for GNU EMACS
  62 .\"# Local Variables:
  63 .\"# mode:nroff
  64 .\"# fill-column:79
  65 .\"# End: