ncurses 6.5 - patch 20240519

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

diff --git a/man/curs_util.3x b/man/curs_util.3x
index 7e162e959457625ed8e16efc9061b780c57138d0..ac92fa8af40556189c079e29ef0e3985f32a7ae6 100644 (file)
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -28,8 +28,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_util.3x,v 1.98 2024/03/16 15:50:09 tom Exp $
-.TH curs_util 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.\" $Id: curs_util.3x,v 1.102 2024/05/11 20:39:53 tom Exp $
+.TH curs_util 3X 2024-05-11 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq


@@ -63,15 +63,15 @@ miscellaneous \fIcurses\fR utility routines
 .nf
 \fB#include <curses.h>
 .PP
 .nf
 \fB#include <curses.h>
 .PP

-\fBconst char *unctrl(chtype \fIc\fP);
-\fBwchar_t *wunctrl(cchar_t *\fIc\fP);
+\fBconst char *unctrl(chtype \fIch\fP);
+\fBwchar_t *wunctrl(cchar_t *\fIwch\fP);

 .PP
 \fBconst char *keyname(int \fIc\fP);
 .PP
 \fBconst char *keyname(int \fIc\fP);

-\fBconst char *key_name(wchar_t \fIw\fP);
+\fBconst char *key_name(wchar_t \fIwc\fP);

 .PP
 \fBvoid filter(void);
 .PP
 .PP
 \fBvoid filter(void);
 .PP

-\fBvoid use_env(bool \fIf\fP);
+\fBvoid use_env(bool \fIbf\fP);

 .PP
 \fBint putwin(WINDOW *\fIwin\fP, FILE *\fIfilep\fP);
 \fBWINDOW *getwin(FILE *\fIfilep\fP);
 .PP
 \fBint putwin(WINDOW *\fIwin\fP, FILE *\fIfilep\fP);
 \fBWINDOW *getwin(FILE *\fIfilep\fP);


@@ -81,12 +81,12 @@ miscellaneous \fIcurses\fR utility routines
 .PP
 \fI/* extensions */
 \fBvoid nofilter(void);
 .PP
 \fI/* extensions */
 \fBvoid nofilter(void);

-\fBvoid use_tioctl(bool \fIf\fP);
+\fBvoid use_tioctl(bool \fIbf\fP);

 .fi
 .SH DESCRIPTION
 .SS unctrl
 The \fBunctrl\fP routine returns a character string which is a printable
 .fi
 .SH DESCRIPTION
 .SS unctrl
 The \fBunctrl\fP routine returns a character string which is a printable

-representation of the character \fIc\fP:
+representation of the character \fIch\fP:

 .bP
 Printable characters are displayed as themselves,
 e.g., a one-character string containing the key.
 .bP
 Printable characters are displayed as themselves,
 e.g., a one-character string containing the key.


@@ -106,7 +106,7 @@ In the latter case, the values may not be printable;
 this follows the X/Open specification.
 .PP
 The corresponding \fBwunctrl\fP returns a printable representation of
 this follows the X/Open specification.
 .PP
 The corresponding \fBwunctrl\fP returns a printable representation of

-a complex character \fIc\fP.
+a complex character \fIwch\fP.

 .PP
 In both \fBunctrl\fP and \fBwunctrl\fP the attributes and color associated
 with the character parameter are ignored.
 .PP
 In both \fBunctrl\fP and \fBwunctrl\fP the attributes and color associated
 with the character parameter are ignored.


@@ -217,7 +217,6 @@ lB lB lx.
 use_env        use_tioctl      Summary
 _
 TRUE   FALSE   T{
 use_env        use_tioctl      Summary
 _
 TRUE   FALSE   T{

-This is the default behavior.

 \fI\%ncurses\fP uses operating system calls
 unless overridden by \fILINES\fP or \fI\%COLUMNS\fP environment
 variables;
 \fI\%ncurses\fP uses operating system calls
 unless overridden by \fILINES\fP or \fI\%COLUMNS\fP environment
 variables;


@@ -302,7 +301,7 @@ returns an error if the associated \fBfwrite\fP calls return an error.
 .SS filter
 The SVr4 documentation describes the action of \fBfilter\fP only in the vaguest
 terms.
 .SS filter
 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
+The description here is adapted from X/Open Curses (which

 erroneously fails to describe the disabling of \fBcuu\fP).
 .SS "delay_output padding"
 The limitation to 30 seconds
 erroneously fails to describe the disabling of \fBcuu\fP).
 .SS "delay_output padding"
 The limitation to 30 seconds


@@ -364,7 +363,7 @@ 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"
 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"

-The XSI Curses standard, Issue 4 describes these functions.
+X/Open Curses, 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.
 This implementation checks for three cases:
 It states that \fBunctrl\fP and \fBwunctrl\fP will return a null pointer if
 unsuccessful, but does not define any error conditions.
 This implementation checks for three cases: