aboutsummaryrefslogtreecommitdiff
path: root/man/panel.3x
diff options
context:
space:
mode:
Diffstat (limited to 'man/panel.3x')
-rw-r--r--man/panel.3x27
1 files changed, 18 insertions, 9 deletions
diff --git a/man/panel.3x b/man/panel.3x
index c63b4315699b..15bc81fdfa4f 100644
--- a/man/panel.3x
+++ b/man/panel.3x
@@ -27,8 +27,8 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: panel.3x,v 1.63 2024/03/16 15:35:01 tom Exp $
-.TH panel 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.\" $Id: panel.3x,v 1.68 2024/12/28 21:26:21 tom Exp $
+.TH panel 3X 2024-12-28 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
.ie \n(.g \{\
.ds `` \(lq
.ds '' \(rq
@@ -46,7 +46,7 @@
..
.SH NAME
panel \-
-panel stack extension for \fIcurses\fP
+manage overlapping \fIcurses\fP windows
.SH SYNOPSIS
.nf
\fB#include <panel.h>
@@ -215,8 +215,9 @@ Use this function and not \fB\%wrefresh\fP(3X) or
but \fB\%doupdate\fP is the function responsible for updating
the physical screen.
.SH "RETURN VALUE"
-Each routine that returns a pointer returns \fBNULL\fP if an error
-occurs.
+Each routine that returns a pointer returns
+.I NULL
+if an error occurs.
Each routine that returns an int value returns \fBOK\fP if it
executes successfully and \fBERR\fP if not.
.PP
@@ -226,7 +227,10 @@ If either is null,
an error is returned.
.PP
The \fB\%move_panel\fP function uses \fBmvwin\fP(3X),
-and returns an error if \fB\%mvwin\fP returns an error.
+and returns
+.B ERR
+if \fB\%mvwin\fP returns
+.BR ERR "."
.SH NOTES
The header file \fI\%panel.h\fP itself includes the header file
\fI\%curses.h\fP.
@@ -260,9 +264,14 @@ Systems based on SVr4 source code,
such as Solaris,
provide this library.
.bP
-\fI\%ncurses\fP (since version 0.6 in 1993)
-and \fIPDCurses\fP (since version 2.2 in 1995)
-provide a panel library whose common ancestor
+.I \%ncurses
+(since version 0.6 in 1993)
+and
+.I \%PDCurses
+(since version 2.2 in 1995)
+provide a
+.I panel
+library whose common ancestor
is a public domain implementation by Warren Tucker
published in \fIu386mon\fP 2.20 (1990).
.IP