diff options
author | Rong-En Fan <rafan@FreeBSD.org> | 2007-01-20 07:32:02 +0000 |
---|---|---|
committer | Rong-En Fan <rafan@FreeBSD.org> | 2007-01-20 07:32:02 +0000 |
commit | 4a1a95108dd76c4259fe6c37c4471f7969b17983 (patch) | |
tree | 1c6c3b549401156e1dbd96b9a6b18521f63ffb58 /contrib/ncurses/man/menu_mark.3x | |
parent | 555c9cae3cf9146482732c28c06a73314b618149 (diff) | |
download | src-4a1a95108dd76c4259fe6c37c4471f7969b17983.tar.gz src-4a1a95108dd76c4259fe6c37c4471f7969b17983.zip |
Import ncurses 5.6-20061217 onto the vender branch
Approved by: delphij
Notes
Notes:
svn path=/vendor/ncurses/dist/; revision=166124
Diffstat (limited to 'contrib/ncurses/man/menu_mark.3x')
-rw-r--r-- | contrib/ncurses/man/menu_mark.3x | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/contrib/ncurses/man/menu_mark.3x b/contrib/ncurses/man/menu_mark.3x index 72ea000335e4..1db2b3ee1974 100644 --- a/contrib/ncurses/man/menu_mark.3x +++ b/contrib/ncurses/man/menu_mark.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998,2006 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_mark.3x,v 1.6 1998/11/29 01:10:03 Rick.Ohnemus Exp $ +.\" $Id: menu_mark.3x,v 1.9 2006/11/04 18:33:18 tom Exp $ .TH menu_mark 3X "" .SH NAME \fBmenu_mark\fR - get and set the menu mark string @@ -42,29 +42,31 @@ const char *menu_mark(const MENU *menu); In order to make menu selections visible on older terminals without highlighting or color capability, the menu library marks selected items in a menu with a prefix string. - +.PP The function \fBset_menu_mark\fR sets the mark string for the given menu. Calling \fBset_menu_mark\fR with a null menu item will abolish the mark string. Note that changing the length of the mark string for a menu while the menu is posted is likely to produce unhelpful behavior. - +.PP The default string is "-" (a dash). Calling \fBset_menu_mark\fR with -a \fBNULL\fR menu argument will change this default. - +a non-\fBNULL\fR menu argument will change this default. +.PP The function \fBmenu_mark\fR returns the menu's mark string (or \fBNULL\fR if there is none). .SH RETURN VALUE -The function \fBmenu_mark\fR returns \fBNULL\fR on error. The function -\fBset_menu_mark\fR may return the following error codes: +The function \fBmenu_mark\fR returns a pointer (which may be \fBNULL\fR). +It does not set errno. +.PP +The function \fBset_menu_mark\fR may return the following error codes: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -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 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES |