man7.org > Linux > man-pages

Linux/UNIX system programming training

menu_spacing(3x) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | PORTABILITY | AUTHORS | SEE ALSO | COLOPHON 

menu_spacing(3X)              Library calls              menu_spacing(3X)

NAME         top

       set_menu_spacing, menu_spacing - set and get spacing between menu
       items.

SYNOPSIS         top

       #include <menu.h>

       int set_menu_spacing(MENU *menu,
                            int spc_description,
                            int spc_rows,
                            int spc_columns);
       int menu_spacing(const MENU *menu,
                        int* spc_description,
                        int* spc_rows,
                        int* spc_columns);

DESCRIPTION         top

       The function set_menu_spacing sets the spacing information for the
       menu.  Its parameters provide the description and the size (in
       rows and columns).

       spc_description
              controls the number of spaces between an item name and an
              item description.  It must not be larger than TABSIZE.  The
              menu system puts in the middle of this spacing area the pad
              character.  The remaining parts are filled with spaces.

       spc_rows
              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.

       spc_columns
              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.

       The function menu_spacing returns the spacing information for the
       menu.  If a pointer is NULL, the corresponding information is
       simply not returned.

RETURN VALUE         top

       Both routines return E_OK on success.  set_menu_spacing may return
       E_POSTED if the menu is posted, or E_BAD_ARGUMENT if one of the
       spacing values is out of range.

PORTABILITY         top

       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.

AUTHORS         top

       Juergen Pfeifer.  Manual pages and adaptation for new curses by
       Eric S. Raymond.

SEE ALSO         top

       curses(3X), curs_variables(3X), menu(3X)

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://invisible-island.net/ncurses/ncurses.html⟩.  If you have a
       bug report for this manual page, send it to bug-ncurses@gnu.org.
       This page was obtained from the tarball ncurses-6.6.tar.gz fetched
       from ⟨https://ftp.gnu.org/gnu/ncurses/⟩ on 2026-01-16.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for the
       page, or you have corrections or improvements to the information
       in this COLOPHON (which is not part of the original manual page),
       send a mail to man-pages@man7.org

ncurses @NCURSES_MAJOR@.@NCU... 2024-12-28               menu_spacing(3X)

HTML rendering created 2026-01-16 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI