X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_mark.3x.html;h=d7dfefba26311b1c37b56e1c48bd0f14838c11f2;hp=f2eeac90511b9f304439219acbcbbe94d166879d;hb=761e4f0825b330e970558e82a4bd638383914429;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/menu_mark.3x.html b/doc/html/man/menu_mark.3x.html index f2eeac90..d7dfefba 100644 --- a/doc/html/man/menu_mark.3x.html +++ b/doc/html/man/menu_mark.3x.html @@ -1,16 +1,59 @@ + + + +menu_mark 3x + + + +

menu_mark 3x

+
 
+menu_mark(3x)                                             menu_mark(3x)
+
+
+

NAME

-       menu_mark - get and set the menu mark string
+       menu_mark - get and set the menu mark string

SYNOPSIS

-       #include <menu.h>
+       #include <menu.h>
        int set_menu_mark(MENU *menu, const char *mark);
        const char *menu_mark(const MENU *menu);
 
@@ -22,56 +65,62 @@
        library  marks  selected  items  in  a  menu with a prefix
        string.
 
-       The function set_menu_mark sets the mark  string  for  the
-       given  menu.   Calling set_menu_mark with a null menu item
+       The function set_menu_mark sets the mark  string  for  the
+       given  menu.   Calling set_menu_mark 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  set_menu_mark
-       with a NULL menu argument will change this default.
+       The default string is "-" (a dash). Calling  set_menu_mark
+       with a non-NULL menu argument will change this default.
 
-       The  function menu_mark returns the menu's mark string (or
-       NULL if there is none).
+       The  function menu_mark returns the menu's mark string (or
+       NULL if there is none).

RETURN VALUE

-       The function menu_mark returns NULL on error.   The  func-
-       tion set_menu_mark may return the following error codes:
+       The function menu_mark returns a  pointer  (which  may  be
+       NULL).  It does not set errno.
 
-       E_OK The routine succeeded.
+       The  function set_menu_mark may return the following error
+       codes:
 
-       E_SYSTEM_ERROR
-            System error occurred (see errno).
+       E_OK The routine succeeded.
 
-       E_BAD_ARGUMENT
-            Routine  detected  an incorrect or out-of-range argu-
+       E_BAD_ARGUMENT
+            Routine detected an incorrect or  out-of-range  argu-
             ment.
 
+       E_SYSTEM_ERROR
+            System error occurred (see errno).
+

SEE ALSO

-       curses(3x), menu(3x).
+       curses(3x), menu(3x).

NOTES

-       The header file <menu.h> automatically includes the header
-       file <curses.h>.
+       The header file <menu.h> automatically includes the header
+       file <curses.h>.

PORTABILITY

-       These  routines  emulate  the System V menu library.  They
+       These routines emulate the System V  menu  library.   They
        were not supported on Version 7 or BSD versions.

AUTHORS

-       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
+       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
        curses by Eric S. Raymond.
 
+
+
+                                                          menu_mark(3x)