ncurses 6.2 - patch 20200411

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

diff --git a/man/curs_util.3x b/man/curs_util.3x
index b98560fdfae84143373904a88896ce204128e36c..7cee63fe1337babbbabfd246d8f7497097235e6b 100644 (file)
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
+.\" Copyright 1998-2015,2017 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,7 +28,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_util.3x,v 1.53 2018/05/26 13:39:03 tom Exp $
+.\" $Id: curs_util.3x,v 1.57 2020/02/02 23:34:34 tom Exp $
 .TH curs_util 3X ""
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
@@ -57,13 +58,13 @@
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .sp
-\fBchar *unctrl(chtype c);\fR
+\fBconst char *unctrl(chtype c);\fR
 .br
 \fBwchar_t *wunctrl(cchar_t *c);\fR
 .br
-\fBchar *keyname(int c);\fR
+\fBconst char *keyname(int c);\fR
 .br
-\fBchar *key_name(wchar_t w);\fR
+\fBconst char *key_name(wchar_t w);\fR
 .br
 \fBvoid filter(void);\fR
 .br
@@ -114,8 +115,8 @@ Values above 256 may be the names of the names of function keys.
 .bP
 Otherwise (if there is no corresponding name) the function returns null,
 to denote an error.
-X/Open also lists an "UNKNOWN KEY" return value, which some implementations
-return rather than null.
+X/Open also lists an \*(``UNKNOWN KEY\*('' return value,
+which some implementations return rather than null.
 .LP
 The corresponding \fBkey_name\fR returns a character string corresponding
 to the wide-character value \fIw\fR.
@@ -181,7 +182,8 @@ The \fBuse_tioctl\fR routine, if used,
 should be called before \fBinitscr\fR or \fBnewterm\fR are called
 (because those compute the screen size).
 After \fBuse_tioctl\fR is called with \fBTRUE\fR as an argument,
-\fBncurses\fP modifies the last step in its computation of screen size as follows:
+\fBncurses\fP modifies the last step in its computation
+of screen size as follows:
 .bP
 checks if the \fBLINES\fR and \fBCOLUMNS\fR environment variables
 are set to a number greater than zero.
@@ -210,7 +212,8 @@ TRUE/TRUE/T{
 \fBncurses\fP updates $LINES and $COLUMNS based on operating system calls.
 T}
 FALSE/TRUE/T{
-\fBncurses\fP ignores $LINES and $COLUMNS, uses operating system calls to obtain size.
+\fBncurses\fP ignores $LINES and $COLUMNS,
+uses operating system calls to obtain size.
 T}
 FALSE/FALSE/T{
 \fBncurses\fP relies on the terminal database to determine size.
@@ -287,7 +290,7 @@ 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.
 This implementation automatically assigns at run-time keycodes to
-user-defined strings which begin with "k".
+user-defined strings which begin with \*(``k\*(''.
 The keycodes start at KEY_MAX, but are not guaranteed to be
 the same value for different runs because user-defined codes are
 merged from all terminal descriptions which have been loaded.
@@ -316,8 +319,10 @@ and were later (in 1988) incorporated into SVr4.
 Oddly, there are no such functions in the 4.3BSD curses sources.
 .bP
 Most implementations simply dump the binary \fBWINDOW\fP structure to the file.
-These include SVr4 curses, NetBSD and PDCurses, as well as older \fBncurses\fP versions.
-This implementation (as well as the X/Open variant of Solaris curses, dated 1995)
+These include SVr4 curses, NetBSD and PDCurses,
+as well as older \fBncurses\fP versions.
+This implementation
+(as well as the X/Open variant of Solaris curses, dated 1995)
 uses textual dumps.
 .IP
 The implementations which use binary dumps use block-I/O
@@ -355,7 +360,8 @@ parameter values outside the 0 to 255 range.
 .PP
 The strings returned by \fBunctrl\fR in this implementation are determined
 at compile time,
-showing C1 controls from the upper-128 codes with a \*(``~\*('' prefix rather than \*(``^\*(''.
+showing C1 controls from the upper-128 codes
+with a \*(``~\*('' prefix rather than \*(``^\*(''.
 Other implementations have different conventions.
 For example, they may show both sets of control characters with \*(``^\*('',
 and strip the parameter to 7 bits.