ncurses 6.4 - patch 20231001

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

diff --git a/man/menu_spacing.3x b/man/menu_spacing.3x
index 9edc191eebb23af7ccfb3efc5f138117337c6869..1e6728ce8f24e6f57d30b50d3db6e3e3645ae39e 100644 (file)
--- a/man/menu_spacing.3x
+++ b/man/menu_spacing.3x
@@ -28,8 +28,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: menu_spacing.3x,v 1.26 2023/09/16 23:38:39 tom Exp $
-.TH menu_spacing 3X 2023-09-16 "ncurses 6.4" "Library calls"
+.\" $Id: menu_spacing.3x,v 1.31 2023/09/30 23:44:51 tom Exp $
+.TH menu_spacing 3X 2023-09-30 "ncurses 6.4" "Library calls"
 .SH NAME
 \fBset_menu_spacing\fP,
 \fBmenu_spacing\fP \-
@@ -48,36 +48,37 @@ set and get spacing between menu items.
                  \fBint* \fIspc_columns\fB);\fR
 .SH DESCRIPTION
 The function \fBset_menu_spacing\fP sets the spacing information for the menu.
-Its parameter \fBspc_description\fP controls the number of spaces
+Its parameters provide the description and the size (in rows and columns).
+.TP
+\fIspc_description\fP
+controls the number of spaces
 between an item name and an item description.
 It must not be larger than \fBTABSIZE\fP.
 The menu system puts in the
 middle of this spacing area the pad character.
 The remaining parts are filled with
 spaces.
-The \fBspc_rows\fP parameter controls the number of rows
+.TP
+\fIspc_rows\fP
+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 \fBspc_columns\fP parameter controls
-the number of blanks between columns of items.
+.TP
+\fIspc_columns\fP
+controls the number of blanks between columns of items.
 It must not be larger than \fBTABSIZE\fP.
 A value of 0 for all the spacing values resets them to the default,
 which is 1 for all of them.
-.br
-The function \fBmenu_spacing\fP passes back the spacing info for the menu.
-If a
-pointer is NULL, this specific info is simply not returned.
+.PP
+The function \fBmenu_spacing\fP returns the spacing information for the menu.
+If a pointer is NULL, the corresponding information is simply not returned.
 .SH RETURN VALUE
 Both routines return \fBE_OK\fP on success.
 \fBset_menu_spacing\fP may return
 \fBE_POSTED\fP if the menu is posted, or \fBE_BAD_ARGUMENT\fP if one of the
 spacing values is out of range.
-.SH SEE ALSO
-\fBcurses\fP(3X),
-\fBcurs_variables\fP(3X),
-\fBmenu\fP(3X).
 .SH NOTES
 The header file \fB<menu.h>\fP automatically includes the header file
 \fB<curses.h>\fP.
@@ -90,3 +91,7 @@ any code depending on them be conditioned using NCURSES_VERSION.
 .SH AUTHORS
 Juergen Pfeifer.
 Manual pages and adaptation for new curses by Eric S. Raymond.
+.SH SEE ALSO
+\fB\%curses\fP(3X),
+\fB\%curs_variables\fP(3X),
+\fB\%menu\fP(3X)