From fc11bff62abb32a3e7724180a94c1068c148ea6c Mon Sep 17 00:00:00 2001 From: "Thomas E. Dickey" Date: Sun, 12 May 2024 00:16:58 +0000 Subject: [PATCH] ncurses 6.5 - patch 20240511 + improve formatting/style of manpages (patches by Branden Robinson). + limit value from ESCDELAY environment variable to 30 seconds, like other delay limits. + limit values from LINES and COLUMNS environment variables to 512 (report by Miroslav Lichvar). --- NEWS | 9 +- VERSION | 2 +- dist.mk | 4 +- doc/html/man/curs_add_wch.3x.html | 256 ++++++----- doc/html/man/curs_add_wchstr.3x.html | 59 ++- doc/html/man/curs_addch.3x.html | 232 +++++----- doc/html/man/curs_addchstr.3x.html | 51 +-- doc/html/man/curs_attr.3x.html | 13 +- doc/html/man/curs_delch.3x.html | 30 +- doc/html/man/curs_get_wch.3x.html | 71 +-- doc/html/man/curs_getch.3x.html | 128 +++--- doc/html/man/curs_getstr.3x.html | 10 +- doc/html/man/curs_getyx.3x.html | 64 +-- doc/html/man/curs_inch.3x.html | 86 ++-- doc/html/man/curs_mouse.3x.html | 20 +- doc/html/man/curs_outopts.3x.html | 32 +- doc/html/man/curs_sp_funcs.3x.html | 8 +- doc/html/man/curs_termattrs.3x.html | 12 +- doc/html/man/curs_util.3x.html | 165 ++++--- doc/html/man/infocmp.1m.html | 8 +- doc/html/man/infotocap.1m.html | 8 +- doc/html/man/ncurses.3x.html | 663 ++++++++++++++------------- doc/html/man/ncursesw6-config.1.html | 8 +- doc/html/man/term.5.html | 233 +++++----- doc/html/man/term.7.html | 8 +- doc/html/man/terminfo.5.html | 10 +- doc/html/man/tic.1m.html | 8 +- doc/html/man/toe.1m.html | 8 +- doc/html/man/tput.1.html | 8 +- doc/html/man/tset.1.html | 8 +- man/MKncu_config.in | 4 +- man/curs_add_wch.3x | 300 +++++++----- man/curs_add_wchstr.3x | 87 ++-- man/curs_addch.3x | 148 +++--- man/curs_addchstr.3x | 81 ++-- man/curs_attr.3x | 14 +- man/curs_delch.3x | 17 +- man/curs_get_wch.3x | 51 +-- man/curs_getch.3x | 120 ++--- man/curs_getstr.3x | 6 +- man/curs_getyx.3x | 135 ++++-- man/curs_inch.3x | 119 +++-- man/curs_mouse.3x | 13 +- man/curs_outopts.3x | 28 +- man/curs_sp_funcs.3x | 4 +- man/curs_termattrs.3x | 6 +- man/curs_util.3x | 9 +- man/infocmp.1m | 7 +- man/infotocap.1m | 7 +- man/man_db.renames.in | 6 +- man/manhtml.aliases | 7 +- man/manhtml.externs | 3 +- man/ncurses.3x | 188 +++++--- man/term.5 | 423 +++++++++++------ man/term.7 | 11 +- man/terminfo.head | 7 +- man/terminfo.tail | 8 +- man/tic.1m | 16 +- man/toe.1m | 7 +- man/tput.1 | 7 +- man/tset.1 | 7 +- ncurses/base/lib_newterm.c | 5 +- ncurses/curses.priv.h | 8 +- ncurses/tinfo/lib_setup.c | 6 +- ncurses/tinfo/tinfo_driver.c | 8 +- package/debian-mingw/changelog | 4 +- package/debian-mingw64/changelog | 4 +- package/debian/changelog | 4 +- package/mingw-ncurses.nsi | 4 +- package/mingw-ncurses.spec | 2 +- package/ncurses.spec | 2 +- package/ncursest.spec | 2 +- 72 files changed, 2289 insertions(+), 1828 deletions(-) diff --git a/NEWS b/NEWS index 144f70b4..99f97ee0 100644 --- a/NEWS +++ b/NEWS @@ -26,7 +26,7 @@ -- sale, use or other dealings in this Software without prior written -- -- authorization. -- ------------------------------------------------------------------------------- --- $Id: NEWS,v 1.4117 2024/05/04 18:43:01 tom Exp $ +-- $Id: NEWS,v 1.4119 2024/05/11 21:38:14 tom Exp $ ------------------------------------------------------------------------------- This is a log of changes that ncurses has gone through since Zeyd started @@ -46,6 +46,13 @@ See the AUTHORS file for the corresponding full names. Changes through 1.9.9e did not credit all contributions; it is not possible to add this information. +20240511 + + improve formatting/style of manpages (patches by Branden Robinson). + + limit value from ESCDELAY environment variable to 30 seconds, like + other delay limits. + + limit values from LINES and COLUMNS environment variables to 512 + (report by Miroslav Lichvar). + 20240504 + update ncurses/wcwidth.c, for MinGW ports, from xterm. + trim obsolete comment about tack from INSTALL. diff --git a/VERSION b/VERSION index b98d7203..2e2f7c02 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -5:0:10 6.5 20240504 +5:0:10 6.5 20240511 diff --git a/dist.mk b/dist.mk index 78d06b88..97db5c37 100644 --- a/dist.mk +++ b/dist.mk @@ -26,7 +26,7 @@ # use or other dealings in this Software without prior written # # authorization. # ############################################################################## -# $Id: dist.mk,v 1.1611 2024/05/04 10:21:09 tom Exp $ +# $Id: dist.mk,v 1.1612 2024/05/11 10:20:08 tom Exp $ # Makefile for creating ncurses distributions. # # This only needs to be used directly as a makefile by developers, but @@ -38,7 +38,7 @@ SHELL = /bin/sh # These define the major/minor/patch versions of ncurses. NCURSES_MAJOR = 6 NCURSES_MINOR = 5 -NCURSES_PATCH = 20240504 +NCURSES_PATCH = 20240511 # We don't append the patch to the version, since this only applies to releases VERSION = $(NCURSES_MAJOR).$(NCURSES_MINOR) diff --git a/doc/html/man/curs_add_wch.3x.html b/doc/html/man/curs_add_wch.3x.html index 64c645d5..a7dee58c 100644 --- a/doc/html/man/curs_add_wch.3x.html +++ b/doc/html/man/curs_add_wch.3x.html @@ -28,19 +28,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_add_wch.3x,v 1.62 2024/04/20 21:20:07 tom Exp @ + * @Id: curs_add_wch.3x,v 1.63 2024/05/11 21:31:45 tom Exp @ --> -curs_add_wch 3x 2024-04-20 ncurses 6.5 Library calls +curs_add_wch 3x 2024-05-11 ncurses 6.5 Library calls -

curs_add_wch 3x 2024-04-20 ncurses 6.5 Library calls

+

curs_add_wch 3x 2024-05-11 ncurses 6.5 Library calls

 curs_add_wch(3x)                 Library calls                curs_add_wch(3x)
 
@@ -49,7 +49,7 @@

NAME

        add_wch, wadd_wch, mvadd_wch, mvwadd_wch, echo_wchar, wecho_wchar - add
-       a curses complex character to a window and advance the cursor
+       a curses complex character to a window, possibly advancing the cursor

SYNOPSIS

@@ -66,55 +66,85 @@

DESCRIPTION

 
-

add_wch

-       The add_wch, wadd_wch, mvadd_wch,  and  mvwadd_wch  functions  put  the
-       complex  character  wch  into the given window at its current position,
-       which is then advanced.  These functions perform wrapping and  special-
-       character processing as follows:
-
-       o   If  wch  refers to a spacing character, then any previous character
-           at that location is removed.  A new character specified by  wch  is
-           placed  at  that  location  with  rendition  specified by wch.  The
-           cursor then advances after this spacing character, to  prepare  for
-           writing the next character on the screen.
-
-           The newly added spacing character is the base of the active complex
-           character.  Subsequent non-spacing characters can be combined  with
-           this base until another spacing character is written to the screen,
-           or the cursor is moved, e.g., using wmove.
-
-       o   If wch refers to a non-spacing character, it  is  appended  to  the
-           active complex character, retaining the previous characters at that
-           location.  The rendition specified by wch is ignored.
-
-           The cursor is not advanced after adding  a  non-spacing  character.
-           Subsequent calls to add non-spacing characters will update the same
-           position.
+

wadd_wch

