ncurses 6.0 - patch 20170826

[ncurses.git] / man / menu_mark.3x

diff --git a/man/menu_mark.3x b/man/menu_mark.3x
index 72ea000335e4ba22f3d6cbdb624583f4cd8f48e4..e6dde9b2c891633ec6cfc85e406b6cd0c41d32d4 100644 (file)
--- a/man/menu_mark.3x
+++ b/man/menu_mark.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 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            *
 .\"                                                                          *
 .\" 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.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: menu_mark.3x,v 1.6 1998/11/29 01:10:03 Rick.Ohnemus Exp $
+.\" $Id: menu_mark.3x,v 1.12 2015/12/05 23:42:45 tom Exp $

 .TH menu_mark 3X ""
 .SH NAME
 .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 <menu.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br


@@ -42,29 +43,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.
 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 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 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
 .TP 5

-\fBE_OK\fR
+.B E_OK

 The routine succeeded.
 .TP 5
 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.
 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
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).
 .SH NOTES


@@ -76,9 +79,3 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
 .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: