ncurses 6.3 - patch 20211225

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

diff --git a/man/menu_format.3x b/man/menu_format.3x
index 055c7e77b83bcff065d0cd78e19a1ce6b10e1a93..2d0e782963079608356e12b9388eb5ac18d6c8ca 100644 (file)
--- a/man/menu_format.3x
+++ b/man/menu_format.3x
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2016,2018 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 1998-2015,2016 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,35 +28,35 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: menu_format.3x,v 1.15 2018/07/28 21:34:06 tom Exp $
+.\" $Id: menu_format.3x,v 1.20 2021/12/25 21:49:32 tom Exp $
 .TH menu_format 3X ""
 .SH NAME
 \fBset_menu_format\fP,
 \fBmenu_format\fP \- set and get menu sizes
 .SH SYNOPSIS
-\fB#include <menu.h>\fR
+\fB#include <menu.h>\fP
+.sp
+\fBint set_menu_format(MENU *\fP\fImenu\fP\fB, int \fP\fIrows\fP\fB, int \fP\fIcols\fP\fB);\fP
 .br
-int set_menu_format(MENU *menu, int rows, int cols);
-.br
-void menu_format(const MENU *menu, int *rows, int *cols);
+\fBvoid menu_format(const MENU *\fP\fImenu\fP\fB, int *\fP\fIrows\fP\fB, int *\fP\fIcols\fP\fB);\fP
 .br
 .SH DESCRIPTION
-The function \fBset_menu_format\fR sets the maximum display size of the given
+The function \fBset_menu_format\fP sets the maximum display size of the given
 menu.
 If this size is too small to display all menu items, the menu will be
 made scrollable.
 If this size is larger than the menus subwindow and the
-subwindow is too small to display all menu items, \fBpost_menu\fR will fail.
+subwindow is too small to display all menu items, \fBpost_menu\fP will fail.
 .PP
 The default format is 16 rows, 1 column.
-Calling \fBset_menu_format\fR with a
+Calling \fBset_menu_format\fP with a
 null menu pointer will change this default.
 A zero row or column argument to
-\fBset_menu_format\fR is interpreted as a request not to change the current
+\fBset_menu_format\fP is interpreted as a request not to change the current
 value.
 .PP
-The function \fBmenu_format\fR returns the maximum-size constraints for the
-given menu into the storage addressed by \fBrows\fR and \fBcols\fR.
+The function \fBmenu_format\fP returns the maximum-size constraints for the
+given menu into the storage addressed by \fBrows\fP and \fBcols\fP.
 .SH RETURN VALUE
 These routines returns one of the following:
 .TP 5
@@ -63,7 +64,7 @@ These routines returns one of the following:
 The routine succeeded.
 .TP 5
 .B E_SYSTEM_ERROR
-System error occurred (see \fBerrno\fR).
+System error occurred (see \fBerrno\fP(3)).
 .TP 5
 .B E_BAD_ARGUMENT
 Routine detected an incorrect or out-of-range argument.
@@ -74,10 +75,10 @@ The menu is already posted.
 .B E_NOT_CONNECTED
 No items are connected to the menu.
 .SH SEE ALSO
-\fBcurses\fR(3X), \fBmenu\fR(3X).
+\fBcurses\fP(3X), \fBmenu\fP(3X).
 .SH NOTES
-The header file \fB<menu.h>\fR automatically includes the header file
-\fB<curses.h>\fR.
+The header file \fB<menu.h>\fP automatically includes the header file
+\fB<curses.h>\fP.
 .SH PORTABILITY
 These routines emulate the System V menu library.
 They were not supported on