ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / menu_spacing.3x.html
index d067211cb7eb426dea5be45fec6162d282f52816..0ac3c25a5e22ca9860ac6ecad7d8313796cc69ac 100644 (file)
@@ -1,7 +1,7 @@
 <!-- 
   * t
   ****************************************************************************
-  * Copyright (c) 1998-2004,2010 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            *
@@ -27,7 +27,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: menu_spacing.3x,v 1.12 2010/12/04 18:38:55 tom Exp @
+  * @Id: menu_spacing.3x,v 1.13 2015/12/05 23:42:45 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
@@ -48,7 +48,8 @@
 
 </PRE>
 <H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <STRONG>menu_spacing</STRONG> - Control spacing between menu items.
+       <STRONG>set_menu_spacing</STRONG>,  <STRONG>menu_spacing</STRONG>  -  set  and  get  spacing
+       between menu items.
 
 
 </PRE>
 </PRE>
 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
        The function <STRONG>set_menu_spacing</STRONG> sets the spacing information
-       for the menu.  Its parameter <STRONG>spc_description</STRONG> controls  the
+       for  the menu.  Its parameter <STRONG>spc_description</STRONG> controls the
        number of spaces between an item name and an item descrip-
-       tion.  It must not be larger than <STRONG>TABSIZE</STRONG>.  The menu  sys-
-       tem  puts in the middle of this spacing area the pad char-
-       acter.  The remaining parts are filled with  spaces.   The
-       <STRONG>spc_rows</STRONG>  parameter  controls  the number of rows that are
+       tion.   It must not be larger than <STRONG>TABSIZE</STRONG>.  The menu sys-
+       tem puts in the middle of this spacing area the pad  char-
+       acter.   The  remaining parts are filled with spaces.  The
+       <STRONG>spc_rows</STRONG> parameter controls the number of  rows  that  are
        used for an item.  It must not be larger than 3.  The menu
-       system  inserts  the  blank lines between item rows, these
-       lines will contain the pad character  in  the  appropriate
-       positions.   The <STRONG>spc_columns</STRONG> parameter controls the number
+       system inserts the blank lines between  item  rows,  these
+       lines  will  contain  the pad character in the appropriate
+       positions.  The <STRONG>spc_columns</STRONG> parameter controls the  number
        of blanks between columns of items.  It must not be larger
-       than  TABSIZE.   A  value  of 0 for all the spacing values
+       than TABSIZE.  A value of 0 for  all  the  spacing  values
        resets them to the default, which is 1 for all of them.
        The function <STRONG>menu_spacing</STRONG> passes back the spacing info for
-       the  menu.   If  a  pointer is NULL, this specific info is
+       the menu.  If a pointer is NULL,  this  specific  info  is
        simply not returned.
 
 
 </PRE>
 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       Both routines return <STRONG>E_OK</STRONG>  on  success.   <STRONG>set_menu_spacing</STRONG>
-       may  return <STRONG>E_POSTED</STRONG> if the menu is posted, or <STRONG>E_BAD_ARGU-</STRONG>
+       Both  routines  return  <STRONG>E_OK</STRONG> on success.  <STRONG>set_menu_spacing</STRONG>
+       may return <STRONG>E_POSTED</STRONG> if the menu is posted, or  <STRONG>E_BAD_ARGU-</STRONG>
        <STRONG>MENT</STRONG> if one of the spacing values is out of range.
 
 
 
 </PRE>
 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
-       These  routines  are  specific  to ncurses.  They were not
-       supported on Version 7, BSD or System  V  implementations.
-       It  is recommended that any code depending on them be con-
+       These routines are specific to  ncurses.   They  were  not
+       supported  on  Version 7, BSD or System V implementations.
+       It is recommended that any code depending on them be  con-
        ditioned using NCURSES_VERSION.
 
 
 </PRE>
 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
-       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
+       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
        curses by Eric S. Raymond.