diff options
Diffstat (limited to 'man/menu_spacing.3x')
| -rw-r--r-- | man/menu_spacing.3x | 52 |
1 files changed, 24 insertions, 28 deletions
diff --git a/man/menu_spacing.3x b/man/menu_spacing.3x index 9e7c3eabfe92..dfe03a8a55b1 100644 --- a/man/menu_spacing.3x +++ b/man/menu_spacing.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2001,2004 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_spacing.3x,v 1.12 2010/12/04 18:38:55 tom Exp $ +.\" $Id: menu_spacing.3x,v 1.8 2004/12/11 23:39:07 tom Exp $ .TH menu_spacing 3X "" .SH NAME -\fBmenu_spacing\fR \- Control spacing between menu items. +\fBmenu_spacing\fR - Control spacing between menu items. .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -45,44 +45,40 @@ int menu_spacing(const MENU *menu, int* spc_columns); .br .SH DESCRIPTION -The function \fBset_menu_spacing\fR sets the spacing information for the menu. -Its parameter \fBspc_description\fR controls the number of spaces between an item name and an item -description. -It must not be larger than \fBTABSIZE\fR. -The menu system puts in the -middle of this spacing area the pad character. -The remaining parts are filled with +The function \fBset_menu_spacing\fR sets the spacing informations for the menu. +\fBspc_description\fR controls the number of spaces between an item name and an item +description. It must not be larger than \fBTABSIZE\fR. The menu system puts in the +middle of this spacing area the pad character. The remaining parts are filled with spaces. -The \fBspc_rows\fR 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 +\fBspc_rows\fR 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\fR parameter controls the number of blanks between columns of items. -It must not be larger than TABSIZE. +\fBspc_columns\fR 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 resets them to the default, which is 1 for all of them. .br -The function \fBmenu_spacing\fR passes back the spacing info for the menu. -If a +The function \fBmenu_spacing\fR passes back the spacing info for the menu. If a pointer is NULL, this specific info is simply not returned. .SH RETURN VALUE -Both routines return \fBE_OK\fR on success. -\fBset_menu_spacing\fR may return +Both routines return \fBE_OK\fR on success. \fBset_menu_spacing\fR may return \fBE_POSTED\fR if the menu is posted, or \fBE_BAD_ARGUMENT\fR if one of the spacing values is out of range. .SH SEE ALSO -\fBcurses\fR(3X), -\fBcurs_variables\fR(3X), -\fBmenu\fR(3X). +\fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES The header file \fB<menu.h>\fR automatically includes the header file \fB<curses.h>\fR. .SH PORTABILITY -These routines are specific to ncurses. -They were not supported on -Version 7, BSD or System V implementations. -It is recommended that +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 conditioned using NCURSES_VERSION. .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. +.\"# +.\"# The following sets edit modes for GNU EMACS +.\"# Local Variables: +.\"# mode:nroff +.\"# fill-column:79 +.\"# End: |