X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_mark.3x;h=64e73d0b601a108b5e1289fab9b24e27ab76de13;hp=72ea000335e4ba22f3d6cbdb624583f4cd8f48e4;hb=6b4f5830b7910188b532d661f79775306715f67e;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/menu_mark.3x b/man/menu_mark.3x index 72ea0003..64e73d0b 100644 --- a/man/menu_mark.3x +++ b/man/menu_mark.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2018,2019 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,10 +27,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_mark.3x,v 1.6 1998/11/29 01:10:03 Rick.Ohnemus Exp $ +.\" $Id: menu_mark.3x,v 1.14 2019/01/20 20:32:23 tom Exp $ .TH menu_mark 3X "" .SH NAME -\fBmenu_mark\fR - get and set the menu mark string +\fBset_menu_mark\fP, +\fBmenu_mark\fR \- get and set the menu mark string .SH SYNOPSIS \fB#include \fR .br @@ -42,43 +43,41 @@ 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. - -The default string is "-" (a dash). Calling \fBset_menu_mark\fR with -a \fBNULL\fR menu argument will change this default. - +.PP +The default string is "\-" (a dash). +Calling \fBset_menu_mark\fR with +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(3)). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .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 -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.