ncurses 6.4 - patch 20230923

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

diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x
index e7f8561d78f3e35f6777f9eb73ab695f790a73ab..6e13f7db32508608b98a6b0499acf1ef77f87d52 100644 (file)
--- a/man/curs_opaque.3x
+++ b/man/curs_opaque.3x
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_opaque.3x,v 1.27 2023/09/16 23:37:03 tom Exp $
-.TH curs_opaque 3X 2023-09-16 "ncurses 6.4" "Library calls"
+.\" $Id: curs_opaque.3x,v 1.33 2023/09/23 22:59:48 tom Exp $
+.TH curs_opaque 3X 2023-09-23 "ncurses 6.4" "Library calls"
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
@@ -51,101 +51,89 @@
 \fB\%wgetscrreg\fP \-
 obtain \fIcurses\fR window properties
 .SH SYNOPSIS
+.nf
 \fB#include <curses.h>\fP
-.sp
+.PP
 \fBbool is_cleared(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_idcok(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_idlok(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_immedok(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_keypad(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_leaveok(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_nodelay(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_notimeout(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_pad(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_scrollok(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_subwin(const WINDOW *\fIwin\fB);\fR
-.br
 \fBbool is_syncok(const WINDOW *\fIwin\fB);\fR
-.br
 \fBWINDOW * wgetparent(const WINDOW *\fIwin\fB);\fR
-.br
 \fBint wgetdelay(const WINDOW *\fIwin\fB);\fR
-.br
 \fBint wgetscrreg(const WINDOW *\fIwin\fB, int *\fItop\fB, int *\fIbottom\fB);\fR
+.fi
 .SH DESCRIPTION
 This implementation provides functions which return properties
-set in the WINDOW structure, allowing it to be \*(``opaque\*('' if
-the symbol \fBNCURSES_OPAQUE\fP is defined:
+set in the \fB\%WINDOW\fP structure, allowing it to be \*(``opaque\*('' if
+the symbol \fB\%NCURSES_OPAQUE\fP is defined:
 .TP 5
 \fBis_cleared\fP
-returns the value set in \fBclearok\fP(3X)
+returns the value set in \fB\%clearok\fP(3X)
 .TP 5
 \fBis_idcok\fP
-returns the value set in \fBidcok\fP(3X)
+returns the value set in \fB\%idcok\fP(3X)
 .TP 5
 \fBis_idlok\fP
-returns the value set in \fBidlok\fP(3X)
+returns the value set in \fB\%idlok\fP(3X)
 .TP 5
 \fBis_immedok\fP
-returns the value set in \fBimmedok\fP(3X)
+returns the value set in \fB\%immedok\fP(3X)
 .TP 5
 \fBis_keypad\fP
-returns the value set in \fBkeypad\fP(3X)
+returns the value set in \fB\%keypad\fP(3X)
 .TP 5
 \fBis_leaveok\fP
-returns the value set in \fBleaveok\fP(3X)
+returns the value set in \fB\%leaveok\fP(3X)
 .TP 5
 \fBis_nodelay\fP
-returns the value set in \fBnodelay\fP(3X)
+returns the value set in \fB\%nodelay\fP(3X)
 .TP 5
 \fBis_notimeout\fP
-returns the value set in \fBnotimeout\fP(3X)
+returns the value set in \fB\%notimeout\fP(3X)
 .TP 5
 \fBis_pad\fP
 returns \fBTRUE\fP if the window is a pad
-i.e., created by \fBnewpad\fP(3X)
+i.e., created by \fB\%newpad\fP(3X)
 .TP 5
 \fBis_scrollok\fP
-returns the value set in \fBscrollok\fP(3X)
+returns the value set in \fB\%scrollok\fP(3X)
 .TP 5
 \fBis_subwin\fP
 returns \fBTRUE\fP if the window is a subwindow,
-i.e., created by \fBsubwin\fP(3X) or \fBderwin\fP(3X)
+i.e., created by \fB\%subwin\fP(3X) or \fB\%derwin\fP(3X)
 .TP 5
 \fBis_syncok\fP
-returns the value set in \fBsyncok\fP(3X)
+returns the value set in \fB\%syncok\fP(3X)
 .TP 5
 \fBwgetdelay\fP
-returns the delay timeout as set in \fBwtimeout\fP(3X).
+returns the delay timeout as set in \fB\%wtimeout\fP(3X).
 .TP 5
 \fBwgetparent\fP
-returns the parent WINDOW pointer for subwindows,
-or NULL for windows having no parent.
+returns the parent \fB\%WINDOW\fP pointer for subwindows,
+or \fBNULL\fP for windows having no parent.
 .TP 5
 \fBwgetscrreg\fP
 returns the top and bottom rows for the scrolling margin
-as set in \fBwsetscrreg\fP.
+as set in \fB\%wsetscrreg\fP(3X).
 .SH RETURN VALUE
 These functions all return \fBTRUE\fP or \fBFALSE\fP, except as noted.
 .SH NOTES
 Both a macro and a function are provided for each name.
 .SH PORTABILITY
-These routines are specific to ncurses.
+These routines are specific to \fIncurses\fP.
 They were not supported on Version 7, BSD or System V implementations.
-It is recommended that any code depending on ncurses extensions
-be conditioned using NCURSES_VERSION.
+It is recommended that any code depending on \fIncurses\fP extensions
+be conditioned using \fB\%NCURSES_VERSION\fP.
 .SH SEE ALSO
-\fBcurses\fP(3X),
-\fBcurs_inopts\fP(3X),
-\fBcurs_outopts\fP(3X),
-\fBcurs_window\fP(3X)
+\fB\%curses\fP(3X),
+\fB\%curs_inopts\fP(3X),
+\fB\%curs_outopts\fP(3X),
+\fB\%curs_window\fP(3X)