X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_mark.3x;h=960113578f48846d952df29b89a1989cb1bd674a;hp=1425154b8dc481369af2e0d2b57285d96a414212;hb=5925150381bb42a4d8c7116d62c348a7b84309f3;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96 diff --git a/man/menu_mark.3x b/man/menu_mark.3x index 1425154b..96011357 100644 --- a/man/menu_mark.3x +++ b/man/menu_mark.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 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,16 +28,17 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_mark.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ +.\" $Id: menu_mark.3x,v 1.18 2020/10/24 08:59:04 tom Exp $ .TH menu_mark 3X "" .SH NAME +\fBset_menu_mark\fP, \fBmenu_mark\fR \- get and set the menu mark string .SH SYNOPSIS \fB#include \fR +.sp +\fBint set_menu_mark(MENU *\fP\fImenu\fP\fB, const char *\fP\fImark\fP\fB);\fP .br -int set_menu_mark(MENU *menu, const char *mark); -.br -const char *menu_mark(const MENU *menu); +\fBconst char *menu_mark(const MENU *\fP\fImenu\fP\fB);\fP .br .SH DESCRIPTION In order to make menu selections visible on older terminals without @@ -48,14 +50,15 @@ 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 +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 a pointer (which may be \fBNULL\fR). -It does not set errno. +It does not set \fBerrno\fP. .PP The function \fBset_menu_mark\fR may return the following error codes: .TP 5 @@ -66,15 +69,16 @@ The routine succeeded. Routine detected an incorrect or out-of-range argument. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +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. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.