+       wadd_wch writes the complex character wch to the window win,  then  may
+       advance  the  cursor  position, analogously to the standard C library's
+       putwchar(3).  ncurses(3x) describes the variants of this function.
+
+       Much behavior depends on whether the wide characters in wch are spacing
+       or non-spacing; see subsection "Complex Characters" below.
+
+       o   If  wch  contains  a  spacing  character, then any character at the
+           cursor is first removed.   The  complex  character  wch,  with  its
+           attributes  and  color  pair  identifier,  becomes  the base of the
+           active complex character.
+
+       o   If wch contains only non-spacing characters, they are combined with
+           the  active  complex  character.  curses ignores its attributes and
+           color pair identifier, and does not advance the cursor.
+
+       Further non-spacing characters added with wadd_wch are not  written  at
+       the  new  cursor position but combine with the active complex character
+       until another spacing character is written to the window or the  cursor
+       is moved.
+
+       If advancement occurs at the right margin,
+
+       o   the  cursor  automatically wraps to the beginning of the next line,
+           then,
+
+       o   if  it  was  at  the  bottom  of  the  scrolling  region,  and   if
+           scrollok(3x)  is  enabled  for win, the scrolling region scrolls up
+           one line.
 
-       o   If the character part of wch is a tab, newline, backspace or  other
-           control character, the window is updated and the cursor moves as if
-           addch were called.
+       If wch is a backspace, carriage return, line feed, or tab,  the  cursor
+       moves appropriately within the window.
 
+       o   Backspace  moves  the cursor one character left; at the left margin
+           of a window, it does nothing.
 
-

echo_wchar

-       The echo_wchar function is functionally equivalent to a call to add_wch
-       followed  by  a  call  to  refresh(3x).   Similarly, the wecho_wchar is
-       functionally equivalent to a call to wadd_wch followed  by  a  call  to
-       wrefresh.   The  knowledge that only a single character is being output
-       is  taken  into  consideration  and,  for  non-control  characters,   a
-       considerable  performance  gain  might  be  seen  by  using  the *echo*
-       functions instead of their equivalents.
+       o   Carriage return moves the cursor to the left margin on the  current
+           line of the window.
 
+       o   Line  feed  does a clrtoeol(3x), then advances as if from the right
+           margin.
 
-

Line Graphics

-       Like addch(3x), addch_wch accepts symbols which make it simple to  draw
-       lines  and  other  frequently  used  special characters.  These symbols
-       correspond to the same VT100 line-drawing set as addch(3x).
+       o   Tab advances the cursor to the next tab stop (possibly on the  next
+           line);  these  are placed at every eighth column by default.  Alter
+           the   tab   interval    with    the    TABSIZE    extension;    see
+           curs_variables(3x).
 
-                       Unicode   ASCII     acsc
+       If  wch  is  any other nonprintable character, it is drawn in printable
+       form using the same convention as wunctrl(3x).
 
+       Calling win_wch(3x) on the location of a  nonprintable  character  does
+       not return the character itself, but its wunctrl(3x) representation.
 
-       ACS Name        Default   Default   Char   Glyph Name
+
+

wecho_wchar

+       echo_wchar   and  wecho_wchar  are  equivalent  to  calling  (w)add_wch
+       followed by (w)refresh.  curses interprets these functions  as  a  hint
+       that only a single (complex) character is being output; for non-control
+       characters, a considerable performance gain may be enjoyed by employing
+       them.
+
+
+

Forms-Drawing Characters

+       curses  defines  macros  starting  with  WACS_  that  can  be used with
+       wadd_wch to write line-drawing and  other  special  characters  to  the
+       screen.  ncurses terms these forms-drawing characters.  The ACS default
+       listed below is used if the acs_chars (acsc) terminfo  capability  does
+       not  define  a terminal-specific replacement for it, or if the terminal
+       and locale configuration requires Unicode to  access  these  characters
+       but  the  library  is  unable  to  use Unicode.  The "acsc char" column
+       corresponds to how the characters are specified in the acs_chars (acsc)
+       string capability, and the characters in it may appear on the screen if
+       the terminal type's database entry incorrectly advertises ACS  support.
+       The name "ACS" originates in the Alternate Character Set feature of the
+       DEC VT100 terminal.
+
+                       Unicode   ACS       acsc
+       Symbol          Default   Default   char   Glyph Name
        ------------------------------------------------------------------------
        WACS_BLOCK      0x25ae    #         0      solid square block
        WACS_BOARD      0x2592    #         h      board of squares
@@ -179,7 +209,6 @@
        WACS_D_LTEE       0x2560    +         F      double tee pointing right
        WACS_D_PLUS       0x256c    +         E      double large plus
        WACS_D_RTEE       0x2563    +         G      double tee pointing left
-
        WACS_D_TTEE       0x2566    +         I      double tee pointing down
        WACS_D_ULCORNER   0x2554    +         C      double upper left corner
        WACS_D_URCORNER   0x2557    +         B      double upper right corner
