ncurses 6.4 - patch 20230701

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

diff --git a/man/curs_util.3x b/man/curs_util.3x
index 52e6e276af37cb5a797044089e45d28bebade099..aee7c4a90f96627883cc848748c5799baf6d3376 100644 (file)
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -28,8 +28,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_util.3x,v 1.67 2023/03/11 20:28:02 tom Exp $
-.TH curs_util 3X 2023-03-11 "ncurses 6.4" "Library calls"
+.\" $Id: curs_util.3x,v 1.70 2023/07/01 14:31:54 tom Exp $
+.TH curs_util 3X 2023-07-01 "ncurses 6.4" "Library calls"
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
@@ -81,10 +81,8 @@
 \fBint delay_output(int \fIms\fB);\fR
 .br
 \fBint flushinp(void);\fP
-.br
 .SH DESCRIPTION
 .SS unctrl
-.PP
 The \fBunctrl\fP routine returns a character string which is a printable
 representation of the character \fIc\fP, ignoring attributes.
 Control characters are displayed in the \fB^\fIX\fR notation.
@@ -93,7 +91,6 @@ Printing characters are displayed as is.
 The corresponding \fBwunctrl\fP returns a printable representation of
 a wide character.
 .SS keyname/key_name
-.PP
 The \fBkeyname\fP routine returns a character string
 corresponding to the key \fIc\fP:
 .bP
@@ -124,7 +121,6 @@ to the wide-character value \fIw\fP.
 The two functions do not return the same set of strings;
 the latter returns null where the former would display a meta character.
 .SS filter/nofilter
-.PP
 The \fBfilter\fP routine, if used, must be called before \fBinitscr\fP or
 \fBnewterm\fP are called.
 Calling \fBfilter\fP causes these changes in initialization:
@@ -152,7 +148,6 @@ using a different value of \fB$TERM\fP.
 The limitation arises because the \fBfilter\fP routine modifies the
 in-memory copy of the terminal information.
 .SS use_env
-.PP
 The \fBuse_env\fP routine, if used,
 should be called before \fBinitscr\fP or
 \fBnewterm\fP are called
@@ -178,7 +173,6 @@ from the operating system or terminal database.
 \fBNcurses\fP also updates the screen size in response to \fBSIGWINCH\fP,
 unless overridden by the \fBLINES\fP or \fBCOLUMNS\fP environment variables,
 .SS use_tioctl
-.PP
 The \fBuse_tioctl\fP routine, if used,
 should be called before \fBinitscr\fP or \fBnewterm\fP are called
 (because those compute the screen size).
@@ -221,7 +215,6 @@ FALSE/FALSE/T{
 T}
 .TE
 .SS putwin/getwin
-.PP
 The \fBputwin\fP routine writes all data associated
 with window (or pad) \fIwin\fP into
 the file to which \fIfilep\fP points.
@@ -250,7 +243,6 @@ If cells in the retrieved window use color pairs which have not been
 created in the application using \fBinit_pair\fP,
 they will not be colored when the window is refreshed.
 .SS delay_output
-.PP
 The \fBdelay_output\fP routine inserts an \fIms\fP millisecond pause
 in output.
 This routine should not be used extensively because
@@ -258,7 +250,6 @@ padding characters are used rather than a CPU pause.
 If no padding character is specified,
 this uses \fBnapms\fP to perform the delay.
 .SS flushinp
-.PP
 The \fBflushinp\fP routine throws away any typeahead that has been typed by the
 user and has not yet been read by the program.
 .SH RETURN VALUE
@@ -280,13 +271,11 @@ returns an error if the associated \fBfwrite\fP calls return an error.
 .RE
 .SH PORTABILITY
 .SS filter
-.PP
 The SVr4 documentation describes the action of \fBfilter\fP only in the vaguest
 terms.
 The description here is adapted from the XSI Curses standard (which
 erroneously fails to describe the disabling of \fBcuu\fP).
 .SS keyname
-.PP
 The \fBkeyname\fP function may return the names of user-defined
 string capabilities which are defined in the terminfo entry via the \fB\-x\fP
 option of \fB@TIC@\fP.
@@ -298,13 +287,11 @@ merged from all terminal descriptions which have been loaded.
 The \fBuse_extended_names\fP(3X) function controls whether this data is
 loaded when the terminal description is read by the library.
 .SS nofilter/use_tioctl
-.PP
 The \fBnofilter\fP and \fBuse_tioctl\fP routines are specific to \fBncurses\fP.
 They were not supported on Version 7, BSD or System V implementations.
 It is recommended that any code depending on \fBncurses\fP extensions
 be conditioned using NCURSES_VERSION.
 .SS putwin/getwin file-format
-.PP
 The \fBputwin\fP and \fBgetwin\fP functions have several issues with
 portability:
 .bP
@@ -335,7 +322,6 @@ Doing that can run into problems mixing block- and buffered-I/O.
 This implementation reduces the problem on writes by flushing the output.
 However, reading from a file written using mixed schemes may not be successful.
 .SS unctrl/wunctrl
-.PP
 The XSI Curses standard, Issue 4 describes these functions.
 It states that \fBunctrl\fP and \fBwunctrl\fP will return a null pointer if
 unsuccessful, but does not define any error conditions.
@@ -390,7 +376,6 @@ However, \fBncurses\fP' \fB<curses.h>\fP includes \fB<unctrl.h>\fP,
 matching the behavior of SVr4 curses.
 Other implementations may not do that.
 .SS use_env/use_tioctl
-.PP
 If \fBncurses\fP is configured to provide the sp-functions extension,
 the state of \fBuse_env\fP and \fBuse_tioctl\fP may be updated before
 creating each \fIscreen\fP rather than once only