X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmenu_mark.3x;h=bcdf33405f7bcbba6f74255930c2bf821911a484;hb=159cd0555e0efc14be66c9c3a1548f58908b6a1d;hp=72ea000335e4ba22f3d6cbdb624583f4cd8f48e4;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;p=ncurses.git diff --git a/man/menu_mark.3x b/man/menu_mark.3x index 72ea0003..bcdf3340 100644 --- a/man/menu_mark.3x +++ b/man/menu_mark.3x @@ -1,6 +1,6 @@ -'\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2022,2023 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 * @@ -27,58 +27,56 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_mark.3x,v 1.6 1998/11/29 01:10:03 Rick.Ohnemus Exp $ -.TH menu_mark 3X "" +.\" $Id: menu_mark.3x,v 1.33 2023/11/25 13:58:47 tom Exp $ +.TH menu_mark 3X 2023-11-25 "ncurses 6.4" "Library calls" .SH NAME -\fBmenu_mark\fR - get and set the menu mark string +\fBset_menu_mark\fP, +\fBmenu_mark\fP \- +get and set the menu mark string .SH SYNOPSIS -\fB#include \fR -.br -int set_menu_mark(MENU *menu, const char *mark); -.br -const char *menu_mark(const MENU *menu); -.br +.nf +\fB#include +.PP +\fBint set_menu_mark(MENU *\fImenu\fP, const char *\fImark\fP); +\fBconst char *menu_mark(const MENU *\fImenu\fP); +.fi .SH DESCRIPTION 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. - -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. +.PP +The function \fBset_menu_mark\fP sets the mark string for the given menu. +Calling \fBset_menu_mark\fP 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. - -The function \fBmenu_mark\fR returns the menu's mark string (or \fBNULL\fR if +.PP +The default string is "\-" (a dash). +Calling \fBset_menu_mark\fP with +a non-\fBNULL\fP menu argument will change this default. +.PP +The function \fBmenu_mark\fP returns the menu's mark string (or \fBNULL\fP 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\fP returns a pointer (which may be \fBNULL\fP). +It does not set \fBerrno\fP. +.PP +The function \fBset_menu_mark\fP 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. -.SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). -.SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fP(3)). .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. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X)