@@ -198,124 +227,122 @@

RETURN VALUE

-       All routines return the integer ERR upon failure and OK on success.
+       These functions return OK on success and ERR on failure.   In  ncurses,
+       wadd_wch returns ERR if
 
-       X/Open  Curses  does  not   specify   any   error   conditions.    This
-       implementation returns an error
+       o   win is NULL,
 
-       o   if the window pointer is null or
+       o   wrapping  to  a new line is impossible because scrollok(3x) has not
+           been called on win when writing to its  bottom  right  location  is
+           attempted, or
 
-       o   if it is not possible to add a complete character in the window.
+       o   it  is  not  possible  to  add  a  complete character at the cursor
+           position.
 
-       The latter may be due to different causes:
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
 
-       o   If  scrollok(3x)  is  not enabled, writing a character at the lower
-           right margin succeeds.  However, an error is returned because it is
-           not possible to wrap to a new line.
 
-       o   If  an error is detected when converting a multibyte character to a
-           sequence of bytes, or if it is not  possible  to  add  all  of  the
-           resulting bytes in the window, an error is returned.
+

NOTES

+       add_wch,  mvadd_wch,  mvwadd_wch,  and echo_wchar may be implemented as
+       macros.
 
-       Functions  prefixed with "mv" first perform cursor movement and fail if
-       the position (y, x) is outside the window boundaries.
 
+

EXTENSIONS

 
-

NOTES

-       Note that add_wch, mvadd_wch, mvwadd_wch, and echo_wchar may be macros.
+

TABSIZE

+       The TABSIZE variable is implemented  in  SVr4  and  other  versions  of
+       curses, but is not specified by X/Open Curses (see curs_variables(3x)).

PORTABILITY

-       These functions are described in X/Open Curses, Issue 4.  The  defaults
-       specified for line-drawing characters apply in the POSIX locale.
+       These  functions are described in X/Open Curses, Issue 4.  It specifies
+       no error conditions for them.
 
+       SVr4 curses describes a successful return value  only  as  "an  integer
+       value other than ERR".
 
-

WACS Symbols

-       X/Open  Curses  makes it clear that the WACS_ symbols should be defined
-       as a pointer to cchar_t data, e.g., in the discussion of border_set.  A
-       few implementations are problematic:
+       The  defaults specified for forms-drawing characters apply in the POSIX
+       locale.  X/Open Curses makes it clear that the WACS_ symbols should  be
+       defined  as  a  pointer  to  cchar_t  data,  e.g., in the discussion of
+       border_set.  A few implementations are problematic:
 
        o   NetBSD curses defines the symbols as a wchar_t within a cchar_t.
 
-       o   HP-UX  curses  equates  some  of  the ACS_ symbols to the analogous
-           WACS_ symbols as if the ACS_ symbols  were  wide  characters.   The
-           misdefined  symbols  are the arrows and other symbols which are not
+       o   HP-UX curses equates some of the  ACS_  symbols  to  the  analogous
+           WACS_  symbols  as  if  the ACS_ symbols were wide characters.  The
+           misdefined symbols are the arrows and other symbols which  are  not
            used for line-drawing.
 
-       X/Open Curses does not specify  symbols  for  thick-  or  double-lines.
+       X/Open  Curses  does  not  specify  symbols for thick- or double-lines.
        SVr4 curses implementations defined their line-drawing symbols in terms
-       of intermediate symbols.  This implementation  extends  those  symbols,
+       of  intermediate  symbols.   This implementation extends those symbols,
        providing new definitions which are not in the SVr4 implementations.
 
-       Not  all  Unicode-capable  terminals  provide  support  for VT100-style
-       alternate character  sets  (i.e.,  the  acsc  capability),  with  their
-       corresponding  line-drawing  characters.  X/Open Curses did not address
-       the  aspect  of  integrating  Unicode  with  line-drawing   characters.
-       Existing  implementations of Unix curses (AIX, HP-UX, Solaris) use only
+       Not all  Unicode-capable  terminals  provide  support  for  VT100-style
+       alternate  character  sets  (i.e.,  the  acsc  capability),  with their
+       corresponding line-drawing characters.  X/Open Curses did  not  address
+       the   aspect  of  integrating  Unicode  with  line-drawing  characters.
+       Existing implementations of Unix curses (AIX, HP-UX, Solaris) use  only
        the acsc character-mapping to provide this feature.  As a result, those
        implementations  can  only  use  single-byte  line-drawing  characters.
-       ncurses 5.3 (2002) provided a table of Unicode values  to  solve  these
+       ncurses  5.3  (2002)  provided a table of Unicode values to solve these
        problems.  NetBSD curses incorporated that table in 2010.
 
-       In  this  implementation,  the  Unicode  values are used instead of the
+       In this implementation, the Unicode values  are  used  instead  of  the
        terminal description's acsc mapping as discussed in ncurses(3x) for the
-       environment  variable  NCURSES_NO_UTF8_ACS.   In contrast, for the same
+       environment variable NCURSES_NO_UTF8_ACS.  In contrast,  for  the  same
        cases, the line-drawing characters described in addch(3x) will use only
        the ASCII default values.
 
-       Having  Unicode available does not solve all of the problems with line-
+       Having Unicode available does not solve all of the problems with  line-
        drawing for curses:
 
-       o   The closest Unicode equivalents to the VT100 graphics  S1,  S3,  S7
-           and  S9 frequently are not displayed at the regular intervals which
+       o   The  closest  Unicode  equivalents to the VT100 graphics S1, S3, S7
+           and S9 frequently are not displayed at the regular intervals  which
            the terminal used.
 
-       o   The lantern is a special case.  It originated with  the  AT&T  4410
-           terminal  in the early 1980s.  There is no accessible documentation
+       o   The  lantern  is  a special case.  It originated with the AT&T 4410
+           terminal in the early 1980s.  There is no accessible  documentation
            depicting the lantern symbol on the AT&T terminal.
 
            Lacking documentation, most readers assume that a storm lantern was
            intended.  But there are several possibilities, all with problems.
 
-           Unicode  6.0  (2010)  does provide two lantern symbols: U+1F383 and
-           U+1F3EE.  Those were not available  in  2002,  and  are  irrelevant
-           since  they  lie  outside the BMP and as a result are not generally
+           Unicode 6.0 (2010) does provide two lantern  symbols:  U+1F383  and
+           U+1F3EE.   Those  were  not  available  in 2002, and are irrelevant
+           since they lie outside the BMP and as a result  are  not  generally
            available in terminals.  They are not storm lanterns, in any case.
 
            Most storm lanterns have a tapering glass chimney (to guard against
            tipping); some have a wire grid protecting the chimney.
 
-           For  the  tapering  appearance,   U+2603 was adequate.  In use on a
+           For the tapering appearance,  U+2603 was adequate.   In  use  on  a
            terminal, no one can tell what the image represents.  Unicode calls
            it a snowman.
 
            Others have suggested these alternatives: <section> U+00A7 (section
-           mark), <Theta> U+0398 (theta), <Phi> U+03A6 (phi),  <delta>  U+03B4
+           mark),  <Theta>  U+0398 (theta), <Phi> U+03A6 (phi), <delta> U+03B4
            (delta),  U+2327 (x in a rectangle),  U+256C (forms double vertical
            and horizontal), and  U+2612 (ballot box with x).

Complex Characters

-       The complex character  type  cchar_t  can  store  more  than  one  wide
-       character  (wchar_t).   The  X/Open Curses description does not mention
-       this possibility, describing only the cases  where  wch  is  a  spacing
-       character or a non-spacing character.
+       The  complex  character  type  cchar_t  can  store  more  than one wide
+       character (wchar_t).  X/Open Curses does not mention this  possibility,
+       specifying  behavior  only  where  wch  is  a  single character, either
+       spacing or non-spacing.
 
-       This implementation assumes that wch is constructed using setcchar(3x),
-       and in turn that the result
+       ncurses assumes that wch is constructed using setcchar(3x), and in turn
+       that the result
 
-       o   contains at most one spacing character in the beginning of its list
-           of wide characters, and zero or more non-spacing characters or
+       o   contains at most one spacing character at the beginning of its list
+           of wide characters, and zero or more non-spacing characters, or
 
-       o   may hold one non-spacing character.
+       o   holds one non-spacing character.
 
-       In  the  latter  case,  ncurses  adds  the non-spacing character to the
-       active (base) spacing character.
-
-
-

TABSIZE

-       The TABSIZE variable is implemented  in  SVr4  and  other  versions  of
-       curses, but is not specified by X/Open Curses (see curs_variables(3x)).
+       In the latter case, ncurses  adds  the  non-spacing  character  to  the
+       active complex character.

SEE ALSO

@@ -328,7 +355,7 @@
 
 
 
-ncurses 6.5                       2024-04-20                  curs_add_wch(3x)
+ncurses 6.5                       2024-05-11                  curs_add_wch(3x)