curs_add_wch 3x 2024-04-13 ncurses 6.4 Library calls

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

curs_add_wch 3x 2024-04-13 ncurses 6.4 Library calls

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

 curs_add_wch(3x)                 Library calls                curs_add_wch(3x)
 
@@ -217,9 +217,8 @@
            sequence of bytes, or if it is not  possible  to  add  all  of  the
            resulting bytes in the window, an error is returned.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -227,9 +226,8 @@

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.  The
-       defaults specified for  line-drawing  characters  apply  in  the  POSIX
-       locale.
+       These functions are described in X/Open Curses, Issue 4.  The  defaults
+       specified for line-drawing characters apply in the POSIX locale.

WACS Symbols

@@ -330,7 +328,7 @@
 
 
 
-ncurses 6.4                       2024-04-13                  curs_add_wch(3x)
+ncurses 6.4                       2024-04-20                  curs_add_wch(3x)

curs_add_wchstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_add_wchstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_add_wchstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_add_wchstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_add_wchstr(3x)              Library calls             curs_add_wchstr(3x)
 
@@ -104,9 +104,8 @@
 
        o   if the wchstr parameter is null.
 
-       Functions with a "mv" prefix first  perform  a  cursor  movement  using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -114,7 +113,7 @@

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       These functions are described in X/Open Curses, Issue 4.

curs_addch 3x 2024-04-13 ncurses 6.4 Library calls

curs_addch 3x 2024-04-20 ncurses 6.4 Library calls

 curs_addch(3x)                   Library calls                  curs_addch(3x)
 
@@ -183,9 +183,8 @@
        enabled  in  that  event,  because  it is not possible to wrap to a new
        line.
 
-       Functions with a  "mv"  prefix  first  perform  cursor  movement  using
-       wmove(3x) and fail if the position is outside the window, or (for "mvw"
-       functions) if the WINDOW pointer is null.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -193,9 +192,14 @@

PORTABILITY

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

ACS Symbols

@@ -296,7 +300,7 @@
 
 
 
-ncurses 6.4                       2024-04-13                    curs_addch(3x)
+ncurses 6.4                       2024-04-20                    curs_addch(3x)

curs_addchstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_addchstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_addchstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_addchstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_addchstr(3x)                Library calls               curs_addchstr(3x)
 
@@ -97,9 +97,8 @@
 
        o   if the wchstr parameter is null.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -107,7 +106,7 @@

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       These functions are described in X/Open Curses, Issue 4.

curs_addstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_addstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_addstr(3x)                  Library calls                 curs_addstr(3x)
 
@@ -89,9 +89,8 @@
 
        o   if an internal waddch(3x) call returns an error.
 
-       Functions  with  a  "mv"  prefix  first  perform  cursor movement using
-       wmove(3x) and fail if the position is outside the window, or (for "mvw"
-       functions) if the WINDOW pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -103,14 +102,14 @@

curs_addwstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_addwstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_addwstr(3x)                 Library calls                curs_addwstr(3x)
 
@@ -96,9 +96,8 @@
 
        o   if an internal wadd_wch(3x) call returns an error.
 
-       Functions with a  "mv"  prefix  first  perform  cursor  movement  using
-       wmove(3x) and fail if the position is outside the window, or (for "mvw"
-       functions) if the WINDOW pointer is null.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -110,14 +109,14 @@

curs_attr 3x 2024-03-16 ncurses 6.4 Library calls

curs_attr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_attr(3x)                    Library calls                   curs_attr(3x)
 
@@ -253,74 +253,73 @@
        o   does  not  return an error if either of the parameters of wattr_get
            used for retrieving attribute or color pair values is NULL.
 
-       Functions with a "mv" prefix first  perform  a  cursor  movement  using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x)

NOTES

        These functions may be macros:
 
-              attroff, wattroff, attron, wattron, attrset, wattrset,  standend
+              attroff,  wattroff, attron, wattron, attrset, wattrset, standend
               and standout.
 
-       Color  pair  values can only be OR'd with attributes if the pair number
+       Color pair values can only be OR'd with attributes if the  pair  number
        is less than 256.  The alternate functions such as color_set can pass a
        color pair value directly.  However, ncurses ABI 4 and 5 simply OR this
-       value within the alternate functions.  You must use ncurses  ABI  6  to
+       value  within  the  alternate functions.  You must use ncurses ABI 6 to
        support more than 256 color pairs.

EXTENSIONS

        This implementation provides the A_ITALIC attribute for terminals which
-       have  the  enter_italics_mode  (sitm)  and   exit_italics_mode   (ritm)
-       capabilities.   Italics are not mentioned in X/Open Curses.  Unlike the
-       other video attributes, A_ITALIC is  unrelated  to  the  set_attributes
-       capabilities.    This   implementation   makes   the   assumption  that
+       have   the   enter_italics_mode  (sitm)  and  exit_italics_mode  (ritm)
+       capabilities.  Italics are not mentioned in X/Open Curses.  Unlike  the
+       other  video  attributes,  A_ITALIC  is unrelated to the set_attributes
+       capabilities.   This   implementation   makes   the   assumption   that
        exit_attribute_mode may also reset italics.
 
-       Each of the functions added by XSI Curses has a parameter  opts,  which
-       X/Open  Curses  still  (after  more  than  twenty  years)  documents as
+       Each  of  the functions added by XSI Curses has a parameter opts, which
+       X/Open Curses  still  (after  more  than  twenty  years)  documents  as
        reserved  for  future  use,  saying  that  it  should  be  NULL.   This
-       implementation  uses  that  parameter  in ABI 6 for the functions which
+       implementation uses that parameter in ABI 6  for  the  functions  which
        have a color pair parameter to support extended color pairs:
 
        o   For functions which modify the color, e.g., wattr_set and wattr_on,
-           if  opts  is set it is treated as a pointer to int, and used to set
+           if opts is set it is treated as a pointer to int, and used  to  set
            the color pair instead of the short pair parameter.
 
        o   For functions which retrieve the color, e.g., wattr_get, if opts is
-           set  it  is  treated  as a pointer to int, and used to retrieve the
-           color pair as an int value, in addition to retrieving  it  via  the
+           set it is treated as a pointer to int, and  used  to  retrieve  the
+           color  pair  as  an int value, in addition to retrieving it via the
            standard pointer to short parameter.
 
-       o   For  functions which turn attributes off, e.g., wattr_off, the opts
+       o   For functions which turn attributes off, e.g., wattr_off, the  opts
            parameter is ignored except except to check that it is NULL.

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.  The
-       standard  defined  the dedicated type for highlights, attr_t, which was
-       not defined in SVr4 curses.  The functions taking attr_t arguments were
-       not supported under SVr4.
+       These  functions are described in X/Open Curses, Issue 4.  The standard
+       defined the dedicated  type  for  highlights,  attr_t,  which  was  not
+       defined in SVr4 curses.  The functions taking attr_t arguments were not
+       supported under SVr4.
 
        Very old versions of this library did not force an update of the screen
-       when changing the attributes.  Use touchwin  to  force  the  screen  to
+       when  changing  the  attributes.   Use  touchwin to force the screen to
        match the updated attributes.
 
-       The  XSI  Curses standard states that whether the traditional functions
-       attron/attroff/attrset can manipulate attributes  other  than  A_BLINK,
-       A_BOLD,  A_DIM, A_REVERSE, A_STANDOUT, or A_UNDERLINE is "unspecified".
-       Under this implementation as  well  as  SVr4  curses,  these  functions
-       correctly  manipulate all other highlights (specifically, A_ALTCHARSET,
+       X/Open  Curses  states   that   whether   the   traditional   functions
+       attron/attroff/attrset  can  manipulate  attributes other than A_BLINK,
+       A_BOLD, A_DIM, A_REVERSE, A_STANDOUT, or A_UNDERLINE is  "unspecified".
+       Under  this  implementation  as  well  as  SVr4 curses, these functions
+       correctly manipulate all other highlights (specifically,  A_ALTCHARSET,
        A_PROTECT, and A_INVIS).
 
-       XSI Curses added these entry points:
+       X/Open Curses added these entry points:
 
               attr_get,  attr_on,  attr_off,  attr_set,  wattr_on,  wattr_off,
               wattr_get, wattr_set
 
-       The  new  functions are intended to work with a new series of highlight
+       The new functions are intended to work with a new series  of  highlight
        macros prefixed with WA_.  The older macros have direct counterparts in
        the newer set of names:
 
@@ -336,11 +335,12 @@
 
               WA_ALTCHARSET   Alternate character set
 
-       XSI  curses  does not assign values to these symbols, nor does it state
-       whether or not they are related to the similarly-named A_NORMAL, etc.:
+       X/Open Curses does not assign values to  these  symbols,  nor  does  it
+       state  whether or not they are related to the similarly-named A_NORMAL,
+       etc.:
 
-       o   The XSI curses standard specifies that each pair  of  corresponding
-           A_  and  WA_-using functions operates on the same current-highlight
+       o   X/Open Curses specifies that each  pair  of  corresponding  A_  and
+           WA_-using   functions   operates   on  the  same  current-highlight
            information.
 
        o   However, in some  implementations,  those  symbols  have  unrelated
@@ -364,7 +364,7 @@
            This is consistent with SVr4 curses; X/Open Curses does not specify
            this.
 
-       The  XSI  standard  extended  conformance  level  adds  new  highlights
+       The  X/Open  Curses  extended  conformance  level  adds  new highlights
        A_HORIZONTAL,  A_LEFT,   A_LOW,   A_RIGHT,   A_TOP,   A_VERTICAL   (and
        corresponding  WA_  macros  for  each).   As  of  August 2013, no known
        terminal provides these highlights (i.e., via the sgr1 capability).
@@ -497,7 +497,7 @@
 
 
 
-ncurses 6.4                       2024-03-16                     curs_attr(3x)
+ncurses 6.4                       2024-04-20                     curs_attr(3x)

curs_beep 3x 2024-03-16 ncurses 6.4 Library calls

curs_beep 3x 2024-04-20 ncurses 6.4 Library calls

curs_beep 3x 2024-03-16 ncurses 6.4 Library calls

curs_beep 3x 2024-04-20 ncurses 6.4 Library calls

 curs_beep(3x)                    Library calls                   curs_beep(3x)
 
@@ -77,8 +77,8 @@

PORTABILITY

-       These functions are described in the  XSI  Curses  standard,  Issue  4.
-       Like SVr4, it specifies that they always return OK.
+       These functions are described in X/Open Curses, Issue 4.  Like SVr4, it
+       specifies that they always return OK.

curs_bkgd 3x 2024-03-23 ncurses 6.4 Library calls

curs_bkgd 3x 2024-04-20 ncurses 6.4 Library calls

 curs_bkgd(3x)                    Library calls                   curs_bkgd(3x)
 
@@ -163,7 +163,7 @@

PORTABILITY

-       X/Open  Curses,  Issue 4, describes these functions.  It specifies that
+       X/Open  Curses,  Issue  4 describes these functions.  It specifies that
        bkgd, wbkgd, and getbkgd return ERR on failure  (in  the  case  of  the
        last,  this  value  is  cast  to  chtype),  but  describes  no  failure
        conditions.
@@ -189,7 +189,7 @@
 
 
 
-ncurses 6.4                       2024-03-23                     curs_bkgd(3x)
+ncurses 6.4                       2024-04-20                     curs_bkgd(3x)

curs_bkgrnd 3x 2024-03-23 ncurses 6.4 Library calls

curs_bkgrnd 3x 2024-04-20 ncurses 6.4 Library calls

curs_bkgrnd 3x 2024-03-23 ncurses 6.4 Library calls

curs_bkgrnd 3x 2024-04-20 ncurses 6.4 Library calls

 curs_bkgrnd(3x)                  Library calls                 curs_bkgrnd(3x)
 
@@ -162,7 +162,7 @@

PORTABILITY

-       X/Open  Curses,  Issue  4,  describes these functions.  It specifies no
+       X/Open  Curses,  Issue  4  describes  these functions.  It specifies no
        error conditions for them.
 
        X/Open Curses does not provide details of how the rendition is updated.
@@ -177,7 +177,7 @@
 
 
 
-ncurses 6.4                       2024-03-23                   curs_bkgrnd(3x)
+ncurses 6.4                       2024-04-20                   curs_bkgrnd(3x)

curs_border 3x 2024-03-16 ncurses 6.4 Library calls

curs_border 3x 2024-04-20 ncurses 6.4 Library calls

curs_border 3x 2024-03-16 ncurses 6.4 Library calls

curs_border 3x 2024-04-20 ncurses 6.4 Library calls

 curs_border(3x)                  Library calls                 curs_border(3x)
 
@@ -121,20 +121,19 @@
        X/Open  Curses  does  not   specify   any   error   conditions.    This
        implementation returns an error if the window pointer is null.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

-       The  borders  generated  by these functions are inside borders (this is
+       The borders generated by these functions are inside  borders  (this  is
        also true of SVr4 curses, though the fact is not documented).
 
        Note that border and box may be macros.

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       These functions are described in X/Open Curses, Issue 4.

curs_border_set 3x 2024-03-16 ncurses 6.4 Library calls

curs_border_set 3x 2024-04-20 ncurses 6.4 Library calls

 curs_border_set(3x)              Library calls             curs_border_set(3x)
 
@@ -146,18 +146,17 @@
 
        Functions using a window parameter return an error if it is null.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

-       Note    that    border_set,    hline_set,   mvhline_set,   mvvline_set,
+       Note   that   border_set,    hline_set,    mvhline_set,    mvvline_set,
        mvwhline_set, mvwvline_set, and vline_set may be macros.

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       These functions are described in X/Open Curses, Issue 4.

curs_clear 3x 2024-03-16 ncurses 6.4 Library calls

curs_clear 3x 2024-04-20 ncurses 6.4 Library calls

 curs_clear(3x)                   Library calls                  curs_clear(3x)
 
@@ -112,7 +112,7 @@

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       These functions are described in X/Open Curses, Issue 4.
 
        The SVr4.0 manual says that these functions could  return  "or  a  non-
        negative  integer  if immedok is set", referring to the return-value of
@@ -138,7 +138,7 @@
 
 
 
-ncurses 6.4                       2024-03-16                    curs_clear(3x)
+ncurses 6.4                       2024-04-20                    curs_clear(3x)

curs_color 3x 2024-03-16 ncurses 6.4 Library calls

curs_color 3x 2024-04-20 ncurses 6.4 Library calls

curs_color 3x 2024-03-16 ncurses 6.4 Library calls

curs_color 3x 2024-04-20 ncurses 6.4 Library calls

 curs_color(3x)                   Library calls                  curs_color(3x)
 
@@ -463,8 +463,8 @@
        Applications employing ncurses extensions should condition their use on
        the visibility of the NCURSES_VERSION preprocessor macro.
 
-       This  implementation satisfies XSI Curses's minimum maximums for COLORS
-       and COLOR_PAIRS.
+       This  implementation  satisfies  X/Open  Curses's  minimum maximums for
+       COLORS and COLOR_PAIRS.
 
        The  init_pair  routine  accepts  negative  values  of  foreground  and
        background  color  to support the use_default_colors(3x) extension, but
@@ -539,7 +539,7 @@
 
 
 
-ncurses 6.4                       2024-03-16                    curs_color(3x)
+ncurses 6.4                       2024-04-20                    curs_color(3x)

curs_delch 3x 2024-03-16 ncurses 6.4 Library calls

curs_delch 3x 2024-04-20 ncurses 6.4 Library calls

curs_delch 3x 2024-03-16 ncurses 6.4 Library calls

curs_delch 3x 2024-04-20 ncurses 6.4 Library calls

 curs_delch(3x)                   Library calls                  curs_delch(3x)
 
@@ -47,8 +47,8 @@

NAME

-       delch,  wdelch,  mvdelch, mvwdelch - delete the character at the cursor
-       in a curses window
+       delch,  wdelch,  mvdelch,  mvwdelch  - delete a character from a curses
+       window

SYNOPSIS

@@ -61,32 +61,37 @@

DESCRIPTION

-       These routines delete the character under the cursor; all characters to
-       the  right  of  the  cursor  on the same line are moved to the left one
-       position and the last character on the line is  filled  with  a  blank.
-       The  cursor  position  does  not  change  (after  moving  to  y,  x, if
-       specified).  (This does not imply use of the hardware delete  character
-       feature.)
+       wdelch  deletes  the  character  at  the  cursor   position   in   win.
+       ncurses(3x) describes the variants of this function.
+
+       wdelch moves all characters to the right of the cursor on the same line
+       to the left one position and replaces the  contents  of  the  rightmost
+       position  on  the  line with the window's blank character; see bkgd(3x)
+       (wide-character API users may consult bkgrnd(3x) instead).  The  cursor
+       position does not change (after moving to (y, x), if specified).

RETURN VALUE

-       All  routines  return  the  integer  ERR  upon  failure and an OK (SVr4
-       specifies only "an integer  value  other  than  ERR")  upon  successful
-       completion.
+       These functions return OK on success and ERR on failure.
+
+       Functions taking a WINDOW pointer argument fail if the pointer is NULL.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

-       Note that delch, mvdelch, and mvwdelch may be macros.
+       delch, mvdelch, and mvwdelch may be implemented as macros.
+
+       A terminal's delete_character  (dch1)  capability  is  not  necessarily
+       employed.

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.  The
-       standard specifies that they return ERR on failure,  but  specifies  no
-       error conditions.
+       X/Open Curses, Issue 4 describes these functions.
+
+       SVr4  curses  describes  a  successful return value only as "an integer
+       value other than ERR".

curs_deleteln 3x 2024-03-16 ncurses 6.4 Library calls

curs_deleteln 3x 2024-04-20 ncurses 6.4 Library calls

 curs_deleteln(3x)                Library calls               curs_deleteln(3x)
 
@@ -99,9 +99,9 @@

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.  The
-       standard  specifies  that  they return ERR on failure, but specifies no
-       error conditions.
+       These functions are described in X/Open Curses, Issue 4.  The  standard
+       specifies  that  they  return  ERR  on  failure, but specifies no error
+       conditions.

curs_get_wch 3x 2024-04-13 ncurses 6.4 Library calls

curs_get_wch 3x 2024-04-20 ncurses 6.4 Library calls

 curs_get_wch(3x)                 Library calls                curs_get_wch(3x)
 
@@ -59,7 +59,7 @@
        int mvget_wch(int y, int x, wint_t *wch);
        int mvwget_wch(WINDOW *win, int y, int x, wint_t *wch);
 
-       int unget_wch(const wchar_t wch);
+       int unget_wch(const wchar_t wc);

DESCRIPTION

@@ -119,9 +119,8 @@
        o   execution  was  interrupted by a signal, in which case errno is set
            to EINTR.
 
-       Functions with a  "mv"  prefix  first  perform  cursor  movement  using
-       wmove(3x) and fail if the position is outside the window, or (for "mvw"
-       functions) if the win parameter is a null pointer.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
 
        unget_wch returns OK on success and ERR if there is no more room in the
        input queue.
@@ -133,14 +132,14 @@
        All of these functions except wget_wch and unget_wch may be implemented
        as macros.
 
-       Unlike wgetch(3x), wget_wch and its variants store  the  value  of  the
-       input  character  in  an additional wch parameter instead of the return
+       Unlike  wgetch(3x),  wget_wch  and  its variants store the value of the
+       input character in an additional wch parameter instead  of  the  return
        value.
 
-       Unlike  ungetch,  unget_wch  cannot  distinguish  function  key   codes
-       wget_wch   from  conventional  character  codes.   An  application  can
+       Unlike   ungetch,  unget_wch  cannot  distinguish  function  key  codes
+       wget_wch  from  conventional  character  codes.   An  application   can
        overcome this limitation by pushing function key codes with ungetch and
-       subsequently  checking  the  return  value of wget_wch for a match with
+       subsequently checking the return value of wget_wch  for  a  match  with
        KEY_CODE_YES.
 
 
@@ -152,10 +151,10 @@
        Applications employing ncurses extensions should condition their use on
        the visibility of the NCURSES_VERSION preprocessor macro.
 
-       X/Open  Curses,  Issue  4,  describes these functions.  It specifies no
+       X/Open Curses, Issue 4 describes  these  functions.   It  specifies  no
        error conditions for them.
 
-       See the "PORTABILITY" section of wgetch(3x) regarding  the  interaction
+       See  the  "PORTABILITY" section of wgetch(3x) regarding the interaction
        of wget_wch with signal handlers.
 
 
@@ -163,12 +162,12 @@
        curs_getch(3x) describes comparable functions of the ncurses library in
        its non-wide-character configuration.
 
-       curses(3x),    curs_add_wch(3x),    curs_inopts(3x),     curs_move(3x),
+       curses(3x),     curs_add_wch(3x),    curs_inopts(3x),    curs_move(3x),
        curs_refresh(3x)
 
 
 
-ncurses 6.4                       2024-04-13                  curs_get_wch(3x)
+ncurses 6.4                       2024-04-20                  curs_get_wch(3x)

curs_get_wstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_get_wstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_get_wstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_get_wstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_get_wstr(3x)                Library calls               curs_get_wstr(3x)
 
@@ -125,20 +125,19 @@
 
        o   if the associated call to wget_wch failed.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

        Any of these functions other than wgetn_wstr may be macros.
 
-       Using  get_wstr,  mvget_wstr,  mvwget_wstr, or wget_wstr to read a line
-       that overflows the array pointed to by wstr causes  undefined  results.
-       The   use  of  getn_wstr,  mvgetn_wstr,  mvwgetn_wstr,  or  wgetn_wstr,
+       Using get_wstr, mvget_wstr, mvwget_wstr, or wget_wstr to  read  a  line
+       that  overflows  the array pointed to by wstr causes undefined results.
+       The  use  of  getn_wstr,  mvgetn_wstr,  mvwgetn_wstr,  or   wgetn_wstr,
        respectively, is recommended.
 
-       These functions cannot return KEY_ values because there is  no  way  to
+       These  functions  cannot  return KEY_ values because there is no way to
        distinguish a KEY_ value from a valid wchar_t value.
 
 
@@ -146,51 +145,51 @@
        These functions are described in The Single Unix Specification, Version
        2.  No error conditions are defined.
 
-       This implementation returns ERR if the window pointer is  null,  or  if
-       the  lower-level  wget_wch call returns an ERR.  In the latter case, an
-       ERR return without other data is treated as an  end-of-file  condition,
+       This  implementation  returns  ERR if the window pointer is null, or if
+       the lower-level wget_wch call returns an ERR.  In the latter  case,  an
+       ERR  return  without other data is treated as an end-of-file condition,
        and the returned array contains a WEOF followed by a null wchar_t.
 
        X/Open curses documented these functions to pass an array of wchar_t in
        1997, but that was an error because of this part of the description:
 
               The effect of get_wstr is as though a series of calls to get_wch
-              were  made, until a newline character, end-of-line character, or
+              were made, until a newline character, end-of-line character,  or
               end-of-file character is processed.
 
-       The latter function get_wch can return a negative value, while  wchar_t
-       is  a  unsigned  type.  All of the vendors implement this using wint_t,
+       The  latter function get_wch can return a negative value, while wchar_t
+       is a unsigned type.  All of the vendors implement  this  using  wint_t,
        following the standard.
 
        X/Open  Curses,  Issue  7  (2009)  is  unclear  regarding  whether  the
-       terminating  null  wchar_t  value is counted in the length parameter n.
+       terminating null wchar_t value is counted in the  length  parameter  n.
        X/Open  Curses,  Issue  7  revised  the  corresponding  description  of
-       wgetnstr   to   address  this  issue.   The  unrevised  description  of
-       wget_nwstr can be interpreted either way.  This  implementation  counts
+       wgetnstr  to  address  this  issue.   The  unrevised   description   of
+       wget_nwstr  can  be interpreted either way.  This implementation counts
        the terminator in the length.
 
-       X/Open  Curses  does  not  specify  what  happens  if  the  length n is
+       X/Open Curses does  not  specify  what  happens  if  the  length  n  is
        negative.
 
-       o   For analogy with wgetnstr, ncurses  6.2  uses  a  limit  (based  on
+       o   For  analogy  with  wgetnstr,  ncurses  6.2  uses a limit (based on
            LINE_MAX).
 
-       o   Some  other  implementations (such as Solaris xcurses) do the same,
+       o   Some other implementations (such as Solaris xcurses) do  the  same,
            while others (PDCurses) do not allow this.
 
-       o   NetBSD 7 curses imitates ncurses 6.1 in this regard, treating a  -1
+       o   NetBSD  7 curses imitates ncurses 6.1 in this regard, treating a -1
            as an indefinite number of characters.

curs_getcchar 3x 2024-04-13 ncurses 6.4 Library calls

curs_getcchar 3x 2024-04-20 ncurses 6.4 Library calls

 curs_getcchar(3x)                Library calls               curs_getcchar(3x)
 
@@ -55,15 +55,15 @@
        #include <curses.h>
 
        int getcchar(
-               const cchar_t *wcval,
-               wchar_t *wch,
+               const cchar_t *wch,
+               wchar_t *wc,
                attr_t *attrs,
                short *color_pair,
                void *opts );
 
        int setcchar(
-               cchar_t *wcval,
-               const wchar_t *wch,
+               cchar_t *wch,
+               const wchar_t *wc,
                const attr_t attrs,
                short color_pair,
                const void *opts );
@@ -73,34 +73,34 @@

getcchar

        The getcchar function gets a wide-character string and rendition from a
-       cchar_t  argument.   When  wch  is  not  a  null  pointer, the getcchar
-       function does the following:
+       cchar_t argument.  When wc is not a null pointer, the getcchar function
+       does the following:
 
-       o   Extracts information from a cchar_t value wcval
+       o   Extracts information from a cchar_t value wch
 
        o   Stores the character attributes in the location pointed to by attrs
 
        o   Stores the color pair in the location pointed to by color_pair
 
-       o   Stores the wide-character string, characters referenced  by  wcval,
-           into the array pointed to by wch.
+       o   Stores the wide-character string,  characters  referenced  by  wch,
+           into the array pointed to by wc.
 
-       When wch is a null pointer, the getcchar function does the following:
+       When wc is a null pointer, the getcchar function does the following:
 
-       o   Obtains the number of wide characters pointed to by wcval
+       o   Obtains the number of wide characters pointed to by wch
 
        o   Does not change the data referenced by attrs or color_pair

setcchar

-       The  setcchar  function initializes the location pointed to by wcval by
+       The  setcchar  function  initializes  the location pointed to by wch by
        using:
 
        o   The character attributes in attrs
 
        o   The color pair in color_pair
 
-       o   The wide-character string pointed to by wch.  The  string  must  be
+       o   The wide-character string pointed to by wc.   The  string  must  be
            L'\0' terminated, contain at most one spacing character, which must
            be the first.
 
@@ -112,10 +112,10 @@

RETURN VALUE

-       When wch is a  null  pointer,  getcchar  returns  the  number  of  wide
-       characters referenced by wcval, including one for a trailing null.
+       When wc is  a  null  pointer,  getcchar  returns  the  number  of  wide
+       characters referenced by wch, including one for a trailing null.
 
-       When  wch  is  not  a null pointer, getcchar returns OK upon successful
+       When  wc  is  not  a  null pointer, getcchar returns OK upon successful
        completion, and ERR otherwise.
 
        Upon successful completion, setcchar returns OK.  Otherwise, it returns
@@ -123,9 +123,9 @@

NOTES

-       The wcval argument may be a value generated by a call to setcchar or by
-       a function that has a cchar_t output argument.  If wcval is constructed
-       by any other means, the effect is unspecified.
+       The wch argument may be a value generated by a call to setcchar or by a
+       function that has a cchar_t output argument.  If wch is constructed  by
+       any other means, the effect is unspecified.

EXTENSIONS

@@ -196,7 +196,7 @@
 
 
 
-ncurses 6.4                       2024-04-13                 curs_getcchar(3x)
+ncurses 6.4                       2024-04-20                 curs_getcchar(3x)

curs_getch 3x 2024-04-13 ncurses 6.4 Library calls

curs_getch 3x 2024-04-20 ncurses 6.4 Library calls

curs_getch 3x 2024-04-13 ncurses 6.4 Library calls

curs_getch 3x 2024-04-20 ncurses 6.4 Library calls

 curs_getch(3x)                   Library calls                  curs_getch(3x)
 
@@ -60,10 +60,10 @@
        int mvgetch(int y, int x);
        int mvwgetch(WINDOW *win, int y, int x);
 
-       int ungetch(int ch);
+       int ungetch(int c);
 
        /* extension */
-       int has_key(int ch);
+       int has_key(int c);

DESCRIPTION

@@ -89,22 +89,22 @@
        elapses.
 
        If echo(3x) has been called, and the window is not a pad, curses writes
-       the returned character ch to the window (at the  cursor  position)  per
-       the following rules.
+       the returned character c to the window (at the cursor position) per the
+       following rules.
 
-       o   If  ch  matches  the  terminal's  erase character, the cursor moves
+       o   If  c  matches  the  terminal's  erase  character, the cursor moves
            leftward one  position  and  the  new  position  is  erased  as  if
            wmove(3x)  and  then  wdelch(3x)  were  called.   When the window's
            keypad mode is enabled (see below), KEY_LEFT and KEY_BACKSPACE  are
            handled the same way.
 
-       o   curses writes any other ch to the window, as with wechochar(3x).
+       o   curses writes any other c to the window, as with wechochar(3x).
 
        o   If  the  window  has  been moved or modified since the last call to
            wrefresh(3x), curses calls wrefresh.
 
-       If ch is a carriage return and nl(3x) has been called,  wgetch  returns
-       the character code for newline (line feed) instead.
+       If c is a carriage return and nl(3x) has been  called,  wgetch  returns
+       the character code for line feed instead.

Keypad Mode

@@ -150,7 +150,7 @@

Ungetting Characters

-       ungetch  places ch into the input queue to be returned by the next call
+       ungetch  places  c into the input queue to be returned by the next call
        to wgetch.  A single input queue serves all windows.
 
 
@@ -164,7 +164,7 @@
            terminal.
 
        o   The  naming  convention  may  seem  obscure,  with  some   apparent
-           misspellings  (such  as "RSUME" for "resume"); The names correspond
+           misspellings  (such  as "RSUME" for "resume"); the names correspond
            to  the  terminfo  capability  names  for  the   keys,   and   were
            standardized  before  the  IBM  PC/AT  keyboard  layout  achieved a
            dominant position in industry.
@@ -267,7 +267,7 @@
               KEY_SSUSPEND    Shifted suspend key
               KEY_SUNDO       Shifted undo key
 
-       The keypad is arranged as follows.
+       Many keyboards feature a nine-key directional pad.
 
                                    +-----+------+-------+
                                    | A1  |  up  |  A3   |
@@ -276,41 +276,43 @@
                                    +-----+------+-------+
                                    | C1  | down |  C3   |
                                    +-----+------+-------+
-       Two of these symbols do not correspond to a real key.
+       Two of the symbols in the list above do not correspond  to  a  physical
+       key.
 
-       o   wgetch returns KEY_RESIZE (even if  the  window's  keypad  mode  is
-           disabled) when ncurses detects the SIGWINCH signal; see initscr(3x)
+       o   wgetch  returns  KEY_RESIZE,  even  if  the window's keypad mode is
+           disabled, when ncurses handles a SIGWINCH signal;  see  initscr(3x)
            and resizeterm(3x).
 
-       o   wgetch returns KEY_MOUSE to indicate that a mouse event is  pending
-           collection;  see  curs_mouse(3x).   Receipt of this code requires a
-           window's keypad mode to be  enabled,  because  to  interpret  mouse
+       o   wgetch  returns KEY_MOUSE to indicate that a mouse event is pending
+           collection; see curs_mouse(3x).  Receipt of this  code  requires  a
+           window's  keypad  mode  to  be  enabled, because to interpret mouse
            input (as with with xterm(1)'s mouse prototocol), ncurses must read
            an escape sequence, as with a function key.

Testing Key Codes

-       In ncurses, has_key takes a key code value from  the  above  list,  and
-       returns  a  Boolean  value indicating the terminal's recognition of it.
-       See also define_key(3x) and key_defined(3x).
+       In  ncurses,  has_key  returns  a  Boolean value indicating whether the
+       terminal type recognizes its parameter as a key code value.   See  also
+       define_key(3x) and key_defined(3x).

RETURN VALUE

-       wgetch returns ERR if
+       Except  for  has_key,  these  functions return OK on success and ERR on
+       failure.
 
-       o   the WINDOW pointer is NULL, or
+       Functions taking a WINDOW pointer argument fail if the pointer is NULL.
+
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
+
+       wgetch also fails if
 
        o   its timeout expires without any data arriving, or
 
-       o   execution was interrupted by a signal, in which case errno  is  set
+       o   execution  was  interrupted by a signal, in which case errno is set
            to EINTR.
 
-       Functions  with  a  "mv"  prefix  first  perform  cursor movement using
-       wmove(3x) and fail if the position is outside the window, or (for "mvw"
-       functions) if the win parameter is a null pointer.
-
-       ungetch  returns  OK on success and ERR if there is no more room in the
-       input queue.
+       ungetch fails if there is no more room in the input queue.
 
        has_key returns TRUE or FALSE.
 
@@ -329,12 +331,12 @@
 
        curses  distinguishes  the  Enter  keys  in  the alphabetic and numeric
        keypad sections of a keyboard because (most) terminals  do.   KEY_ENTER
-       refers  to  the  key  on  the (numeric) keypad and, like other function
-       keys, is reliably recognized  only  if  the  window's  keypad  mode  is
-       enabled.
+       refers  to the key on the numeric keypad and, like other function keys,
+       and is reliably recognized only if the window's keypad mode is enabled.
 
-       o   The  terminfo  key_enter  (kent) capability describes the character
-           (sequence) sent by the terminal's keypad Enter key.
+       o   The terminfo key_enter (kent) capability  describes  the  character
+           (sequence)  sent  by  the  Enter  key  of  a terminal's numeric (or
+           similar) keypad.
 
        o   "Enter or send" is X/Open Curses's description of this key.
 
@@ -355,7 +357,7 @@
        Historically, the list of key code macros above was influenced  by  the
        function-key-rich  keyboard  of  the AT&T 7300 (also known variously as
        the "3B1", "Safari  4",  and  "UNIX  PC"),  a  1985  machine.   Today's
-       computer keyboards are based on the IBM PC/AT keyboard and tend to have
+       computer  keyboards  are  based  that of the IBM PC/AT and tend to have
        fewer.  A curses application can expect such a keyboard to transmit key
        codes   KEY_UP,   KEY_DOWN,  KEY_LEFT,  KEY_RIGHT,  KEY_HOME,  KEY_END,
        KEY_PPAGE (Page Up), KEY_NPAGE (Page  Down),  KEY_IC  (Insert),  KEY_DC
@@ -378,7 +380,7 @@
        Applications employing ncurses extensions should condition their use on
        the visibility of the NCURSES_VERSION preprocessor macro.
 
-       X/Open Curses, Issue 4, describes getch, wgetch, mvgetch, mvwgetch, and
+       X/Open Curses, Issue 4 describes getch, wgetch, mvgetch, mvwgetch,  and
        ungetch.  It specifies no error conditions for them.
 
        wgetch reads only single-byte characters.
@@ -390,8 +392,8 @@
        The   behavior  of  wgetch  in  the  presence  of  signal  handlers  is
        unspecified in the SVr4 documentation and X/Open Curses.  In historical
        curses  implementations,  it  varied depending on whether the operating
-       system's dispatch of a signal to a handler interrupts a read(2) call in
-       progress  or  not,  and also (in some implementations) whether an input
+       system's dispatch of a signal to a handler interrupting a read(2)  call
+       in  progress,  and  also  (in  some  implementations)  whether an input
        timeout or non-blocking mode has been set.  Programmers concerned about
        portability  should  be  prepared  for  either of two cases: (a) signal
        receipt does not interrupt wgetch; or  (b)  signal  receipt  interrupts
@@ -422,7 +424,7 @@
 
 
 
-ncurses 6.4                       2024-04-13                    curs_getch(3x)
+ncurses 6.4                       2024-04-20                    curs_getch(3x)

curs_getstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_getstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_getstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_getstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_getstr(3x)                  Library calls                 curs_getstr(3x)
 
@@ -124,17 +124,16 @@
        interrupts  the  function,  it will return KEY_RESIZE rather than OK or
        ERR.
 
-       Functions with a "mv" prefix first  perform  a  cursor  movement  using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

        Any of these functions other than wgetnstr may be macros.
 
-       Using getstr, mvgetstr, mvwgetstr, or  wgetstr  to  read  a  line  that
-       overflows  the  array  pointed to by str causes undefined results.  The
-       use of getnstr, mvgetnstr, mvwgetnstr, or  wgetnstr,  respectively,  is
+       Using  getstr,  mvgetstr,  mvwgetstr,  or  wgetstr  to read a line that
+       overflows the array pointed to by str causes  undefined  results.   The
+       use  of  getnstr,  mvgetnstr, mvwgetnstr, or wgetnstr, respectively, is
        recommended.
 
 
@@ -142,96 +141,96 @@
        These functions are described in The Single Unix Specification, Version
        2.  No error conditions are defined.
 
-       This implementation returns ERR if the window pointer is  null,  or  if
+       This  implementation  returns  ERR if the window pointer is null, or if
        the lower-level wgetch(3x) call returns an ERR.
 
-       SVr3  and  early  SVr4  curses  implementations did not reject function
-       keys; the SVr4.0 documentation claimed that  "special  keys"  (such  as
-       function  keys,  "home"  key,  "clear"  key,  etc.)  are "interpreted",
-       without giving details.  It  lied.   In  fact,  the  "character"  value
+       SVr3 and early SVr4 curses  implementations  did  not  reject  function
+       keys;  the  SVr4.0  documentation  claimed that "special keys" (such as
+       function keys,  "home"  key,  "clear"  key,  etc.)  are  "interpreted",
+       without  giving  details.   It  lied.   In  fact, the "character" value
        appended to the string by those implementations was predictable but not
-       useful (being, in fact, the low-order eight  bits  of  the  key's  KEY_
+       useful  (being,  in  fact,  the  low-order eight bits of the key's KEY_
        value).
 
-       The  functions  getnstr, mvgetnstr, and mvwgetnstr were present but not
+       The functions getnstr, mvgetnstr, and mvwgetnstr were present  but  not
        documented in SVr4.
 
        X/Open Curses, Issue 5 (2007) stated that these functions "read at most
-       n  bytes"  but  did not state whether the terminating NUL is counted in
-       that limit.  X/Open Curses, Issue 7 (2009) changed  that  to  say  they
+       n bytes" but did not state whether the terminating NUL  is  counted  in
+       that  limit.   X/Open  Curses,  Issue 7 (2009) changed that to say they
        "read at most n-1 bytes" to allow for the terminating NUL.  As of 2018,
        some implementations count it, some do not:
 
-       o   ncurses 6.1 and PDCurses do not count the NUL in the  given  limit,
+       o   ncurses  6.1  and PDCurses do not count the NUL in the given limit,
            while
 
        o   Solaris SVr4 and NetBSD curses count the NUL as part of the limit.
 
-       o   Solaris   xcurses   provides  both:  its  wide-character  wget_nstr
-           reserves  a  NUL,  but  its  wgetnstr  does  not  count   the   NUL
+       o   Solaris  xcurses  provides  both:  its   wide-character   wget_nstr
+           reserves   a   NUL,  but  its  wgetnstr  does  not  count  the  NUL
            consistently.
 
        In SVr4 curses, a negative value of n tells wgetnstr to assume that the
-       caller's buffer is large enough to hold the result, i.e., to  act  like
-       wgetstr.   X/Open  Curses does not mention this (or anything related to
-       negative or zero values of n), however  most  implementations  use  the
+       caller's  buffer  is large enough to hold the result, i.e., to act like
+       wgetstr.  X/Open Curses does not mention this (or anything  related  to
+       negative  or  zero  values  of n), however most implementations use the
        feature, with different limits:
 
-       o   Solaris  SVr4  curses  and  PDCurses limit the result to 255 bytes.
+       o   Solaris SVr4 curses and PDCurses limit the  result  to  255  bytes.
            Other Unix systems than Solaris are likely to use the same limit.
 
        o   Solaris xcurses limits the result to LINE_MAX bytes.
 
-       o   NetBSD 7 assumes no particular limit for the result  from  wgetstr.
-           However,  it  limits  the wgetnstr parameter n to ensure that it is
+       o   NetBSD  7  assumes no particular limit for the result from wgetstr.
+           However, it limits the wgetnstr parameter n to ensure  that  it  is
            greater than zero.
 
-           A comment in NetBSD's source code states that this is specified  in
+           A  comment in NetBSD's source code states that this is specified in
            SUSv2.
 
-       o   ncurses  (before  6.2)  assumes  no particular limit for the result
-           from wgetstr, and treats the n  parameter  of  wgetnstr  like  SVr4
+       o   ncurses (before 6.2) assumes no particular  limit  for  the  result
+           from  wgetstr,  and  treats  the  n parameter of wgetnstr like SVr4
            curses.
 
-       o   ncurses  6.2  uses  LINE_MAX,  or a larger (system-dependent) value
-           which the sysconf function may provide.   If  neither  LINE_MAX  or
-           sysconf  is available, ncurses uses the POSIX value for LINE_MAX (a
-           2048 byte limit).  In either case,  it  reserves  a  byte  for  the
+       o   ncurses 6.2 uses LINE_MAX, or  a  larger  (system-dependent)  value
+           which  the  sysconf  function  may provide.  If neither LINE_MAX or
+           sysconf is available, ncurses uses the POSIX value for LINE_MAX  (a
+           2048  byte  limit).   In  either  case,  it reserves a byte for the
            terminating NUL.
 
-       Although  getnstr  is equivalent to a series of calls to getch, it also
-       makes changes to the curses modes to allow simple editing of the  input
+       Although getnstr is equivalent to a series of calls to getch,  it  also
+       makes  changes to the curses modes to allow simple editing of the input
        buffer:
 
-       o   getnstr  saves  the  current  value of the nl, echo, raw and cbreak
+       o   getnstr saves the current value of the nl,  echo,  raw  and  cbreak
            modes, and sets nl, noecho, noraw, and cbreak.
 
-           getnstr handles the echoing of characters, rather than  relying  on
+           getnstr  handles  the echoing of characters, rather than relying on
            the caller to set an appropriate mode.
 
-       o   It  also  obtains  the erase and kill characters from erasechar and
+       o   It also obtains the erase and kill characters  from  erasechar  and
            killchar, respectively.
 
        o   On return, getnstr restores the modes to their previous values.
 
        Other implementations differ in their treatment of special characters:
 
-       o   While they may set the echo  mode,  other  implementations  do  not
-           modify  the  raw  mode,  They  may  take the cbreak mode set by the
-           caller into account when deciding whether to handle echoing  within
+       o   While  they  may  set  the  echo mode, other implementations do not
+           modify the raw mode, They may take  the  cbreak  mode  set  by  the
+           caller  into account when deciding whether to handle echoing within
            getnstr or as a side-effect of the getch calls.
 
        o   The original ncurses (as pcurses in 1986) set noraw and cbreak when
-           accepting input for getnstr.  That  may  have  been  done  to  make
+           accepting  input  for  getnstr.   That  may  have been done to make
            function- and cursor-keys work; it is not necessary with ncurses.
 
-           Since  1995, ncurses has provided signal handlers for INTR and QUIT
-           (e.g., ^C or ^\).  With the noraw and cbreak  settings,  those  may
-           catch  a  signal  and stop the program, where other implementations
+           Since 1995, ncurses has provided signal handlers for INTR and  QUIT
+           (e.g.,  ^C  or  ^\).  With the noraw and cbreak settings, those may
+           catch a signal and stop the program,  where  other  implementations
            allow one to enter those characters in the buffer.
 
        o   Starting in 2021 (ncurses 6.3), getnstr sets raw, rather than noraw
-           and   cbreak  for  better  compatibility  with  SVr4-curses,  e.g.,
+           and  cbreak  for  better  compatibility  with  SVr4-curses,   e.g.,
            allowing one to enter a ^C into the buffer.
 
 
@@ -243,7 +242,7 @@
 
 
 
-ncurses 6.4                       2024-04-13                   curs_getstr(3x)
+ncurses 6.4                       2024-04-20                   curs_getstr(3x)

curs_getyx 3x 2024-03-16 ncurses 6.4 Library calls

curs_getyx 3x 2024-04-20 ncurses 6.4 Library calls

curs_getyx 3x 2024-03-16 ncurses 6.4 Library calls

curs_getyx 3x 2024-04-20 ncurses 6.4 Library calls

 curs_getyx(3x)                   Library calls                  curs_getyx(3x)
 
@@ -83,8 +83,8 @@

PORTABILITY

-       The getyx, getparyx, getbegyx and getmaxyx macros are described in  the
-       XSI Curses standard, Issue 4.
+       The getyx, getparyx, getbegyx and  getmaxyx  macros  are  described  in
+       X/Open Curses, Issue 4.
 
        This  implementation also provides functions getbegx, getbegy, getcurx,
        getcury, getmaxx, getmaxy, getparx and getpary for  compatibility  with
@@ -109,7 +109,7 @@
 
 
 
-ncurses 6.4                       2024-03-16                    curs_getyx(3x)
+ncurses 6.4                       2024-04-20                    curs_getyx(3x)

curs_in_wch 3x 2024-04-13 ncurses 6.4 Library calls

curs_in_wch 3x 2024-04-20 ncurses 6.4 Library calls

curs_in_wch 3x 2024-04-13 ncurses 6.4 Library calls

curs_in_wch 3x 2024-04-20 ncurses 6.4 Library calls

 curs_in_wch(3x)                  Library calls                 curs_in_wch(3x)
 
@@ -54,28 +54,27 @@

SYNOPSIS

        #include <curses.h>
 
-       int in_wch(cchar_t *wcval);
-       int win_wch(WINDOW *win, cchar_t *wcval);
+       int in_wch(cchar_t *wch);
+       int win_wch(WINDOW *win, cchar_t *wch);
 
-       int mvin_wch(int y, int x, cchar_t *wcval);
-       int mvwin_wch(WINDOW *win, int y, int x, cchar_t *wcval);
+       int mvin_wch(int y, int x, cchar_t *wch);
+       int mvwin_wch(WINDOW *win, int y, int x, cchar_t *wch);

DESCRIPTION

        These functions extract the complex character and  rendition  from  the
        current position in the named window into the cchar_t object referenced
-       by wcval.
+       by wch.

RETURN VALUE

-       No errors are defined in the XSI Curses standard.  This  implementation
-       checks  for  null  pointers,  returns  ERR  in that case.  Also, the mv
-       routines check for error moving the cursor, returning ERR in that case.
-       Otherwise they return OK.
+       No errors are defined in X/Open Curses.  This implementation checks for
+       null  pointers,  returns ERR in that case.  Also, the mv routines check
+       for error moving the cursor, returning ERR  in  that  case.   Otherwise
+       they return OK.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -83,18 +82,18 @@

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       These functions are described in X/Open Curses, Issue 4.

curs_in_wchstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_in_wchstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_in_wchstr(3x)               Library calls              curs_in_wchstr(3x)
 
@@ -92,34 +92,33 @@
 
        o   if the wchstr parameter is null.
 
-       Functions with a "mv" prefix first  perform  a  cursor  movement  using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

        All routines except win_wchnstr may be macros.
 
-       Reading a line that overflows the  array  pointed  to  by  wchstr  with
-       in_wchstr,  mvin_wchstr,  mvwin_wchstr  or  win_wchstr causes undefined
-       results.    Therefore,   the   use   of    in_wchnstr,    mvin_wchnstr,
+       Reading  a  line  that  overflows  the  array pointed to by wchstr with
+       in_wchstr, mvin_wchstr, mvwin_wchstr  or  win_wchstr  causes  undefined
+       results.     Therefore,    the   use   of   in_wchnstr,   mvin_wchnstr,
        mvwin_wchnstr, or win_wchnstr is recommended.

PORTABILITY

-       The XSI Curses defines no error conditions.  This implementation checks
+       X/Open Curses defines no error conditions.  This implementation  checks
        for null pointers, returning ERR in that case.

curs_inch 3x 2024-04-13 ncurses 6.4 Library calls

curs_inch 3x 2024-04-20 ncurses 6.4 Library calls

 curs_inch(3x)                    Library calls                   curs_inch(3x)
 
@@ -81,12 +81,11 @@

RETURN VALUE

-       Functions with a "mv" prefix first  perform  a  cursor  movement  using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
 
-       The winch function does not return an  error  if  the  window  contains
-       characters  larger than 8-bits (255).  Only the low-order 8 bits of the
+       The  winch  function  does  not  return an error if the window contains
+       characters larger than 8-bits (255).  Only the low-order 8 bits of  the
        character are used by winch.
 
 
@@ -95,40 +94,40 @@

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       These functions are described in X/Open Curses, Issue 4.
 
-       Very old systems (before standardization) provide a different  function
+       Very  old systems (before standardization) provide a different function
        with the same name:
 
-       o   The  winch  function  was  part of the original BSD curses library,
-           which  stored  a  7-bit  character  combined  with   the   standout
+       o   The winch function was part of the  original  BSD  curses  library,
+           which   stored   a  7-bit  character  combined  with  the  standout
            attribute.
 
-           In  BSD  curses,  winch returned only the character (as an integer)
+           In BSD curses, winch returned only the character  (as  an  integer)
            with the standout attribute removed.
 
-       o   System V curses added support for several  video  attributes  which
+       o   System  V  curses  added support for several video attributes which
            could be combined with characters in the window.
 
            Reflecting this improvement, the function was altered to return the
            character combined with all video attributes in a chtype value.
 
        X/Open Curses does not specify the size and layout of attributes, color
-       and  character  values in chtype; it is implementation-dependent.  This
-       implementation uses 8 bits for character values.  An application  using
-       more  bits,  e.g.,  a  Unicode  value,  should  use  the wide-character
+       and character values in chtype; it is  implementation-dependent.   This
+       implementation  uses 8 bits for character values.  An application using
+       more bits,  e.g.,  a  Unicode  value,  should  use  the  wide-character
        equivalents to these functions.

curs_inchstr 3x 2024-03-16 ncurses 6.4 Library calls

curs_inchstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_inchstr(3x)                 Library calls                curs_inchstr(3x)
 
@@ -92,9 +92,8 @@
 
        o   if the chstr parameter is null.
 
-       Functions with a "mv" prefix first  perform  a  cursor  movement  using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -104,16 +103,16 @@
        does not document whether a length limit argument includes any trailing
        0; and it does not document the meaning of the return value.
 
-       Reading a line that overflows  the  array  pointed  to  by  chstr  with
-       inchstr,  mvinchstr,  mvwinchstr  or winchstr causes undefined results.
-       Therefore, the use of inchnstr, mvinchnstr, mvwinchnstr,  or  winchnstr
+       Reading  a  line  that  overflows  the  array  pointed to by chstr with
+       inchstr, mvinchstr, mvwinchstr or winchstr  causes  undefined  results.
+       Therefore,  the  use of inchnstr, mvinchnstr, mvwinchnstr, or winchnstr
        is recommended.

PORTABILITY

-       These  functions are described in the XSI Curses standard, Issue 4.  It
-       is no more specific than the SVr4 documentation on the trailing 0.   It
-       does specify that the successful return of the functions is OK.
+       These functions are described in X/Open Curses, Issue 4.  It is no more
+       specific  than  the  SVr4  documentation  on  the  trailing 0.  It does
+       specify that the successful return of the functions is OK.

curs_initscr 3x 2024-04-13 ncurses 6.4 Library calls

curs_initscr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_initscr(3x)                 Library calls                curs_initscr(3x)
 
@@ -173,8 +173,8 @@

PORTABILITY

-       These functions were described in the XSI Curses standard, Issue 4.  As
-       of 2015, the current document is X/Open Curses, Issue 7.
+       These functions were described in X/Open Curses, Issue 4.  As of  2015,
+       the current document is X/Open Curses, Issue 7.

Differences

@@ -188,7 +188,7 @@
 
        Old versions of curses, e.g., BSD 4.4, would return a null pointer from
        initscr when an error is detected, rather than exiting.  It is safe but
-       redundant to check the return value of initscr in XSI Curses.
+       redundant to check the return value of initscr in X/Open Curses.
 
        Calling  endwin  does not dispose of the memory allocated in initscr or
        newterm.  Deleting a SCREEN provides a way to do this:
@@ -299,7 +299,7 @@
 
 
 
-ncurses 6.4                       2024-04-13                  curs_initscr(3x)
+ncurses 6.4                       2024-04-20                  curs_initscr(3x)

curs_ins_wch 3x 2024-03-16 ncurses 6.4 Library calls

curs_ins_wch 3x 2024-04-20 ncurses 6.4 Library calls

curs_ins_wch 3x 2024-03-16 ncurses 6.4 Library calls

curs_ins_wch 3x 2024-04-20 ncurses 6.4 Library calls

 curs_ins_wch(3x)                 Library calls                curs_ins_wch(3x)
 
@@ -73,8 +73,8 @@
 
        Functions taking a WINDOW pointer argument fail if the pointer is NULL.
 
-       Functions prefixed with "mv" first perform cursor movement using  wmove
-       and fail if the position (y, x) is outside the window.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -85,7 +85,7 @@

PORTABILITY

-       X/Open Curses, Issue 4, describes these functions.
+       X/Open Curses, Issue 4 describes these functions.
 
        SVr4 describes successful return values only as "an integer value other
        than ERR".
@@ -104,7 +104,7 @@
 
 
 
-ncurses 6.4                       2024-03-16                  curs_ins_wch(3x)
+ncurses 6.4                       2024-04-20                  curs_ins_wch(3x)

curs_ins_wstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_ins_wstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_ins_wstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_ins_wstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_ins_wstr(3x)                Library calls               curs_ins_wstr(3x)
 
@@ -95,37 +95,36 @@
 
        o   if the wins_wch function returns an error.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove(3x), and return an error if the position is outside  the  window,
-       or if the window pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

        All but wins_nwstr may be macros.
 
-       If  the first character in the string is a non-spacing character, these
-       functions will fail.  XSI does not define what will happen  if  a  non-
-       spacing character follows a control character.
+       If the first character in the string is a non-spacing character,  these
+       functions will fail.  X/Open Curses does not define what will happen if
+       a non-spacing character follows a control character.

PORTABILITY

-       These  functions  are  described  in  the XSI Curses standard, Issue 4,
-       which adds const qualifiers to the arguments.
+       These functions are described in X/Open Curses,  Issue  4,  which  adds
+       const qualifiers to the arguments.
 
-       X/Open states that the entire string is inserted if n is less  than  1.
-       This  is  probably  an  error,  because  it  is inconsistent with other
+       X/Open  states  that the entire string is inserted if n is less than 1.
+       This is probably an  error,  because  it  is  inconsistent  with  other
        functions, and differs from the X/Open implementation on Solaris.

curs_insch 3x 2024-03-16 ncurses 6.4 Library calls

curs_insch 3x 2024-04-20 ncurses 6.4 Library calls

 curs_insch(3x)                   Library calls                  curs_insch(3x)
 
@@ -72,22 +72,22 @@
 
        Functions taking a WINDOW pointer argument fail if the pointer is NULL.
 
-       Functions  prefixed with "mv" first perform cursor movement using wmove
-       and fail if the position (y, x) is outside the window.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

+       insch, mvinsch, and mvwinsch may be implemented as macros.
+
        A terminal's insert_character  (ich1)  capability  is  not  necessarily
        employed.
 
-       insch, mvinsch, and mvwinsch may be implemented as macros.
-

PORTABILITY

-       X/Open Curses, Issue 4, describes these functions.
+       X/Open Curses, Issue 4 describes these functions.
 
-       SVr4 describes successful return values only as "an integer value other
-       than ERR".
+       SVr4  curses  describes  a  successful return value only as "an integer
+       value other than ERR".

curs_insstr 3x 2024-03-16 ncurses 6.4 Library calls

curs_insstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_insstr(3x)                  Library calls                 curs_insstr(3x)
 
@@ -93,9 +93,8 @@
 
        o   the winsch(3x) function returns an error.
 
-       Functions with a "mv" prefix first  perform  a  cursor  movement  using
-       wmove(3x),  and  return an error if the position is outside the window,
-       or if the window pointer is null.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -103,17 +102,17 @@

PORTABILITY

-       These functions are described in the  XSI  Curses  standard,  Issue  4,
-       which adds const qualifiers to the arguments.
+       These  functions  are  described  in X/Open Curses, Issue 4, which adds
+       const qualifiers to the arguments.
 
-       The  Single  Unix  Specification,  Version  2  states  that insnstr and
-       winsnstr perform wrapping.  This is probably an error, since  it  makes
-       this  group  of  functions  inconsistent.   Also,  no implementation of
+       The Single Unix  Specification,  Version  2  states  that  insnstr  and
+       winsnstr  perform  wrapping.  This is probably an error, since it makes
+       this group of  functions  inconsistent.   Also,  no  implementation  of
        curses documents this inconsistency.
 
-       X/Open states that the entire string is inserted if n is less  than  1.
-       This  is  probably  an  error,  because  it  is inconsistent with other
-       functions, and differs from the  SVr4  and  X/Open  implementations  on
+       X/Open  states  that the entire string is inserted if n is less than 1.
+       This is probably an  error,  because  it  is  inconsistent  with  other
+       functions,  and  differs  from  the  SVr4 and X/Open implementations on
        Solaris.
 
 
@@ -122,7 +121,7 @@
 
 
 
-ncurses 6.4                       2024-03-16                   curs_insstr(3x)
+ncurses 6.4                       2024-04-20                   curs_insstr(3x)

curs_instr 3x 2024-04-13 ncurses 6.4 Library calls

curs_instr 3x 2024-04-20 ncurses 6.4 Library calls

curs_instr 3x 2024-04-13 ncurses 6.4 Library calls

curs_instr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_instr(3x)                   Library calls                  curs_instr(3x)
 
@@ -87,26 +87,25 @@
 
        o   if the chstr parameter is null.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

        All routines except winnstr may be macros.
 
-       Reading  a  line that overflows the array pointed to by str with instr,
-       mvinstr, mvwinstr or winstr causes undefined results.   Therefore,  the
+       Reading a line that overflows the array pointed to by str  with  instr,
+       mvinstr,  mvwinstr  or winstr causes undefined results.  Therefore, the
        use of innstr, mvinnstr, mvwinnstr, or winnstr is recommended.

PORTABILITY

-       SVr4  does not document whether a length limit includes or excludes the
+       SVr4 does not document whether a length limit includes or excludes  the
        trailing NUL.
 
-       The ncurses library extends the XSI description by allowing a  negative
-       value  for  n.  In this case, the functions return the string ending at
-       the right margin.
+       The ncurses library extends the X/Open Curses description by allowing a
+       negative value for n.  In this case, the functions  return  the  string
+       ending at the right margin.

curs_inwstr 3x 2024-03-16 ncurses 6.4 Library calls

curs_inwstr 3x 2024-04-20 ncurses 6.4 Library calls

 curs_inwstr(3x)                  Library calls                 curs_inwstr(3x)
 
@@ -92,36 +92,35 @@
 
        o   if no characters could be read.
 
-       Functions with a "mv" prefix first  perform  a  cursor  movement  using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

        All routines except winnwstr may be macros.
 
-       Each cell in the window holds a complex character (a spacing  character
-       and  zero  or more non-spacing characters) together with attributes and
-       color.  These  functions  store  only  the  wide  characters,  ignoring
-       attributes  and  color.  Use in_wchstr to return the complex characters
+       Each  cell in the window holds a complex character (a spacing character
+       and zero or more non-spacing characters) together with  attributes  and
+       color.   These  functions  store  only  the  wide  characters, ignoring
+       attributes and color.  Use in_wchstr to return the  complex  characters
        from a window.
 
        Reading a line that overflows the array pointed to by wstr with inwstr,
-       mvinwstr,  mvwinwstr  or  winwstr causes undefined results.  Therefore,
+       mvinwstr, mvwinwstr or winwstr causes  undefined  results.   Therefore,
        the use of innwstr, mvinnwstr, mvwinnwstr, or winnwstr is recommended.

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       These functions are described in X/Open Curses, Issue 4.

curs_kernel 3x 2024-04-13 ncurses 6.4 Library calls

curs_kernel 3x 2024-04-20 ncurses 6.4 Library calls

 curs_kernel(3x)                  Library calls                 curs_kernel(3x)
 
@@ -190,9 +190,9 @@

PORTABILITY

-       The virtual screen functions setsyx and getsyx are not described in the
-       XSI  Curses standard, Issue 4.  All other functions are as described in
-       XSI Curses.
+       The virtual screen functions setsyx and getsyx  are  not  described  in
+       X/Open Curses, Issue 4.  All other functions are as described in X/Open
+       Curses.
 
        The SVr4 documentation describes setsyx and  getsyx  as  having  return
        type  int.   This  is misleading, as they are macros with no documented
@@ -208,7 +208,7 @@
 
 
 
-ncurses 6.4                       2024-04-13                   curs_kernel(3x)
+ncurses 6.4                       2024-04-20                   curs_kernel(3x)

curs_mouse 3x 2024-03-23 ncurses 6.4 Library calls

curs_mouse 3x 2024-04-20 ncurses 6.4 Library calls

curs_mouse 3x 2024-03-23 ncurses 6.4 Library calls

curs_mouse 3x 2024-04-20 ncurses 6.4 Library calls

 curs_mouse(3x)                   Library calls                  curs_mouse(3x)
 
@@ -65,11 +65,11 @@
 
        bool has_mouse(void);
 
+       mmask_t mousemask(mmask_t newmask, mmask_t *oldmask);
+
        int getmouse(MEVENT *event);
        int ungetmouse(MEVENT *event);
 
-       mmask_t mousemask(mmask_t newmask, mmask_t *oldmask);
-
        bool wenclose(const WINDOW *win, int y, int x);
 
        bool mouse_trafo(int* pY, int* pX, bool to_screen);
@@ -85,6 +85,16 @@
        wgetch(3x) input stream.
 
 
+

has_mouse

+       The has_mouse function returns  TRUE  if  the  mouse  driver  has  been
+       successfully initialized, and FALSE otherwise.
+
+       Mouse  events  are  ignored  when input is in cooked mode, and cause an
+       error beep when cooked mode  is  being  simulated  in  a  window  by  a
+       function  such  as  getstr  that  expects  a  linefeed  for  input-loop
+       termination.
+
+

mousemask

        To make mouse events visible, use the mousemask  function.   This  sets
        the  mouse  events  to  be  reported.   By default, no mouse events are
@@ -112,7 +122,6 @@
        BUTTON1_PRESSED          mouse button 1 down
        BUTTON1_RELEASED         mouse button 1 up
        BUTTON1_CLICKED          mouse button 1 clicked
-
        BUTTON1_DOUBLE_CLICKED   mouse button 1 double clicked
        BUTTON1_TRIPLE_CLICKED   mouse button 1 triple clicked
        ------------------------------------------------------------------------
@@ -234,16 +243,6 @@
        setupterm(3x).
 
 
-

has_mouse

-       The  has_mouse  function  returns  TRUE  if  the  mouse driver has been
-       successfully initialized, and FALSE otherwise.
-
-       Mouse events are ignored when input is in cooked  mode,  and  cause  an
-       error  beep  when  cooked  mode  is  being  simulated  in a window by a
-       function  such  as  getstr  that  expects  a  linefeed  for  input-loop
-       termination.
-
-

RETURN VALUE

        has_mouse, wenclose, mouse_trafo, and wmouse_trafo return TRUE or FALSE
        as noted above.
@@ -395,7 +394,7 @@
 
 
 
-ncurses 6.4                       2024-03-23                    curs_mouse(3x)
+ncurses 6.4                       2024-04-20                    curs_mouse(3x)

SYNOPSIS
DESCRIPTION
+
has_mouse

mousemask

Mouse Events

getmouse
@@ -411,7 +411,6 @@ ncurses 6.4 2024-03-23 wmouse_trafo
mouse_trafo

mouseinterval
-
has_mouse

RETURN VALUE
diff --git a/doc/html/man/curs_move.3x.html b/doc/html/man/curs_move.3x.html index 53047bef..190c8ac3 100644 --- a/doc/html/man/curs_move.3x.html +++ b/doc/html/man/curs_move.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_move.3x,v 1.35 2024/03/16 15:35:01 tom Exp @ + * @Id: curs_move.3x,v 1.38 2024/04/20 19:51:33 tom Exp @ --> -curs_move 3x 2024-03-16 ncurses 6.4 Library calls +curs_move 3x 2024-04-20 ncurses 6.4 Library calls -
curs_move 3x 2024-03-16 ncurses 6.4 Library calls
+
curs_move 3x 2024-04-20 ncurses 6.4 Library calls

curs_move(3x) Library calls curs_move(3x) @@ -58,27 +58,27 @@
DESCRIPTION
- These routines move the cursor associated with the window to line y and - column x. This routine does not move the physical cursor of the - terminal until refresh(3x) is called. The position specified is - relative to the upper left-hand corner of the window, which is (0,0). + wmove relocates the cursor associated with the curses window win to + line y and column x. The terminal's cursor does not move until + refresh(3x) is called. The position (x, y) is relative to the upper + left-hand corner of the window, which has coordinates (0, 0). + ncurses(3x) describes the move variant of this function.
RETURN VALUE
- These routines return the integer ERR upon failure and an OK (SVr4 - specifies only "an integer value other than ERR") upon successful - completion. + These functions return OK on success and ERR on failure. - Specifically, they return an error if the window pointer is null, or if - the position is outside the window. + They fail if the position (y, x) is outside the window boundaries. + + wmove fails if its WINDOW pointer argument is NULL.
NOTES
- Note that move may be a macro. + move may be implemented as a macro.
PORTABILITY
- These functions are described in the XSI Curses standard, Issue 4. + X/Open Curses, Issue 4 describes these functions.
SEE ALSO
@@ -86,7 +86,7 @@ -ncurses 6.4 2024-03-16 curs_move(3x) +ncurses 6.4 2024-04-20 curs_move(3x)

diff --git a/doc/html/man/curs_outopts.3x.html b/doc/html/man/curs_outopts.3x.html index 96b1b01d..65efa41b 100644 --- a/doc/html/man/curs_outopts.3x.html +++ b/doc/html/man/curs_outopts.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_outopts.3x,v 1.60 2024/04/13 22:23:57 tom Exp @ + * @Id: curs_outopts.3x,v 1.64 2024/04/20 21:24:19 tom Exp @ --> -curs_outopts 3x 2024-04-13 ncurses 6.4 Library calls +curs_outopts 3x 2024-04-20 ncurses 6.4 Library calls -
curs_outopts 3x 2024-04-13 ncurses 6.4 Library calls
+
curs_outopts 3x 2024-04-20 ncurses 6.4 Library calls

curs_outopts(3x) Library calls curs_outopts(3x) @@ -156,7 +156,7 @@ the window pointer is null o wsetscrreg returns an error if the scrolling region limits extend - outside the window. + outside the window boundaries.
NOTES
@@ -168,7 +168,7 @@
PORTABILITY
- These functions are described in the XSI Curses standard, Issue 4. + These functions are described in X/Open Curses, Issue 4. Some historic curses implementations had, as an undocumented feature, the ability to do the equivalent of clearok(..., 1) by saying @@ -176,28 +176,27 @@ Earlier System V curses implementations specified that with scrollok enabled, any window modification triggering a scroll also forced a - physical refresh. XSI Curses does not require this, and ncurses avoids - doing it to perform better vertical-motion optimization at wrefresh - time. + physical refresh. X/Open Curses does not require this, and ncurses + avoids doing it to perform better vertical-motion optimization at + wrefresh time. - The XSI Curses standard does not mention that the cursor should be made - invisible as a side-effect of leaveok. SVr4 curses documentation does - this, but the code does not. Use curs_set to make the cursor - invisible. + X/Open Curses does not mention that the cursor should be made invisible + as a side-effect of leaveok. SVr4 curses documentation does this, but + the code does not. Use curs_set to make the cursor invisible.
HISTORY
- ncurses formerly treated nl(3x) and nonl(3x) as both input and output + ncurses formerly treated nl(3x) and nonl(3x) as both input and output options, but no longer; see curs_inopts(3x).
SEE ALSO
- curses(3x), curs_addch(3x), curs_clear(3x), curs_initscr(3x), + curses(3x), curs_addch(3x), curs_clear(3x), curs_initscr(3x), curs_refresh(3x), curs_scroll(3x), curs_variables(3x) -ncurses 6.4 2024-04-13 curs_outopts(3x) +ncurses 6.4 2024-04-20 curs_outopts(3x)

diff --git a/doc/html/man/curs_overlay.3x.html b/doc/html/man/curs_overlay.3x.html index 6b9c9c54..241fd356 100644 --- a/doc/html/man/curs_overlay.3x.html +++ b/doc/html/man/curs_overlay.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_overlay.3x,v 1.41 2024/03/16 15:35:01 tom Exp @ + * @Id: curs_overlay.3x,v 1.43 2024/04/20 21:20:07 tom Exp @ --> -curs_overlay 3x 2024-03-16 ncurses 6.4 Library calls +curs_overlay 3x 2024-04-20 ncurses 6.4 Library calls -
curs_overlay 3x 2024-03-16 ncurses 6.4 Library calls
+
curs_overlay 3x 2024-04-20 ncurses 6.4 Library calls

curs_overlay(3x) Library calls curs_overlay(3x) @@ -95,10 +95,10 @@
PORTABILITY
- These functions are described in the XSI Curses standard, Issue 4, - which adds const qualifiers to the arguments. It further specifies - their behavior in the presence of characters with multibyte renditions - (not yet supported in this implementation). + These functions are described in X/Open Curses, Issue 4, which adds + const qualifiers to the arguments. It further specifies their behavior + in the presence of characters with multibyte renditions (not yet + supported in this implementation).
SEE ALSO
@@ -106,7 +106,7 @@ -ncurses 6.4 2024-03-16 curs_overlay(3x) +ncurses 6.4 2024-04-20 curs_overlay(3x)

diff --git a/doc/html/man/curs_pad.3x.html b/doc/html/man/curs_pad.3x.html index 55ddbac1..af575097 100644 --- a/doc/html/man/curs_pad.3x.html +++ b/doc/html/man/curs_pad.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_pad.3x,v 1.57 2024/04/13 22:13:17 tom Exp @ + * @Id: curs_pad.3x,v 1.59 2024/04/20 21:20:07 tom Exp @ --> -curs_pad 3x 2024-04-13 ncurses 6.4 Library calls +curs_pad 3x 2024-04-20 ncurses 6.4 Library calls -
curs_pad 3x 2024-04-13 ncurses 6.4 Library calls
+
curs_pad 3x 2024-04-20 ncurses 6.4 Library calls

curs_pad(3x) Library calls curs_pad(3x) @@ -176,10 +176,10 @@ The two uses may be related. - The XSI Curses standard, Issue 4 describes these functions, without - significant change from the SVr3 documentation. It describes no error - conditions. The behavior of subpad if the parent window is not a pad - is undocumented, and is not checked by the vendor Unix implementations: + X/Open Curses, Issue 4 describes these functions, without significant + change from the SVr3 documentation. It describes no error conditions. + The behavior of subpad if the parent window is not a pad is + undocumented, and is not checked by the vendor Unix implementations: o SVr4 curses sets a flag in the WINDOW structure in newpad which tells if the window is a pad. @@ -230,7 +230,7 @@ -ncurses 6.4 2024-04-13 curs_pad(3x) +ncurses 6.4 2024-04-20 curs_pad(3x)

diff --git a/doc/html/man/curs_printw.3x.html b/doc/html/man/curs_printw.3x.html index ab4b2997..c02ebf85 100644 --- a/doc/html/man/curs_printw.3x.html +++ b/doc/html/man/curs_printw.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_printw.3x,v 1.51 2024/03/23 20:38:57 tom Exp @ + * @Id: curs_printw.3x,v 1.53 2024/04/20 19:18:18 tom Exp @ --> -curs_printw 3x 2024-03-23 ncurses 6.4 Library calls +curs_printw 3x 2024-04-20 ncurses 6.4 Library calls -
curs_printw 3x 2024-03-23 ncurses 6.4 Library calls
+
curs_printw 3x 2024-04-20 ncurses 6.4 Library calls

curs_printw(3x) Library calls curs_printw(3x) @@ -83,8 +83,8 @@ for the buffer into which the output is formatted, or if the window pointer win is null. - Functions with a "mv" prefix first perform a cursor movement using - wmove, and fail if the position is outside the window. + Functions prefixed with "mv" first perform cursor movement and fail if + the position (y, x) is outside the window boundaries.
NOTES
@@ -95,13 +95,13 @@
PORTABILITY
- X/Open Curses, Issue 4, describes these functions. It specifies no + X/Open Curses, Issue 4 describes these functions. It specifies no error conditions for them. ncurses defines vw_printw and vwprintw identically to support legacy applications. However, the latter is obsolete. - o X/Open Curses, Issue 4, Version 2 (1996), marked vwprintw as + o X/Open Curses, Issue 4 Version 2 (1996), marked vwprintw as requiring varargs.h and "TO BE WITHDRAWN", and specified vw_printw using the stdarg.h interface. @@ -147,7 +147,7 @@ -ncurses 6.4 2024-03-23 curs_printw(3x) +ncurses 6.4 2024-04-20 curs_printw(3x)

diff --git a/doc/html/man/curs_refresh.3x.html b/doc/html/man/curs_refresh.3x.html index 3f636947..81575489 100644 --- a/doc/html/man/curs_refresh.3x.html +++ b/doc/html/man/curs_refresh.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_refresh.3x,v 1.44 2024/03/16 15:49:39 tom Exp @ + * @Id: curs_refresh.3x,v 1.46 2024/04/20 21:20:07 tom Exp @ --> -curs_refresh 3x 2024-03-16 ncurses 6.4 Library calls +curs_refresh 3x 2024-04-20 ncurses 6.4 Library calls -
curs_refresh 3x 2024-03-16 ncurses 6.4 Library calls
+
curs_refresh 3x 2024-04-20 ncurses 6.4 Library calls

curs_refresh(3x) Library calls curs_refresh(3x) @@ -144,7 +144,7 @@
PORTABILITY
- The XSI Curses standard, Issue 4 describes these functions. + X/Open Curses, Issue 4 describes these functions. Whether wnoutrefresh copies to the virtual screen the entire contents of a window or just its changed portions has never been well-documented @@ -160,7 +160,7 @@ -ncurses 6.4 2024-03-16 curs_refresh(3x) +ncurses 6.4 2024-04-20 curs_refresh(3x)

diff --git a/doc/html/man/curs_scanw.3x.html b/doc/html/man/curs_scanw.3x.html index 9e1d3091..c11c049b 100644 --- a/doc/html/man/curs_scanw.3x.html +++ b/doc/html/man/curs_scanw.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_scanw.3x,v 1.51 2024/03/23 20:41:15 tom Exp @ + * @Id: curs_scanw.3x,v 1.53 2024/04/20 19:18:18 tom Exp @ --> -curs_scanw 3x 2024-03-23 ncurses 6.4 Library calls +curs_scanw 3x 2024-04-20 ncurses 6.4 Library calls -
curs_scanw 3x 2024-03-23 ncurses 6.4 Library calls
+
curs_scanw 3x 2024-04-20 ncurses 6.4 Library calls

curs_scanw(3x) Library calls curs_scanw(3x) @@ -84,8 +84,8 @@ In ncurses, failure occurs if vsscanf(3) returns EOF, or if the window pointer win is null. - Functions with a "mv" prefix first perform a cursor movement using - wmove, and fail if the position is outside the window. + Functions prefixed with "mv" first perform cursor movement and fail if + the position (y, x) is outside the window boundaries.
NOTES
@@ -100,13 +100,13 @@
PORTABILITY
- X/Open Curses, Issue 4, describes these functions. It specifies no + X/Open Curses, Issue 4 describes these functions. It specifies no error conditions for them. ncurses defines vw_scanw and vwscanw identically to support legacy applications. However, the latter is obsolete. - o X/Open Curses, Issue 4, Version 2 (1996), marked vwscanw as + o X/Open Curses, Issue 4 Version 2 (1996), marked vwscanw as requiring varargs.h and "TO BE WITHDRAWN", and specified vw_scanw using the stdarg.h interface. @@ -179,7 +179,7 @@ -ncurses 6.4 2024-03-23 curs_scanw(3x) +ncurses 6.4 2024-04-20 curs_scanw(3x)

diff --git a/doc/html/man/curs_scr_dump.3x.html b/doc/html/man/curs_scr_dump.3x.html index 66806000..634608fa 100644 --- a/doc/html/man/curs_scr_dump.3x.html +++ b/doc/html/man/curs_scr_dump.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_scr_dump.3x,v 1.41 2024/03/23 20:41:15 tom Exp @ + * @Id: curs_scr_dump.3x,v 1.43 2024/04/20 18:54:36 tom Exp @ --> -curs_scr_dump 3x 2024-03-23 ncurses 6.4 Library calls +curs_scr_dump 3x 2024-04-20 ncurses 6.4 Library calls -
curs_scr_dump 3x 2024-03-23 ncurses 6.4 Library calls
+
curs_scr_dump 3x 2024-04-20 ncurses 6.4 Library calls

curs_scr_dump(3x) Library calls curs_scr_dump(3x) @@ -116,7 +116,7 @@
PORTABILITY
- X/Open Curses, Issue 4, describes these functions. + X/Open Curses, Issue 4 describes these functions. SVr4 omitted the const qualifiers. @@ -131,7 +131,7 @@ -ncurses 6.4 2024-03-23 curs_scr_dump(3x) +ncurses 6.4 2024-04-20 curs_scr_dump(3x)

diff --git a/doc/html/man/curs_scroll.3x.html b/doc/html/man/curs_scroll.3x.html index ea313978..ec80578d 100644 --- a/doc/html/man/curs_scroll.3x.html +++ b/doc/html/man/curs_scroll.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_scroll.3x,v 1.41 2024/04/14 00:14:28 tom Exp @ + * @Id: curs_scroll.3x,v 1.43 2024/04/20 18:54:36 tom Exp @ --> -curs_scroll 3x 2024-04-13 ncurses 6.4 Library calls +curs_scroll 3x 2024-04-20 ncurses 6.4 Library calls -
curs_scroll 3x 2024-04-13 ncurses 6.4 Library calls
+
curs_scroll 3x 2024-04-20 ncurses 6.4 Library calls

curs_scroll(3x) Library calls curs_scroll(3x) @@ -93,7 +93,7 @@
PORTABILITY
- X/Open Curses, Issue 4, describes these functions. It defines no error + X/Open Curses, Issue 4 describes these functions. It defines no error conditions. SVr4 specifies only "an integer value other than ERR" as a successful @@ -115,7 +115,7 @@ -ncurses 6.4 2024-04-13 curs_scroll(3x) +ncurses 6.4 2024-04-20 curs_scroll(3x)

diff --git a/doc/html/man/curs_slk.3x.html b/doc/html/man/curs_slk.3x.html index f0851713..90e23f51 100644 --- a/doc/html/man/curs_slk.3x.html +++ b/doc/html/man/curs_slk.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_slk.3x,v 1.69 2024/03/16 15:35:01 tom Exp @ + * @Id: curs_slk.3x,v 1.71 2024/04/20 18:54:36 tom Exp @ --> -curs_slk 3x 2024-03-16 ncurses 6.4 Library calls +curs_slk 3x 2024-04-20 ncurses 6.4 Library calls -
curs_slk 3x 2024-03-16 ncurses 6.4 Library calls
+
curs_slk 3x 2024-04-20 ncurses 6.4 Library calls

curs_slk(3x) Library calls curs_slk(3x) @@ -224,8 +224,8 @@
PORTABILITY
- X/Open Curses, Issue 4, describes these functions, with some - differences from SVr4 curses: + X/Open Curses, Issue 4 describes these functions, with some differences + from SVr4 curses: o X/Open added functions like the SVr4 attribute-manipulation functions slk_attron, slk_attroff, and slk_attrset, but which use @@ -313,7 +313,7 @@ -ncurses 6.4 2024-03-16 curs_slk(3x) +ncurses 6.4 2024-04-20 curs_slk(3x)

diff --git a/doc/html/man/curs_sp_funcs.3x.html b/doc/html/man/curs_sp_funcs.3x.html index 11632512..44294489 100644 --- a/doc/html/man/curs_sp_funcs.3x.html +++ b/doc/html/man/curs_sp_funcs.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_sp_funcs.3x,v 1.48 2024/03/16 15:35:01 tom Exp @ + * @Id: curs_sp_funcs.3x,v 1.50 2024/04/20 18:56:31 tom Exp @ --> -curs_sp_funcs 3x 2024-03-16 ncurses 6.4 Library calls +curs_sp_funcs 3x 2024-04-20 ncurses 6.4 Library calls -
curs_sp_funcs 3x 2024-03-16 ncurses 6.4 Library calls
+
curs_sp_funcs 3x 2024-04-20 ncurses 6.4 Library calls

curs_sp_funcs(3x) Library calls curs_sp_funcs(3x) @@ -70,7 +70,7 @@ int echo_sp(SCREEN* sp); int endwin_sp(SCREEN* sp); char erasechar_sp(SCREEN* sp); - int erasewchar_sp(SCREEN* sp, wchar_t *ch); + int erasewchar_sp(SCREEN* sp, wchar_t *wc); int extended_color_content_sp(SCREEN * sp, int color, int * r, int * g, int * b); int extended_pair_content_sp(SCREEN* sp, int pair, int * fg, int * bg); int extended_slk_color_sp(SCREEN* sp, int pair); @@ -88,7 +88,7 @@ bool has_ic_sp(SCREEN* sp); bool has_il_sp(SCREEN* sp); - int has_key_sp(SCREEN* sp, int ch); + int has_key_sp(SCREEN* sp, int c); bool has_mouse_sp(SCREEN* sp); int init_color_sp(SCREEN* sp, short color, short r, short g, short b); int init_extended_color_sp(SCREEN* sp, int color, int r, int g, int b); @@ -108,7 +108,7 @@ int keyok_sp(SCREEN* sp, int keycode, bool enable); char killchar_sp(SCREEN* sp); - int killwchar_sp(SCREEN* sp, wchar_t *ch); + int killwchar_sp(SCREEN* sp, wchar_t *wc); char* longname_sp(SCREEN* sp); int mcprint_sp(SCREEN* sp, char *data, int len); int mouseinterval_sp(SCREEN* sp, int erval); @@ -166,8 +166,8 @@ chtype termattrs_sp(SCREEN* sp); char* termname_sp(SCREEN* sp); int typeahead_sp(SCREEN* sp, int fd); - int unget_wch_sp(SCREEN* sp, const wchar_t wch); - int ungetch_sp(SCREEN* sp, int ch); + int unget_wch_sp(SCREEN* sp, const wchar_t wc); + int ungetch_sp(SCREEN* sp, int c); int ungetmouse_sp(SCREEN* sp, MEVENT* event); int use_default_colors_sp(SCREEN* sp); void use_env_sp(SCREEN* sp, bool bf); @@ -178,7 +178,7 @@ int vid_puts_sp(SCREEN* sp, attr_t attrs, short pair, void * opts, NCURSES_SP_OUTC putc); int vidattr_sp(SCREEN* sp, chtype attrs); int vidputs_sp(SCREEN* sp, chtype attrs, NCURSES_SP_OUTC putc); - wchar_t* wunctrl_sp(SCREEN* sp, cchar_t *ch); + wchar_t* wunctrl_sp(SCREEN* sp, cchar_t *wch); #include <form.h> @@ -215,7 +215,7 @@ #include <unctrl.h> - NCURSES_CONST char* unctrl_sp(SCREEN* sp, chtype c); + NCURSES_CONST char* unctrl_sp(SCREEN* sp, chtype ch);
DESCRIPTION
@@ -294,7 +294,7 @@ -ncurses 6.4 2024-03-16 curs_sp_funcs(3x) +ncurses 6.4 2024-04-20 curs_sp_funcs(3x)

diff --git a/doc/html/man/curs_termattrs.3x.html b/doc/html/man/curs_termattrs.3x.html index 2fe21996..84f7a15b 100644 --- a/doc/html/man/curs_termattrs.3x.html +++ b/doc/html/man/curs_termattrs.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_termattrs.3x,v 1.38 2024/04/13 22:16:39 tom Exp @ + * @Id: curs_termattrs.3x,v 1.41 2024/04/20 21:20:07 tom Exp @ --> -curs_termattrs 3x 2024-04-13 ncurses 6.4 Library calls +curs_termattrs 3x 2024-04-20 ncurses 6.4 Library calls -
curs_termattrs 3x 2024-04-13 ncurses 6.4 Library calls
+
curs_termattrs 3x 2024-04-20 ncurses 6.4 Library calls

curs_termattrs(3x) Library calls curs_termattrs(3x) @@ -57,11 +57,11 @@ int baudrate(void); char erasechar(void); - int erasewchar(wchar_t *ch); + int erasewchar(wchar_t *wc); bool has_ic(void); bool has_il(void); char killchar(void); - int killwchar(wchar_t *ch); + int killwchar(wchar_t *wc); char *longname(void); attr_t term_attrs(void); chtype termattrs(void); @@ -80,8 +80,8 @@ The erasechar routine returns the user's current erase character. The erasewchar routine stores the current erase character in the - location referenced by ch. If no erase character has been defined, the - routine fails and the location referenced by ch is not changed. + location referenced by wc. If no erase character has been defined, the + routine fails and the location referenced by wc is not changed.
has_ic, has_il
@@ -98,8 +98,8 @@ The killchar routine returns the user's current line kill character. The killwchar routine stores the current line-kill character in the - location referenced by ch. If no line-kill character has been defined, - the routine fails and the location referenced by ch is not changed. + location referenced by wc. If no line-kill character has been defined, + the routine fails and the location referenced by wc is not changed.
longname
@@ -139,8 +139,8 @@
PORTABILITY
- The XSI Curses standard, Issue 4 describes these functions. It changes - the return type of termattrs to the new type attr_t. Most versions of + X/Open Curses, Issue 4 describes these functions. It changes the + return type of termattrs to the new type attr_t. Most versions of curses truncate the result returned by termname to 14 characters. @@ -149,7 +149,7 @@ -ncurses 6.4 2024-04-13 curs_termattrs(3x) +ncurses 6.4 2024-04-20 curs_termattrs(3x)

diff --git a/doc/html/man/curs_termcap.3x.html b/doc/html/man/curs_termcap.3x.html index b35ae8cb..cb46f66b 100644 --- a/doc/html/man/curs_termcap.3x.html +++ b/doc/html/man/curs_termcap.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_termcap.3x,v 1.83 2024/03/16 15:35:01 tom Exp @ + * @Id: curs_termcap.3x,v 1.85 2024/04/20 19:13:12 tom Exp @ --> -curs_termcap 3x 2024-03-16 ncurses 6.4 Library calls +curs_termcap 3x 2024-04-20 ncurses 6.4 Library calls -
curs_termcap 3x 2024-03-16 ncurses 6.4 Library calls
+
curs_termcap 3x 2024-04-20 ncurses 6.4 Library calls

curs_termcap(3x) Library calls curs_termcap(3x) @@ -94,7 +94,7 @@ implementations conforming to portions of X/Open Curses now withdrawn. The BSD termcap library would store a copy of the terminal type description in the area referenced by this - pointer. ncurses stores terminal type descriptions in compiled + pointer. terminfo stores terminal type descriptions in compiled form, which is not the same thing. o The meanings of the return values differ. The BSD termcap @@ -333,11 +333,11 @@ parameterized string capability, be aware that it is returned in term- info notation, not the older and not-quite-compatible termcap notation. This does not cause problems if all you do with it is call tgoto or - tparm, which both expand terminfo-style strings as terminfo does. (If - ncurses is configured to support termcap, tgoto checks whether the - string is terminfo-style by looking for "%p" parameters or "<...>" - delays, and invokes a termcap-style parser if the string appears not to - use terminfo syntax.) + tparm, which both parametrically expand terminfo-style string + capabilities as terminfo does. (If ncurses is configured to support + termcap, tgoto checks whether the string is terminfo-style by looking + for "%p" parameters or "<...>" delays, and invokes a termcap-style + parser if the string appears not to use terminfo syntax.) Because terminfo's syntax for padding in string capabilities differs from termcap's, users can be surprised. @@ -369,7 +369,7 @@ -ncurses 6.4 2024-03-16 curs_termcap(3x) +ncurses 6.4 2024-04-20 curs_termcap(3x)

diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html index a0c23473..08a4d087 100644 --- a/doc/html/man/curs_touch.3x.html +++ b/doc/html/man/curs_touch.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_touch.3x,v 1.44 2024/03/16 15:49:58 tom Exp @ + * @Id: curs_touch.3x,v 1.47 2024/04/20 21:20:07 tom Exp @ --> -curs_touch 3x 2024-03-16 ncurses 6.4 Library calls +curs_touch 3x 2024-04-20 ncurses 6.4 Library calls -
curs_touch 3x 2024-03-16 ncurses 6.4 Library calls
+
curs_touch 3x 2024-04-20 ncurses 6.4 Library calls

curs_touch(3x) Library calls curs_touch(3x) @@ -98,7 +98,7 @@ is_linetouched returns an error if the window pointer is null, or if the line - number is outside the window. + number is outside the window boundaries. The constant ERR is distinct from TRUE and FALSE, which are the normal return values of this function. Because the function @@ -111,7 +111,7 @@ wtouchln returns an error if the window pointer is null, or if the line - number is outside the window. + number is outside the window boundaries.
NOTES
@@ -125,8 +125,8 @@ does not check the window parameter win to ensure that it is not NULL; otherwise this implementation behaves the same as SVr4. - The XSI Curses standard, Issue 4 describes these functions, but defines - no error conditions. + X/Open Curses, Issue 4 describes these functions, but defines no error + conditions.
SEE ALSO
@@ -134,7 +134,7 @@ -ncurses 6.4 2024-03-16 curs_touch(3x) +ncurses 6.4 2024-04-20 curs_touch(3x)

diff --git a/doc/html/man/curs_trace.3x.html b/doc/html/man/curs_trace.3x.html index dbbf128c..ef2dfcaf 100644 --- a/doc/html/man/curs_trace.3x.html +++ b/doc/html/man/curs_trace.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_trace.3x,v 1.47 2024/03/16 15:35:01 tom Exp @ + * @Id: curs_trace.3x,v 1.50 2024/04/20 21:24:19 tom Exp @ --> -curs_trace 3x 2024-03-16 ncurses 6.4 Library calls +curs_trace 3x 2024-04-20 ncurses 6.4 Library calls -
curs_trace 3x 2024-03-16 ncurses 6.4 Library calls
+
curs_trace 3x 2024-04-20 ncurses 6.4 Library calls

curs_trace(3x) Library calls curs_trace(3x) @@ -55,7 +55,7 @@
SYNOPSIS
#include <curses.h> - unsigned curses_trace(const unsigned param); + unsigned curses_trace(const unsigned trace-mask); void _tracef(const char *format, ...); @@ -63,7 +63,7 @@ char *_traceattr2(int buffer, chtype ch); char *_tracecchar_t(const cchar_t *string); char *_tracecchar_t2(int buffer, const cchar_t *string); - char *_tracechar(int ch); + char *_tracechar(int c); char *_tracechtype(chtype ch); char *_tracechtype2(int buffer, chtype ch); @@ -72,7 +72,7 @@ char *_tracemouse(const MEVENT *event); /* deprecated */ - void trace(const unsigned int param); + void trace(const unsigned int trace-mask);
DESCRIPTION
@@ -219,9 +219,9 @@
PORTABILITY
- These functions are not part of the XSI interface. Some other curses - implementations are known to have similar features, but they are not - compatible with ncurses: + These functions are not part of the X/Open Curses interface. Some + other curses implementations are known to have similar features, but + they are not compatible with ncurses: o SVr4 provided traceon and traceoff, to control whether debugging information was written to the "trace" file. While the functions @@ -261,7 +261,7 @@ -ncurses 6.4 2024-03-16 curs_trace(3x) +ncurses 6.4 2024-04-20 curs_trace(3x)

diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html index a923c765..9b6c3655 100644 --- a/doc/html/man/curs_util.3x.html +++ b/doc/html/man/curs_util.3x.html @@ -28,19 +28,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_util.3x,v 1.98 2024/03/16 15:50:09 tom Exp @ + * @Id: curs_util.3x,v 1.101 2024/04/20 21:20:07 tom Exp @ --> -curs_util 3x 2024-03-16 ncurses 6.4 Library calls +curs_util 3x 2024-04-20 ncurses 6.4 Library calls -
curs_util 3x 2024-03-16 ncurses 6.4 Library calls
+
curs_util 3x 2024-04-20 ncurses 6.4 Library calls

curs_util(3x) Library calls curs_util(3x) @@ -56,11 +56,11 @@
SYNOPSIS
#include <curses.h> - const char *unctrl(chtype c); - wchar_t *wunctrl(cchar_t *c); + const char *unctrl(chtype ch); + wchar_t *wunctrl(cchar_t *wch); const char *keyname(int c); - const char *key_name(wchar_t w); + const char *key_name(wchar_t wc); void filter(void); @@ -81,7 +81,7 @@
unctrl
The unctrl routine returns a character string which is a printable - representation of the character c: + representation of the character ch: o Printable characters are displayed as themselves, e.g., a one- character string containing the key. @@ -99,7 +99,7 @@ this follows the X/Open specification. The corresponding wunctrl returns a printable representation of a - complex character c. + complex character wch. In both unctrl and wunctrl the attributes and color associated with the character parameter are ignored. @@ -269,8 +269,8 @@
filter
The SVr4 documentation describes the action of filter only in the - vaguest terms. The description here is adapted from the XSI Curses - standard (which erroneously fails to describe the disabling of cuu). + vaguest terms. The description here is adapted from X/Open Curses + (which erroneously fails to describe the disabling of cuu).
delay_output padding
@@ -333,10 +333,10 @@
unctrl, wunctrl
- The XSI Curses standard, Issue 4 describes these functions. It states - that unctrl and wunctrl will return a null pointer if unsuccessful, but - does not define any error conditions. This implementation checks for - three cases: + X/Open Curses, Issue 4 describes these functions. It states that + unctrl and wunctrl will return a null pointer if unsuccessful, but does + not define any error conditions. This implementation checks for three + cases: o the parameter is a 7-bit US-ASCII code. This is the case that X/Open Curses documented. @@ -392,7 +392,7 @@ -ncurses 6.4 2024-03-16 curs_util(3x) +ncurses 6.4 2024-04-20 curs_util(3x)

diff --git a/doc/html/man/curs_window.3x.html b/doc/html/man/curs_window.3x.html index b456816c..6165a34d 100644 --- a/doc/html/man/curs_window.3x.html +++ b/doc/html/man/curs_window.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_window.3x,v 1.46 2024/03/16 15:35:01 tom Exp @ + * @Id: curs_window.3x,v 1.48 2024/04/20 21:20:07 tom Exp @ --> -curs_window 3x 2024-03-16 ncurses 6.4 Library calls +curs_window 3x 2024-04-20 ncurses 6.4 Library calls -
curs_window 3x 2024-03-16 ncurses 6.4 Library calls
+
curs_window 3x 2024-04-20 ncurses 6.4 Library calls

curs_window(3x) Library calls curs_window(3x) @@ -217,7 +217,7 @@
PORTABILITY
- The XSI Curses standard, Issue 4 describes these functions. + X/Open Curses, Issue 4 describes these functions. X/Open Curses states regarding delwin: @@ -256,7 +256,7 @@ -ncurses 6.4 2024-03-16 curs_window(3x) +ncurses 6.4 2024-04-20 curs_window(3x)

diff --git a/doc/html/man/form_driver.3x.html b/doc/html/man/form_driver.3x.html index ef8bc886..a1c536e4 100644 --- a/doc/html/man/form_driver.3x.html +++ b/doc/html/man/form_driver.3x.html @@ -28,19 +28,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: form_driver.3x,v 1.59 2024/03/16 15:35:01 tom Exp @ + * @Id: form_driver.3x,v 1.61 2024/04/20 18:55:09 tom Exp @ --> -form_driver 3x 2024-03-16 ncurses 6.4 Library calls +form_driver 3x 2024-04-20 ncurses 6.4 Library calls -
form_driver 3x 2024-03-16 ncurses 6.4 Library calls
+
form_driver 3x 2024-04-20 ncurses 6.4 Library calls

form_driver(3x) Library calls form_driver(3x) @@ -55,7 +55,7 @@ #include <form.h> int form_driver(FORM *form, int c); - int form_driver_w(FORM *form, int c, wchar_t wch); + int form_driver_w(FORM *form, int c, wchar_t wc);
DESCRIPTION
@@ -275,7 +275,7 @@ -ncurses 6.4 2024-03-16 form_driver(3x) +ncurses 6.4 2024-04-20 form_driver(3x)

diff --git a/doc/html/man/legacy_coding.3x.html b/doc/html/man/legacy_coding.3x.html index ec099513..29b42500 100644 --- a/doc/html/man/legacy_coding.3x.html +++ b/doc/html/man/legacy_coding.3x.html @@ -28,19 +28,19 @@ * authorization. * **************************************************************************** * Author: Thomas E. Dickey - * @Id: legacy_coding.3x,v 1.26 2024/03/16 15:35:01 tom Exp @ + * @Id: legacy_coding.3x,v 1.28 2024/04/20 19:13:50 tom Exp @ --> -legacy_coding 3x 2024-03-16 ncurses 6.4 Library calls +legacy_coding 3x 2024-04-20 ncurses 6.4 Library calls -
legacy_coding 3x 2024-03-16 ncurses 6.4 Library calls
+
legacy_coding 3x 2024-04-20 ncurses 6.4 Library calls

legacy_coding(3x) Library calls legacy_coding(3x) @@ -58,39 +58,39 @@
DESCRIPTION
- The use_legacy_coding function is an extension to the curses library. - It allows the caller to change the result of unctrl, and suppress - related checks within the library that would normally cause nonprinting - characters to be rendered in visible form. This affects only 8-bit - characters. + use_legacy_coding is an extension to the curses library. It allows the + caller to change the result of unctrl(3x), suppressing isprint(3)-based + checks within the library that would normally cause nonprinting + characters to be rendered in visible form. The alteration affects only + eight-bit characters. - The level parameter controls the result: + The level parameter controls the result. - 0 the library functions normally, rendering nonprinting - characters as described in unctrl. + 0 The library functions normally, rendering nonprinting + characters as described in unctrl(3x), - 1 the library ignores isprintf for codes in the range - 160-255. + 1 the library ignores isprint for codes in the range 160-255. - 2 the library ignores isprintf for codes in the range - 128-255. It also modifies the output of unctrl, showing - codes in the range 128-159 as is. + 2 the library ignores isprint for codes in the range 128-255. + It also modifies the output of unctrl(3x), showing codes in + the range 128-159 as is.
RETURN VALUE
- If the screen has not been initialized, or the level parameter is out - of range, the function returns ERR. Otherwise, it returns the previous - level: 0, 1 or 2. + If the screen has not been initialized, or the level parameter is out + of range, use_legacy_coding returns ERR. Otherwise, it returns the + previous level: 0, 1, or 2.
PORTABILITY
- This routine is specific to ncurses. It was 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. + use_legacy_coding is specific to ncurses. It was not supported on + Version 7, BSD or System V implementations. Applications employing + ncurses extensions should condition their use on the visibility of the + NCURSES_VERSION preprocessor macro.
AUTHORS
- Thomas Dickey (to support lynx's font-switching feature). + Thomas Dickey (to support lynx(1)'s font-switching feature).
SEE ALSO
@@ -98,7 +98,7 @@ -ncurses 6.4 2024-03-16 legacy_coding(3x) +ncurses 6.4 2024-04-20 legacy_coding(3x)

diff --git a/doc/html/man/ncurses.3x.html b/doc/html/man/ncurses.3x.html index fcd1725b..741ce949 100644 --- a/doc/html/man/ncurses.3x.html +++ b/doc/html/man/ncurses.3x.html @@ -28,19 +28,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: ncurses.3x,v 1.207 2024/04/14 00:34:00 tom Exp @ + * @Id: ncurses.3x,v 1.210 2024/04/20 21:24:19 tom Exp @ --> -ncurses 3x 2024-04-13 ncurses 6.4 Library calls +ncurses 3x 2024-04-20 ncurses 6.4 Library calls -
ncurses 3x 2024-04-13 ncurses 6.4 Library calls
+
ncurses 3x 2024-04-20 ncurses 6.4 Library calls

ncurses(3x) Library calls ncurses(3x) @@ -61,7 +61,7 @@ terminals with output optimized to minimize screen updates. ncurses replaces the curses libraries from System V Release 4 Unix ("SVr4") and 4.4BSD Unix, the development of which ceased in the 1990s. This - describes ncurses version 6.4 (patch 20240413). + document describes ncurses version 6.4 (patch 20240420). ncurses permits control of the terminal screen's contents; abstraction and subdivision thereof with windows and pads; the reading of terminal @@ -235,6 +235,10 @@ parameters. bf bool (TRUE or FALSE) + c a char or int + ch a chtype + wc a wchar_t or wint_t + wch a cchar_t win pointer to a WINDOW pad pointer to a WINDOW that is a pad @@ -376,11 +380,11 @@ doupdate curs_refresh(3x) dupwin curs_window(3x) echo curs_inopts(3x) + echo_wchar curs_add_wch(3x) echochar curs_addch(3x) endwin curs_initscr(3x) erase curs_clear(3x) - erasechar curs_termattrs(3x) erasewchar curs_termattrs(3x) exit_curses curs_memleaks(3x)* @@ -442,11 +446,11 @@ init_pair curs_color(3x) initscr curs_initscr(3x) innstr curs_instr(3x) + innwstr curs_inwstr(3x) ins_nwstr curs_ins_wstr(3x) ins_wch curs_ins_wch(3x) ins_wstr curs_ins_wstr(3x) - insch curs_insch(3x) insdelln curs_deleteln(3x) insertln curs_deleteln(3x) @@ -508,11 +512,11 @@ mvget_wch curs_get_wch(3x) mvget_wstr curs_get_wstr(3x) mvgetch curs_getch(3x) + mvgetn_wstr curs_get_wstr(3x) mvgetnstr curs_getstr(3x) mvgetstr curs_getstr(3x) mvhline curs_border(3x) - mvhline_set curs_border_set(3x) mvin_wch curs_in_wch(3x) mvin_wchnstr curs_in_wchstr(3x) @@ -574,11 +578,11 @@ mvwprintw curs_printw(3x) mvwscanw curs_scanw(3x) mvwvline curs_border(3x) + mvwvline_set curs_border_set(3x) napms curs_kernel(3x) newpad curs_pad(3x) newterm curs_initscr(3x) - newwin curs_window(3x) nl curs_inopts(3x) nocbreak curs_inopts(3x) @@ -640,11 +644,11 @@ slk_init curs_slk(3x) slk_label curs_slk(3x) slk_noutrefresh curs_slk(3x) + slk_refresh curs_slk(3x) slk_restore curs_slk(3x) slk_set curs_slk(3x) slk_touch curs_slk(3x) - slk_wset curs_slk(3x) standend curs_attr(3x) standout curs_attr(3x) @@ -706,11 +710,11 @@ waddnwstr curs_addwstr(3x) waddstr curs_addstr(3x) waddwstr curs_addwstr(3x) + wattr_get curs_attr(3x) wattr_off curs_attr(3x) wattr_on curs_attr(3x) wattr_set curs_attr(3x) - wattroff curs_attr(3x) wattron curs_attr(3x) wattrset curs_attr(3x) @@ -772,11 +776,11 @@ wscanw curs_scanw(3x) wscrl curs_scroll(3x) wsetscrreg curs_outopts(3x) + wstandend curs_attr(3x) wstandout curs_attr(3x) wsyncdown curs_window(3x) wsyncup curs_window(3x) - wtimeout curs_inopts(3x) wtouchln curs_touch(3x) wunctrl curs_util(3x) @@ -796,9 +800,9 @@ Unless otherwise noted, functions that return an integer return OK on success and ERR on failure. Functions that return pointers return NULL on failure. Typically, ncurses treats a null pointer passed as a - function parameter as a failure. Functions with a "mv" prefix first - perform cursor movement using wmove(3x) and fail if the position is - outside the window. + function parameter as a failure. Functions prefixed with "mv" first + perform cursor movement and fail if the position (y, x) is outside the + window boundaries.
ENVIRONMENT
@@ -1035,119 +1039,97 @@
TERM
- Denotes your terminal type. Each terminal type is distinct, though - many are similar. - - TERM is commonly set by terminal emulators to help applications find a - workable terminal description. Some of those choose a popular - approximation, e.g., "ansi", "vt100", "xterm" rather than an exact fit. - Not infrequently, your application will have problems with that - approach, e.g., incorrect function-key definitions. - - If you set TERM in your environment, it has no effect on the operation - of the terminal emulator. It only affects the way applications work - within the terminal. Likewise, as a general rule (xterm(1) being a - rare exception), terminal emulators which allow you to specify TERM as - a parameter or configuration value do not change their behavior to - match that setting. + The TERM variable denotes the terminal type. Each is distinct, though + many are similar. It is commonly set by terminal emulators to help + applications find a workable terminal description. Some choose a + popular approximation such as "ansi", "vt100", or "xterm" rather than + an exact fit to their capabilities. Not infrequently, an application + will have problems with that approach; for example, a key stroke may + not operate correctly, or produce no effect but seeming garbage + characters on the screen. + + Setting TERM has no effect on hardware operation; it affects the way + applications communicate with the terminal. Likewise, as a general + rule (xterm(1) being a rare exception), terminal emulators that allow + you to specify TERM as a parameter or configuration value do not change + their behavior to match that setting.
TERMCAP
- If the ncurses library has been configured with termcap support, - ncurses will check for a terminal's description in termcap form if it - is not available in the terminfo database. - - The TERMCAP environment variable contains either a terminal description - (with newlines stripped out), or a file name telling where the - information denoted by the TERM environment variable exists. In either - case, setting it directs ncurses to ignore the usual place for this - information, e.g., /etc/termcap. + If ncurses is configured with termcap support, it checks for a terminal + type description in termcap format if one in terminfo format is not + available. Setting this variable directs ncurses to ignore the usual + termcap database location, /etc/termcap; see TERMPATH below. TERMCAP + should contain either a terminal description (with newlines stripped + out), or a file name indicating where the information required by the + TERM environment variable is stored.
TERMINFO
- ncurses can be configured to read from multiple terminal databases. - The TERMINFO variable overrides the location for the default terminal - database. Terminal descriptions (in terminal format) are stored in - terminal databases: - - o Normally these are stored in a directory tree, using subdirectories - named by the first letter of the terminal names therein. - - This is the scheme used in System V, which legacy Unix systems use, - and the TERMINFO variable is used by curses applications on those - systems to override the default location of the terminal database. - - o If ncurses is built to use hashed databases, then each entry in - this list may be the path of a hashed database file, e.g., - - /usr/share/terminfo.db + ncurses can be configured to read terminal type description databases + in various locations using different formats. This variable overrides + the default location. - rather than + o Descriptions in terminfo format are normally stored in a directory + tree using subdirectories named by the common first letters of the + terminal types named therein. This is the scheme used in System V. - /usr/share/terminfo/ + o If ncurses is configured to use hashed databases, then TERMINFO may + name its location, such as /usr/share/terminfo.db, rather than + /usr/share/terminfo/. - The hashed database uses less disk-space and is a little faster - than the directory tree. However, some applications assume the - existence of the directory tree, reading it directly rather than - using the terminfo library calls. + The hashed database uses less disk space and is a little faster than + the directory tree. However, some applications assume the existence of + the directory tree, and read it directly rather than using the terminfo + API. - o If ncurses is built with a support for reading termcap files - directly, then an entry in this list may be the path of a termcap - file. + o If ncurses is configured with termcap support, this variable may + contain the location of a termcap file. - o If the TERMINFO variable begins with "hex:" or "b64:", ncurses uses - the remainder of that variable as a compiled terminal description. - You might produce the base64 format using infocmp(1m): + o If the value of TERMINFO begins with "hex:" or "b64:", ncurses uses + the remainder of the value as a compiled terminfo description. You + might produce the base64 format using infocmp(1m). - TERMINFO="$(infocmp -0 -Q2 -q)" - export TERMINFO + TERMINFO=$(infocmp -0 -Q2 -q) + export TERMINFO - The compiled description is used if it corresponds to the terminal - identified by the TERM variable. + The compiled description is used only if it corresponds to the + terminal type identified by TERM. - Setting TERMINFO is the simplest, but not the only way to set location - of the default terminal database. The complete list of database - locations in order follows: + Setting TERMINFO is the simplest, but not the only, way to direct + ncurses to a terminal database. The search path is as follows. - o the last terminal database to which ncurses wrote, if any, is - searched first + o the last terminal database to which the running ncurses application + wrote, if any - o the location specified by the TERMINFO environment variable + o the location specified by the TERMINFO environment variable - o $HOME/.terminfo + o $HOME/.terminfo - o locations listed in the TERMINFO_DIRS environment variable + o locations listed in the TERMINFO_DIRS environment variable - o one or more locations whose names are configured and compiled - into the ncurses library, i.e., + o location(s) configured and compiled into ncurses - o /usr/share/terminfo (corresponding to the TERMINFO_DIRS - variable) - - o /usr/share/terminfo (corresponding to the TERMINFO variable) + o /usr/share/terminfo
TERMINFO_DIRS
- Specifies a list of locations to search for terminal descriptions. - Each location in the list is a terminal database as described in the - section on the TERMINFO variable. The list is separated by colons - (i.e., ":") on Unix, semicolons on OS/2 EMX. - - There is no corresponding feature in System V terminfo; it is an - extension developed for ncurses. + This variable specifies a list of locations, akin to PATH, in which + ncurses searches for the terminal type descriptions described by + TERMINFO above. The list items are separated by colons on Unix and + semicolons on OS/2 EMX. System V terminfo lacks a corresponding + feature; TERMINFO_DIRS is an ncurses extension.
TERMPATH
- If TERMCAP does not hold a file name then ncurses checks the TERMPATH - environment variable. This is a list of filenames separated by spaces - or colons (i.e., ":") on Unix, semicolons on OS/2 EMX. - - If the TERMPATH environment variable is not set, ncurses looks in the - files - - /etc/termcap, /usr/share/misc/termcap and $HOME/.termcap, + If TERMCAP does not hold a terminal type description or file name, then + ncurses checks the contents of TERMPATH, a list of locations, akin to + PATH, in which it searches for termcap terminal type descriptions. The + list items are separated by colons on Unix and semicolons on OS/2 EMX. - in that order. + If both TERMCAP and TERMPATH are unset or invalid, ncurses searches for + the files /etc/termcap, /usr/share/misc/termcap, and $HOME/.termcap, in + that order.
ALTERNATE CONFIGURATIONS
@@ -1156,7 +1138,7 @@ the script with the --help option to peruse them all. A few are of particular significance to the application developer employing ncurses. - --disable-overwrite + --disable-overwrite The standard include for ncurses is as noted in SYNOPSIS: #include <curses.h> @@ -1171,7 +1153,7 @@ It also omits a symbolic link which would allow you to use -lcurses to build executables. - --enable-widec + --enable-widec The configure script renames the library and (if the --disable-overwrite option is used) puts the header files in a different subdirectory. All of the library names have a "w" @@ -1186,7 +1168,7 @@ You must also enable the wide-character features in the header file when compiling for the wide-character library to use the extended (wide-character) functions. The symbol which enables - these features has changed since XSI Curses, Issue 4: + these features has changed since X/Open Curses, Issue 4: o Originally, the wide-character feature required the symbol _XOPEN_SOURCE_EXTENDED but that was only valid for XPG4 @@ -1214,7 +1196,7 @@ applications to be built using either library from the same set of headers. - --with-pthread + --with-pthread The configure script renames the library. All of the library names have a "t" appended to them (before any "w" added by --enable-widec). @@ -1224,19 +1206,16 @@ to set these values. Some applications (very few) may require changes to work with this convention. - --with-shared - - --with-normal - - --with-debug - - --with-profile + --with-shared + --with-normal + --with-debug + --with-profile The shared and normal (static) library names differ by their suffixes, e.g., libncurses.so and libncurses.a. The debug and profiling libraries add a "_g" and a "_p" to the root names respectively, e.g., libncurses_g.a and libncurses_p.a. - --with-termlib + --with-termlib Low-level functions which do not depend upon whether the library supports wide-characters, are provided in the tinfo library. @@ -1260,7 +1239,7 @@ o curs_util(3x) - miscellaneous curses utility routines - --with-trace + --with-trace The trace function normally resides in the debug library, but it is sometimes useful to configure this in the shared library. Configure scripts should check for the function's existence rather @@ -1291,15 +1270,15 @@ If the standard output file descriptor of an ncurses program is redirected to something that is not a terminal device, the library writes screen updates to the standard error file descriptor. This was - an undocumented feature of SVr3. + an undocumented feature of SVr3 curses. - See subsection "Header files" below regarding symbols exposed by + See subsection "Header Files" below regarding symbols exposed by inclusion of curses.h.
EXTENSIONS
ncurses enables an application to capture mouse events on certain - terminals, including xterm; see curs_mouse(3x). + terminals, including xterm(1); see curs_mouse(3x). ncurses provides a means of responding to window resizing events, as when running in a GUI terminal emulator application such as xterm; see @@ -1310,8 +1289,8 @@ ncurses extends the fixed set of function key capabilities specified by X/Open Curses by allowing the application programmer to define - additional key sequences at runtime; see define_key(3x), - key_defined(3x), and keyok(3x). + additional key events at runtime; see define_key(3x), key_defined(3x), + keybound(3x), and keyok(3x). ncurses can exploit the capabilities of terminals implementing ISO 6429/ECMA-48 SGR 39 and SGR 49 sequences, which allow an @@ -1320,20 +1299,20 @@ to draw colored text on a background whose color is set independently, providing better control over color contrasts. See default_colors(3x). - An ncurses application can choose to hide the internal details of - WINDOW structures, instead using accessor functions such as - is_scrollok(3x). + An ncurses application can eschew knowledge of WINDOW structure + internals, instead using accessor functions such as is_scrollok(3x). - ncurses enables an application to direct application output to a + ncurses enables an application to direct application output to a printer attached to the terminal device; see curs_print(3x). - ncurses offers slk_attr(3x) as a counterpart of attr_get(3x) for soft- - label key lines, and extended_slk_color(3x) as a form of slk_color(3x) - that can gather color information from them when many colors are + ncurses offers slk_attr(3x) as a counterpart of attr_get(3x) for soft- + label key lines, and extended_slk_color(3x) as a form of slk_color(3x) + that can gather color information from them when many colors are supported. - Some extensions are only available if ncurses is compiled to support - them; section "ALTERNATE CONFIGURATIONS" describes how. + Some extensions are available only if ncurses permits modification of + unctrl(3x)'s behavior; see use_legacy_coding(3x). ncurses is compiled + to support them; section "ALTERNATE CONFIGURATIONS" describes how. o Rudimentary support for multi-threaded applications may be available; see curs_threads(3x). @@ -1363,7 +1342,7 @@ X/Open Curses defines two levels of conformance, "base" and "enhanced". The latter includes several additional features, such as wide-character and color support. ncurses intends base-level conformance with X/Open - Curses, and supports nearly all its enhanced features. + Curses, and supports nearly all features of its enhanced level. Differences between X/Open Curses and ncurses are documented in the "PORTABILITY" sections of applicable man pages. @@ -1373,113 +1352,117 @@ In many cases, X/Open Curses is vague about error conditions, omitting some of the SVr4 documentation. - Unlike other implementations, this one checks parameters such as - pointers to WINDOW structures to ensure they are not null. The main - reason for providing this behavior is to guard against programmer - error. The standard interface does not provide a way for the library - to tell an application which of several possible errors were detected. - Relying on this (or some other) extension will adversely affect the - portability of curses applications. + Unlike other implementations, ncurses checks pointer parameters, such + as those to WINDOW structures, to ensure that they are not null. This + is done primarily to guard against programmer error. The standard + interface does not provide a way for the library to tell an application + which of several possible errors occurred. Relying on this (or some + other) extension adversely affects the portability of curses + applications.
Padding Differences
- In historic curses versions, delays embedded in the capabilities cr, - ind, cub1, ff and tab activated corresponding delay bits in the Unix - tty driver. In this implementation, all padding is done by sending NUL - bytes. This method is slightly more expensive, but narrows the - interface to the Unix kernel significantly and increases the package's - portability correspondingly. + In historical curses implementations, delays embedded in the terminfo + capabilities carriage_return (cr), scroll_forward (ind), cursor_left + (cub1), form_feed (ff), and tab (ht) activated corresponding delay bits + in the Unix terminal driver. ncurses performs all padding by sending + NUL bytes to the device. This method is slightly more expensive, but + narrows the interface to the Unix kernel significantly and + correspondingly increases the package's portability.
Header Files
- The header file curses.h itself includes the header files stdio.h and + The header file curses.h itself includes the header files stdio.h and unctrl.h. - X/Open Curses has more to say, but does not finish the story: + X/Open Curses has more to say, - The inclusion of <curses.h> may make visible all symbols from the - headers <stdio.h>, <term.h>, <termios.h>, and <wchar.h>. + The inclusion of curses.h may make visible all symbols from the + headers stdio.h, term.h, termios.h, and wchar.h. - Here is a more complete story: + but does not finish the story. A more complete account follows. - o Starting with BSD curses, all implementations have included - <stdio.h>. + o Starting with 4BSD curses (1980) all implementations have provided + a curses.h file. - BSD curses included <curses.h> and <unctrl.h> from an internal - header file curses.ext ("ext" abbreviated "externs"). + BSD curses code included curses.h and unctrl.h from an internal + header file curses.ext, where "ext" abbreviated "externs". - BSD curses used <stdio.h> internally (for printw and scanw), but - nothing in <curses.h> itself relied upon <stdio.h>. + The implementations of printw and scanw used undocumented internal + functions of the standard I/O library (_doprnt and _doscan), but + nothing in curses.h itself relied upon stdio.h. - o SVr2 curses added newterm(3x), which relies upon <stdio.h>. That - is, the function prototype uses FILE. + o SVr2 curses added newterm, which relies upon stdio.h because its + function prototype employs the FILE type. - SVr4 curses added putwin and getwin, which also use <stdio.h>. + SVr4 curses added putwin and getwin, which also use stdio.h. - X/Open Curses documents all three of these functions. + X/Open Curses specifies all three of these functions. - SVr4 curses and X/Open Curses do not require the developer to - include <stdio.h> before including <curses.h>. Both document - curses showing <curses.h> as the only required header. + SVr4 curses and X/Open Curses do not require the developer to + include stdio.h before curses.h. Both document use of curses as + requiring only curses.h. - As a result, standard <curses.h> will always include <stdio.h>. + As a result, standard curses.h always includes stdio.h. - o X/Open Curses is inconsistent with respect to SVr4 regarding - <unctrl.h>. + o X/Open Curses and SVr4 curses are inconsistent with respect to + unctrl.h. - As noted in curs_util(3x), ncurses includes <unctrl.h> from - <curses.h> (like SVr4). + As noted in curs_util(3x), ncurses includes unctrl.h from curses.h + (as SVr4 does). - o X/Open's comments about <term.h> and <termios.h> may refer to HP-UX - and AIX: + o X/Open Curses's comments about term.h and termios.h may refer to + HP-UX and AIX. - HP-UX curses includes <term.h> from <curses.h> to declare setupterm - in curses.h, but ncurses (and Solaris curses) do not. + HP-UX curses includes term.h from curses.h to declare setupterm in + curses.h, but ncurses and Solaris curses do not. - AIX curses includes <term.h> and <termios.h>. Again, ncurses (and - Solaris curses) do not. + AIX curses includes term.h and termios.h. Again, ncurses and + Solaris curses do not. - o X/Open says that <curses.h> may include <term.h>, but there is no - requirement that it do that. + o X/Open Curses says that curses.h may include term.h, but does not + require it to do so. - Some programs use functions declared in both <curses.h> and - <term.h>, and must include both headers in the same module. Very - old versions of AIX curses required including <curses.h> before - including <term.h>. + Some programs use functions declared in both curses.h and term.h, + and must include both header files in the same module. Very old + versions of AIX curses required inclusion of curses.h before + term.h. - Because ncurses header files include the headers needed to define - datatypes used in the headers, ncurses header files can be included - in any order. But for portability, you should include <curses.h> - before <term.h>. + The header files supplied by ncurses include the standard library + headers required for its declarations, so ncurses's own header + files can be included in any order. But for portability, you + should include curses.h before term.h. - o X/Open Curses says "may make visible" because including a header - file does not necessarily make all symbols in it visible (there are - ifdef's to consider). + o X/Open Curses says "may make visible" because including a header + file does not necessarily make visible all of the symbols in it + (consider #ifdef and similar). - For instance, in ncurses <wchar.h> may be included if the proper + For instance, ncurses's curses.h may include wchar.h if the proper symbol is defined, and if ncurses is configured for wide-character - support. If the header is included, its symbols may be made - visible. That depends on the value used for _XOPEN_SOURCE feature - test macro. - - o X/Open Curses documents one required header, in a special case: - <stdarg.h> before <curses.h> to prototype the vw_printw and - vw_scanw functions (as well as the obsolete the vwprintw and - vwscanw functions). Each of those uses a va_list parameter. - - The two obsolete functions were introduced in SVr3. The other - functions were introduced in X/Open Curses. In between, SVr4 - curses provided for the possibility that an application might - include either <varargs.h> or <stdarg.h>. Initially, that was done - by using void* for the va_list parameter. Later, a special type - (defined in <stdio.h>) was introduced, to allow for compiler type- - checking. That special type is always available, because <stdio.h> - is always included by <curses.h>. - - None of the X/Open Curses implementations require an application to - include <stdarg.h> before <curses.h> because they either have - allowed for a special type, or (like ncurses) include <stdarg.h> - directly to provide a portable interface. + support. If wchar.h is included, its symbols may be made visible + depending on the value of the _XOPEN_SOURCE feature test macro. + + o X/Open Curses mandates an application's inclusion of one standard C + library header in a special case: stdarg.h before curses.h to + prototype the functions vw_printw and vw_scanw (as well as the + obsolete vwprintw and vwscanw). Each of these takes a variadic + argument list, a va_list parameter, like that of printf(3). + + SVr3 curses introduced the two obsolete functions, and X/Open + Curses the others. In between, SVr4 curses provided for the + possibility that an application might include either varargs.h or + stdarg.h. These represented contrasting approaches to handling + variadic argument lists. The older interface, varargs.h, used a + pointer to char for variadic functions' va_list parameter. Later, + the list acquired its own standard data type, va_list, defined in + stdarg.h, empowering the compiler to check the types of a function + call's actual parameters against the formal ones declared in its + prototype. + + No conforming implementations of X/Open Curses require an + application to include stdarg.h before curses.h because they either + have allowed for a special type, or, like ncurses, they include + stdarg.h themselves to provide a portable interface.
AUTHORS
@@ -1492,7 +1475,7 @@ -ncurses 6.4 2024-04-13 ncurses(3x) +ncurses 6.4 2024-04-20 ncurses(3x)

diff --git a/doc/html/man/ncursesw6-config.1.html b/doc/html/man/ncursesw6-config.1.html index f0be1977..089096f7 100644 --- a/doc/html/man/ncursesw6-config.1.html +++ b/doc/html/man/ncursesw6-config.1.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: MKncu_config.in,v 1.22 2023/12/23 23:44:26 tom Exp @ + * @Id: MKncu_config.in,v 1.23 2024/04/20 21:13:38 tom Exp @ --> -ncursesw6-config 1 2023-12-23 ncurses 6.4 User commands +ncursesw6-config 1 2024-04-20 ncurses 6.4 User commands -
ncursesw6-config 1 2023-12-23 ncurses 6.4 User commands
+
ncursesw6-config 1 2024-04-20 ncurses 6.4 User commands

ncursesw6-config(1) User commands ncursesw6-config(1) @@ -112,7 +112,7 @@ -ncurses 6.4 2023-12-23 ncursesw6-config(1) +ncurses 6.4 2024-04-20 ncursesw6-config(1)

diff --git a/doc/html/man/tabs.1.html b/doc/html/man/tabs.1.html index 9f409908..5f481882 100644 --- a/doc/html/man/tabs.1.html +++ b/doc/html/man/tabs.1.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: tabs.1,v 1.57 2024/03/16 15:35:01 tom Exp @ + * @Id: tabs.1,v 1.59 2024/04/20 19:08:15 tom Exp @ --> -tabs 1 2024-03-16 ncurses 6.4 User commands +tabs 1 2024-04-20 ncurses 6.4 User commands -
tabs 1 2024-03-16 ncurses 6.4 User commands
+
tabs 1 2024-04-20 ncurses 6.4 User commands

tabs(1) User commands tabs(1) @@ -214,43 +214,42 @@ A tabs utility appeared in PWB/Unix 1.0 (1977). A reduced version shipped in Seventh Edition Unix (early 1979) and in 3BSD (later the same year); it supported a "-n" option to set the first tab stop at the - left margin. That option is not documented by POSIX. + left margin. That option is not specified by POSIX. The PWB/Unix tabs utility returned in System III (1980), and used - built-in tables, rather than the terminal database, to support a half- - dozen hardcopy terminal (printer) types. It also had built-in logic to - support setting the left margin, as well as a feature for copying the - tab settings from a file. + built-in tables to support a half-dozen hardcopy terminal (printer) + types. It also had logic to support setting the left margin, as well + as a feature for copying the tab settings from a file. - Versions of the program in later releases of AT&T Unix, such as SVr4, - added support for the terminal database, but retained the tables to + Versions of the program in later releases of AT&T Unix, such as SVr4, + added support for the terminal database, but retained the tables to support the printers. By this time, System V tput had incorporated the - tab stop initialization feature of BSD's tset from 1982, but employed + tab stop initialization feature of BSD's tset from 1982, but employed the terminfo database to do so. - The +m option was documented in the POSIX Base Specifications Issue 5 - (Unix98, 1997), then omitted in Issue 6 (Unix03, 2004) without express - motivation, though an introductory comment "and optionally adjusts the - margin" remains, overlooked in the removal. The tabs utility - documented in Issues 6 and later has no mechanism for setting margins. - The +m option in ncurses tabs differs from the SVr4 feature by using + The +m option was documented in the POSIX Base Specifications Issue 5 + (Unix98, 1997), then omitted in Issue 6 (Unix03, 2004) without express + motivation, though an introductory comment "and optionally adjusts the + margin" remains, overlooked in the removal. The tabs utility + documented in Issues 6 and later has no mechanism for setting margins. + The +m option in ncurses tabs differs from the SVr4 feature by using terminal capabilities rather than built-in tables. - POSIX documents no limit on the number of tab stops. Other + POSIX documents no limit on the number of tab stops. Other implementations impose one; the limit is 20 in PWB/Unix's tabs utility. - While some terminals may not accept an arbitrary number of tab stops, - ncurses tabs attempts to set tab stops up to the right margin if the + While some terminals may not accept an arbitrary number of tab stops, + ncurses tabs attempts to set tab stops up to the right margin if the list thereof is sufficiently long. - The "Rationale" section of the Issue 6 tabs reference page details how - the committee considered redesigning the tabs and tput utilities, + The "Rationale" section of the Issue 6 tabs reference page details how + the committee considered redesigning the tabs and tput utilities, without settling on an improved solution. It claims that - "no known historical version of tabs supports the capability of + "no known historical version of tabs supports the capability of setting arbitrary tab stops." - The feature described in subsection "Explicit Lists" above was - implemented in PWB/Unix, and permitted the setting of abitrary tab + The feature described in subsection "Explicit Lists" above was + implemented in PWB/Unix, and permitted the setting of abitrary tab stops nevertheless. @@ -259,7 +258,7 @@ -ncurses 6.4 2024-03-16 tabs(1) +ncurses 6.4 2024-04-20 tabs(1)

diff --git a/doc/html/man/term.5.html b/doc/html/man/term.5.html index 9a62438e..00b75348 100644 --- a/doc/html/man/term.5.html +++ b/doc/html/man/term.5.html @@ -28,19 +28,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: term.5,v 1.75 2024/03/16 15:35:01 tom Exp @ + * @Id: term.5,v 1.77 2024/04/20 21:24:19 tom Exp @ --> -term 5 2024-03-16 ncurses 6.4 File formats +term 5 2024-04-20 ncurses 6.4 File formats -
term 5 2024-03-16 ncurses 6.4 File formats
+
term 5 2024-04-20 ncurses 6.4 File formats

term(5) File formats term(5) @@ -281,9 +281,9 @@ versions. The problem is that there are at least three versions of terminfo (under HP-UX, AIX, and OSF/1) which diverged from System V terminfo after SVr1, and have added extension capabilities to the - string table that (in the binary format) collide with System V and XSI - Curses extensions. See terminfo(5) for detailed discussion of terminfo - source compatibility issues. + string table that (in the binary format) collide with System V and + X/Open Curses extensions. See terminfo(5) for detailed discussion of + terminfo source compatibility issues. This implementation is by default compatible with the binary terminfo format used by Solaris curses, except in a few less-used details where @@ -399,7 +399,7 @@ -ncurses 6.4 2024-03-16 term(5) +ncurses 6.4 2024-04-20 term(5)

diff --git a/doc/html/man/terminfo.5.html b/doc/html/man/terminfo.5.html index 6487df0a..febc1833 100644 --- a/doc/html/man/terminfo.5.html +++ b/doc/html/man/terminfo.5.html @@ -32,19 +32,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: terminfo.head,v 1.63 2024/01/13 23:07:27 tom Exp @ + * @Id: terminfo.head,v 1.65 2024/04/20 21:14:00 tom Exp @ --> -terminfo 5 2024-01-13 ncurses 6.4 File formats +terminfo 5 2024-04-20 ncurses 6.4 File formats -
terminfo 5 2024-01-13 ncurses 6.4 File formats
+
terminfo 5 2024-04-20 ncurses 6.4 File formats

terminfo(5) File formats terminfo(5) @@ -71,7 +71,7 @@ have, by specifying how to perform screen operations, and by specifying padding requirements and initialization sequences. - This manual describes ncurses version 6.4 (patch 20240413). + This document describes ncurses version 6.4 (patch 20240420).
terminfo Entry Syntax
@@ -225,8 +225,8 @@ codes exceed this limit regardless.) o The TC (termcap) code is that used by the corresponding API of - ncurses. (Some capabilities are new, and have names that BSD term- - cap did not originate.) + ncurses. (Some capabilities are new, and have names that BSD + termcap did not originate.) o The description field attempts to convey the capability's semantics. @@ -723,8 +723,8 @@ clear_margins mgc MC clear right and left soft margins set_left_margin smgl ML set left soft margin at - current column. (ML is not in - BSD termcap). + current column (not in BSD + termcap) set_right_margin smgr MR set right soft margin at current column label_format fln Lf label format @@ -1585,7 +1585,7 @@ screen, write something to the bottom line, move the cursor to the top of the region, and do ri followed by dl1 or ind. If the data scrolled off the bottom of the region by the ri re-appears, then scrolling is - non-destructive. System V and XSI Curses expect that ind, ri, indn, + non-destructive. System V and X/Open Curses expect that ind, ri, indn, and rin will simulate destructive scrolling; their documentation cautions you not to define csr unless this is true. This curses implementation is more liberal and will do explicit erases after @@ -1605,7 +1605,7 @@
Insert/Delete Character
There are two basic kinds of intelligent terminals with respect to - insert/delete character which can be described using terminfo. The + insert/delete character which can be described using terminfo. The most common insert/delete character operations affect only the characters on the current line and shift characters off the end of the line rigidly. Other terminals, such as the Concept 100 and the Perkin @@ -1672,9 +1672,9 @@ works. Finally, you can specify dch1 to delete a single character, dch with - one parameter, n, to delete n characters, and delete mode by giving - smdc and rmdc to enter and exit delete mode (any mode the terminal - needs to be placed in for dch1 to work). + one parameter, n, to delete ncharacters, and delete mode by giving smdc + and rmdc to enter and exit delete mode (any mode the terminal needs to + be placed in for dch1 to work). A command to erase n characters (equivalent to outputting n blanks without moving the cursor) can be given as ech with one parameter. @@ -2426,8 +2426,8 @@ the Insert/Delete Character subsection above. The parameter substitutions for set_clock and display_clock are not - documented in SVr4 or the XSI Curses standard. They are deduced from - the documentation for the AT&T 505 terminal. + documented in SVr4 or X/Open Curses. They are deduced from the + documentation for the AT&T 505 terminal. Be careful assigning the kmous capability. The ncurses library wants to interpret it as KEY_MOUSE, for use by terminals and emulators like @@ -2442,9 +2442,9 @@ specified, even if it is zero. Different commercial ports of terminfo and curses support different - subsets of XSI Curses and (in some cases) different extensions. Here - is a summary, accurate as of October 1995, after which the commercial - Unix market contracted and lost diversity. + subsets of X/Open Curses and (in some cases) different extensions. + Here is a summary, accurate as of October 1995, after which the + commercial Unix market contracted and lost diversity. o SVr4, Solaris, and ncurses support all SVr4 capabilities. @@ -2471,7 +2471,7 @@ between commercial Unix systems. At least two implementations of terminfo (those of HP-UX and AIX) diverged from those of other System V Unices after SVr1, adding extension capabilities to the string table - that (in the binary format) collide with subsequent System V and XSI + that (in the binary format) collide with subsequent System V and X/Open Curses extensions. @@ -2487,7 +2487,7 @@ -ncurses 6.4 2024-01-13 terminfo(5) +ncurses 6.4 2024-04-20 terminfo(5)

diff --git a/doc/html/man/toe.1m.html b/doc/html/man/toe.1m.html index 46578230..f585ce13 100644 --- a/doc/html/man/toe.1m.html +++ b/doc/html/man/toe.1m.html @@ -28,19 +28,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: toe.1m,v 1.66 2024/03/16 15:35:01 tom Exp @ + * @Id: toe.1m,v 1.68 2024/04/20 18:59:26 tom Exp @ --> -toe 1m 2024-03-16 ncurses 6.4 User commands +toe 1m 2024-04-20 ncurses 6.4 User commands -
toe 1m 2024-03-16 ncurses 6.4 User commands
+
toe 1m 2024-04-20 ncurses 6.4 User commands

toe(1m) User commands toe(1m) @@ -75,10 +75,10 @@ terminfo would search, instead of only the first that it finds. - If the -s option is also given, toe adds a column to the - report, showing (like conflict(1)) which entries belong to a - given terminal database. An "*" marks entries that differ, - and "+" marks equivalent entries. + If -s is also given, toe additionally reports, like + conflict(1), which entries correspond to a given terminal + database. An "*" marks entries that differ, and "+" marks + equivalent entries. Without the -s option, toe does not attempt to merge duplicates in its report. @@ -185,7 +185,7 @@ -ncurses 6.4 2024-03-16 toe(1m) +ncurses 6.4 2024-04-20 toe(1m)

diff --git a/doc/html/man/tput.1.html b/doc/html/man/tput.1.html index 034dfe57..2292ec3d 100644 --- a/doc/html/man/tput.1.html +++ b/doc/html/man/tput.1.html @@ -28,19 +28,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: tput.1,v 1.111 2024/04/13 22:09:53 tom Exp @ + * @Id: tput.1,v 1.113 2024/04/20 19:58:50 tom Exp @ --> -tput 1 2024-04-13 ncurses 6.4 User commands +tput 1 2024-04-20 ncurses 6.4 User commands -
tput 1 2024-04-13 ncurses 6.4 User commands
+
tput 1 2024-04-20 ncurses 6.4 User commands

tput(1) User commands tput(1) @@ -104,9 +104,9 @@ cap-code indicates a capability from the terminal database. - If the capability is of string type and takes parameters, - the arguments following the capability will be used as its - parameters. + If cap-code is of string type and takes parameters, tput + interprets arguments following cap-code as the parameters, + up to the (fixed) quantity the capability requires. Most parameters are numeric. Only a few terminal capabilities require string parameters; tput uses a table to @@ -555,7 +555,7 @@ -ncurses 6.4 2024-04-13 tput(1) +ncurses 6.4 2024-04-20 tput(1)

diff --git a/doc/html/man/tset.1.html b/doc/html/man/tset.1.html index ed1ca612..3bfe8b6f 100644 --- a/doc/html/man/tset.1.html +++ b/doc/html/man/tset.1.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: tset.1,v 1.81 2024/03/16 15:35:01 tom Exp @ + * @Id: tset.1,v 1.83 2024/04/20 19:09:08 tom Exp @ --> -tset 1 2024-03-16 ncurses 6.4 User commands +tset 1 2024-04-20 ncurses 6.4 User commands -
tset 1 2024-03-16 ncurses 6.4 User commands
+
tset 1 2024-04-20 ncurses 6.4 User commands

tset(1) User commands tset(1) @@ -354,15 +354,15 @@ be from the operating system, the LINES and COLUMNS environment variables or the terminal description. - Obtaining the window size from the terminal description is common to - both implementations, but considered obsolescent. Its only practical - use is for hardware terminals. Generally speaking, a window size would - be unset only if there were some problem obtaining the value from the - operating system (and setupterm would still fail). For that reason, - the LINES and COLUMNS environment variables may be useful for working - around window-size problems. Those have the drawback that if the - window is resized, those variables must be recomputed and reassigned. - To do this more easily, use the resize(1) program. + Obtaining the window size from a terminal's type description is common + to both implementations, but considered obsolescent. Its only + practical use is for hardware terminals. Generally, the window size + will remain uninitialized only if there were a problem obtaining the + value from the operating system (and setupterm would still fail). The + LINES and COLUMNS environment variables may thus be useful for working + around window-size problems, but have the drawback that if the window + is resized, their values must be recomputed and reassigned. The + resize(1) program distributed with xterm(1) assists this activity.
HISTORY
@@ -393,7 +393,7 @@ -ncurses 6.4 2024-03-16 tset(1) +ncurses 6.4 2024-04-20 tset(1)

diff --git a/include/Caps b/include/Caps index ffd620d2..cd077b96 100644 --- a/include/Caps +++ b/include/Caps @@ -30,7 +30,7 @@ # Author: Zeyd M. Ben-Halim 1992,1995 # and: Eric S. Raymond # -# $Id: Caps,v 1.55 2024/03/16 15:26:09 Branden.Robinson Exp $ +# $Id: Caps,v 1.56 2024/04/20 21:05:02 tom Exp $ # # This is the master termcap/terminfo capability table. # @@ -210,12 +210,12 @@ #%(Some standard codes exceed this limit regardless.) #%.bP #%The TC -#%.RI ( \%term\%cap ) +#%.RI ( termcap ) #%code is that used by the corresponding API of -#%.I \%ncurses. +#%.IR \%ncurses . #%(Some capabilities are new, #%and have names that BSD -#%.I \%term\%cap +#%.I termcap #%did not originate.) #%.bP #%The description field attempts to convey the capability's semantics. @@ -650,7 +650,7 @@ key_f62 kf62 str Fq KEY_F(62) - ----E F62 function key key_f63 kf63 str Fr KEY_F(63) - ----E F63 function key clr_bol el1 str cb - - ----- Clear to beginning of line clear_margins mgc str MC - - ----- clear right and left soft margins -set_left_margin smgl str ML - - ----- set left soft margin at current column. (ML is not in BSD termcap). +set_left_margin smgl str ML - - ----- set left soft margin at current column (not in BSD \fItermcap\fP) set_right_margin smgr str MR - - ----- set right soft margin at current column label_format fln str Lf - - ----- label format set_clock sclk str SC - - ----- set clock, #1 hrs #2 mins #3 secs diff --git a/include/Caps.aix4 b/include/Caps.aix4 index 9b1ab8c9..1adb848e 100644 --- a/include/Caps.aix4 +++ b/include/Caps.aix4 @@ -29,7 +29,7 @@ # # Author: Thomas Dickey # -# $Id: Caps.aix4,v 1.27 2024/03/16 15:26:09 Branden.Robinson Exp $ +# $Id: Caps.aix4,v 1.28 2024/04/20 21:05:02 tom Exp $ # # This is an adaptation of ncurses' termcap/terminfo capability table, which # is designed to align with AIX 4.x's terminfo. @@ -210,12 +210,12 @@ #%(Some standard codes exceed this limit regardless.) #%.bP #%The TC -#%.RI ( \%term\%cap ) +#%.RI ( termcap ) #%code is that used by the corresponding API of -#%.I \%ncurses. +#%.IR \%ncurses . #%(Some capabilities are new, #%and have names that BSD -#%.I \%term\%cap +#%.I termcap #%did not originate.) #%.bP #%The description field attempts to convey the capability's semantics. @@ -752,7 +752,7 @@ key_sundo kUND str !3 KEY_SUNDO 0626 ----- shifted undo key req_for_input rfi str RF - - ----- send next input char (for ptys) clr_bol el1 str cb - - ----- Clear to beginning of line clear_margins mgc str MC - - ----- clear right and left soft margins -set_left_margin smgl str ML - - ----- set left soft margin at current column. (ML is not in BSD termcap). +set_left_margin smgl str ML - - ----- set left soft margin at current column (not in BSD \fItermcap\fP) set_right_margin smgr str MR - - ----- set right soft margin at current column label_format fln str Lf - - ----- label format set_clock sclk str SC - - ----- set clock, #1 hrs #2 mins #3 secs diff --git a/include/Caps.hpux11 b/include/Caps.hpux11 index 6087346b..723556fa 100644 --- a/include/Caps.hpux11 +++ b/include/Caps.hpux11 @@ -29,7 +29,7 @@ # # Author: Thomas Dickey # -# $Id: Caps.hpux11,v 1.25 2024/03/16 15:26:09 Branden.Robinson Exp $ +# $Id: Caps.hpux11,v 1.26 2024/04/20 21:05:02 tom Exp $ # # This is an adaptation of ncurses' termcap/terminfo capability table, which # is designed to align with HPUX 11.x's terminfo. @@ -210,12 +210,12 @@ #%(Some standard codes exceed this limit regardless.) #%.bP #%The TC -#%.RI ( \%term\%cap ) +#%.RI ( termcap ) #%code is that used by the corresponding API of -#%.I \%ncurses. +#%.IR \%ncurses . #%(Some capabilities are new, #%and have names that BSD -#%.I \%term\%cap +#%.I termcap #%did not originate.) #%.bP #%The description field attempts to convey the capability's semantics. @@ -658,7 +658,7 @@ key_sundo kUND str !3 KEY_SUNDO 0626 ----- shifted undo key req_for_input rfi str RF - - ----- send next input char (for ptys) clr_bol el1 str cb - - ----- Clear to beginning of line clear_margins mgc str MC - - ----- clear right and left soft margins -set_left_margin smgl str ML - - ----- set left soft margin at current column. (ML is not in BSD termcap). +set_left_margin smgl str ML - - ----- set left soft margin at current column (not in BSD \fItermcap\fP) set_right_margin smgr str MR - - ----- set right soft margin at current column label_format fln str Lf - - ----- label format set_clock sclk str SC - - ----- set clock, #1 hrs #2 mins #3 secs diff --git a/include/Caps.keys b/include/Caps.keys index dccb357f..6f8a84e3 100644 --- a/include/Caps.keys +++ b/include/Caps.keys @@ -30,7 +30,7 @@ # Author: Thomas Dickey # and: Ilya Zakharevich # -# $Id: Caps.keys,v 1.24 2024/03/16 15:26:09 Branden.Robinson Exp $ +# $Id: Caps.keys,v 1.25 2024/04/20 21:05:02 tom Exp $ # # This is an adaptation of ncurses' termcap/terminfo capability table, which # is illustrates an experimental extension to describe alt-, shift- and @@ -213,12 +213,12 @@ #%(Some standard codes exceed this limit regardless.) #%.bP #%The TC -#%.RI ( \%term\%cap ) +#%.RI ( termcap ) #%code is that used by the corresponding API of -#%.I \%ncurses. +#%.IR \%ncurses . #%(Some capabilities are new, #%and have names that BSD -#%.I \%term\%cap +#%.I termcap #%did not originate.) #%.bP #%The description field attempts to convey the capability's semantics. @@ -653,7 +653,7 @@ key_f62 kf62 str Fq KEY_F(62) - ----E F62 function key key_f63 kf63 str Fr KEY_F(63) - ----E F63 function key clr_bol el1 str cb - - ----- Clear to beginning of line clear_margins mgc str MC - - ----- clear right and left soft margins -set_left_margin smgl str ML - - ----- set left soft margin at current column. (ML is not in BSD termcap). +set_left_margin smgl str ML - - ----- set left soft margin at current column (not in BSD \fItermcap\fP) set_right_margin smgr str MR - - ----- set right soft margin at current column label_format fln str Lf - - ----- label format set_clock sclk str SC - - ----- set clock, #1 hrs #2 mins #3 secs diff --git a/include/Caps.osf1r5 b/include/Caps.osf1r5 index df641c2a..ece14aef 100644 --- a/include/Caps.osf1r5 +++ b/include/Caps.osf1r5 @@ -29,7 +29,7 @@ # # Author: Thomas Dickey # -# $Id: Caps.osf1r5,v 1.23 2024/03/16 15:26:09 Branden.Robinson Exp $ +# $Id: Caps.osf1r5,v 1.24 2024/04/20 21:05:02 tom Exp $ # # This is an adaptation of ncurses' termcap/terminfo capability table, which # is designed to align with OSF/1 version 5 (Tru64) terminfo. @@ -210,12 +210,12 @@ #%(Some standard codes exceed this limit regardless.) #%.bP #%The TC -#%.RI ( \%term\%cap ) +#%.RI ( termcap ) #%code is that used by the corresponding API of -#%.I \%ncurses. +#%.IR \%ncurses . #%(Some capabilities are new, #%and have names that BSD -#%.I \%term\%cap +#%.I termcap #%did not originate.) #%.bP #%The description field attempts to convey the capability's semantics. @@ -795,7 +795,7 @@ set_clock sclk str SC - - ----- set clock, #1 hrs #2 mins #3 secs set_color_band setcolor str Yz - - ----- Change to ribbon color #1 set_color_pair scp str sp - - ----- Set current color pair to #1 set_foreground setf str Sf - - ----- Set foreground color #1 -set_left_margin smgl str ML - - ----- set left soft margin at current column. (ML is not in BSD termcap). +set_left_margin smgl str ML - - ----- set left soft margin at current column (not in BSD \fItermcap\fP) set_left_margin_parm smglp str Zm - - ----- Set left (right) margin at column #1 set_lr_margin smglr str ML - - ----- Set both left and right margins to #1, #2. (ML is not in BSD termcap). set_page_length slines str YZ - - ----- Set page length to #1 lines diff --git a/include/Caps.uwin b/include/Caps.uwin index 6f4f083d..a41e9eca 100644 --- a/include/Caps.uwin +++ b/include/Caps.uwin @@ -29,7 +29,7 @@ # # Author: Thomas Dickey # -# $Id: Caps.uwin,v 1.22 2024/03/16 15:26:09 Branden.Robinson Exp $ +# $Id: Caps.uwin,v 1.23 2024/04/20 21:05:02 tom Exp $ # # This is an adaptation of ncurses' termcap/terminfo capability table, which # is designed to align with U/Win's terminfo. @@ -210,12 +210,12 @@ #%(Some standard codes exceed this limit regardless.) #%.bP #%The TC -#%.RI ( \%term\%cap ) +#%.RI ( termcap ) #%code is that used by the corresponding API of -#%.I \%ncurses. +#%.IR \%ncurses . #%(Some capabilities are new, #%and have names that BSD -#%.I \%term\%cap +#%.I termcap #%did not originate.) #%.bP #%The description field attempts to convey the capability's semantics. @@ -611,7 +611,7 @@ key_f62 kf62 str Fq KEY_F(62) - ----E F62 function key key_f63 kf63 str Fr KEY_F(63) - ----E F63 function key clr_bol el1 str cb - - ----- Clear to beginning of line clear_margins mgc str MC - - ----- clear right and left soft margins -set_left_margin smgl str ML - - ----- set left soft margin at current column. (ML is not in BSD termcap). +set_left_margin smgl str ML - - ----- set left soft margin at current column (not in BSD \fItermcap\fP) set_right_margin smgr str MR - - ----- set right soft margin at current column device_type devt str dv - - ----- Indicate language/codeset support code_set_init csin str ci - - ----- Init sequence for multiple codesets diff --git a/man/MKada_config.in b/man/MKada_config.in index 4e0a57eb..a017d09f 100644 --- a/man/MKada_config.in +++ b/man/MKada_config.in @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: MKada_config.in,v 1.32 2023/12/16 21:42:53 tom Exp $ -.TH adacurses@USE_CFG_SUFFIX@\-config 1 2023-12-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" +.\" $Id: MKada_config.in,v 1.34 2024/04/20 21:13:27 tom Exp $ +.TH adacurses@USE_CFG_SUFFIX@\-config 1 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" .ds C adacurses@USE_CFG_SUFFIX@\-config .ie \n(.g \{\ .ds `` \(lq @@ -43,6 +43,19 @@ .ie t .ds ' \(aq .el .ds ' ' .\} +. +.\" Fix broken EX/EE macros on DWB troff. +.\" Detect it: only DWB sets up a `)Y` register. +.if !\n(.g .if \n()Y \{\ +.\" Revert the undesired changes to indentation. +.am EX +.in -5n +.. +.am EE +.in +5n +.. +.\} +. .SH NAME \fB\%adacurses@USE_CFG_SUFFIX@\-config\fP \- configuration helper for \fI@ADA_LIBNAME@\fP libraries @@ -82,7 +95,7 @@ Consider a program using \fI@ADA_LIBNAME@\fP to write the message user to press the \*(``q\*('' key before exiting. Populate a file \fIhello.adb\fP with the following. .PP -.RS 4 +.if \n(LL>67n .RS 4 .EX with Terminal_Interface.Curses; use Terminal_Interface.Curses; @@ -115,7 +128,7 @@ begin End_Windows; end Hello; .EE -.RE +.if \n(LL>67n .RE .ne 2 .PP Then, using diff --git a/man/MKncu_config.in b/man/MKncu_config.in index ec6aa90a..461c8432 100644 --- a/man/MKncu_config.in +++ b/man/MKncu_config.in @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: MKncu_config.in,v 1.22 2023/12/23 23:44:26 tom Exp $ -.TH @LIB_NAME@@DFT_ARG_SUFFIX@@cf_cv_abi_version@-config 1 2023-12-23 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" +.\" $Id: MKncu_config.in,v 1.23 2024/04/20 21:13:38 tom Exp $ +.TH @LIB_NAME@@DFT_ARG_SUFFIX@@cf_cv_abi_version@-config 1 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" .SH NAME \fB\%@LIB_NAME@@DFT_ARG_SUFFIX@@cf_cv_abi_version@-config\fP \- configuration helper for \fI\%ncurses\fP libraries diff --git a/man/curs_add_wch.3x b/man/curs_add_wch.3x index b7c967cb..d1eb9a31 100644 --- a/man/curs_add_wch.3x +++ b/man/curs_add_wch.3x @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_add_wch.3x,v 1.59 2024/04/13 22:11:52 tom Exp $ -.TH curs_add_wch 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_add_wch.3x,v 1.62 2024/04/20 21:20:07 tom Exp $ +.TH curs_add_wch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -312,9 +312,11 @@ of bytes, or if it is not possible to add all of the resulting bytes in the window, an error is returned. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES Note that \fBadd_wch\fP, @@ -323,7 +325,7 @@ Note that \fBecho_wchar\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. The defaults specified for line-drawing characters apply in the POSIX locale. .SS "WACS Symbols" X/Open Curses makes it clear that the WACS_ symbols should be defined as diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x index 8bbef8d0..5dd3e8f4 100644 --- a/man/curs_add_wchstr.3x +++ b/man/curs_add_wchstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_add_wchstr.3x,v 1.36 2024/04/13 22:21:16 tom Exp $ -.TH curs_add_wchstr 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_add_wchstr.3x,v 1.39 2024/04/20 21:20:07 tom Exp $ +.TH curs_add_wchstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -109,13 +109,15 @@ if the \fIwin\fP parameter is null or .bP if the \fIwchstr\fP parameter is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All functions except \fBwadd_wchnstr\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO \fB\%curs_addchstr\fP(3X) describes comparable functions of the .I \%ncurses diff --git a/man/curs_addch.3x b/man/curs_addch.3x index 6d4668a8..ad548520 100644 --- a/man/curs_addch.3x +++ b/man/curs_addch.3x @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addch.3x,v 1.83 2024/04/13 22:23:35 tom Exp $ -.TH curs_addch 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_addch.3x,v 1.85 2024/04/20 19:03:47 tom Exp $ +.TH curs_addch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -58,7 +58,7 @@ \fB\%mvwaddch\fP, \fB\%echochar\fP, \fB\%wechochar\fP \- -add a \fIcurses\fR character to a window and advance the cursor +add a \fIcurses\fP character to a window and advance the cursor .SH SYNOPSIS .nf \fB#include @@ -253,13 +253,11 @@ returns if \fB\%scrollok\fP(3X) is not enabled in that event, because it is not possible to wrap to a new line. .PP -Functions with a \*(``mv\*('' prefix first perform cursor movement using -\fB\%wmove\fP(3X) and fail if the position is outside the window, -or -(for \*(``mvw\*('' functions) -if the -.I \%WINDOW -pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES .BR \%addch , .BR \%mvaddch , @@ -271,6 +269,13 @@ may be implemented as macros. X/Open Curses, Issue 4 describes these functions. It specifies no error conditions for them. +.PP +SVr4 +.I curses +describes a successful return value only as +\*(``an integer value other than +.BR ERR \*(''. +.PP The defaults specified for forms-drawing characters apply in the POSIX locale. .SS "ACS Symbols" diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x index 77fe6b77..25d322af 100644 --- a/man/curs_addchstr.3x +++ b/man/curs_addchstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addchstr.3x,v 1.42 2024/04/13 22:21:16 tom Exp $ -.TH curs_addchstr 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_addchstr.3x,v 1.45 2024/04/20 21:20:07 tom Exp $ +.TH curs_addchstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -103,13 +103,15 @@ if the \fIwin\fP parameter is null or .bP if the \fIwchstr\fP parameter is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All functions except \fBwaddchnstr\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO \fB\%curs_add_wchstr\fP(3X) describes comparable functions of the .I \%ncurses diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x index 72dbb451..1244001d 100644 --- a/man/curs_addstr.3x +++ b/man/curs_addstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addstr.3x,v 1.43 2024/04/13 22:14:06 tom Exp $ -.TH curs_addstr 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_addstr.3x,v 1.45 2024/04/20 19:18:18 tom Exp $ +.TH curs_addstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -114,13 +114,11 @@ or .bP if an internal \fB\%waddch\fP(3X) call returns an error. .PP -Functions with a \*(``mv\*('' prefix first perform cursor movement using -\fB\%wmove\fP(3X) and fail if the position is outside the window, -or -(for \*(``mvw\*('' functions) -if the -.I \%WINDOW -pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All of these functions except \fBwaddnstr\fP may be macros. .SH PORTABILITY diff --git a/man/curs_addwstr.3x b/man/curs_addwstr.3x index 0f96afb2..78d5788e 100644 --- a/man/curs_addwstr.3x +++ b/man/curs_addwstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addwstr.3x,v 1.35 2024/04/13 22:14:06 tom Exp $ -.TH curs_addwstr 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_addwstr.3x,v 1.37 2024/04/20 19:18:18 tom Exp $ +.TH curs_addwstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -124,13 +124,11 @@ or .bP if an internal \fB\%wadd_wch\fP(3X) call returns an error. .PP -Functions with a \*(``mv\*('' prefix first perform cursor movement using -\fB\%wmove\fP(3X) and fail if the position is outside the window, -or -(for \*(``mvw\*('' functions) -if the -.I \%WINDOW -pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All of these functions except .B waddnwstr diff --git a/man/curs_attr.3x b/man/curs_attr.3x index 7ff66bbb..af275f5a 100644 --- a/man/curs_attr.3x +++ b/man/curs_attr.3x @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_attr.3x,v 1.99 2024/03/16 15:38:33 tom Exp $ -.TH curs_attr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_attr.3x,v 1.103 2024/04/20 21:24:19 tom Exp $ +.TH curs_attr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -308,9 +308,10 @@ for \fBwcolor_set\fP is outside the range 0..COLOR_PAIRS\-1. does not return an error if either of the parameters of \fBwattr_get\fP used for retrieving attribute or color pair values is \fBNULL\fP. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) .\" --------------------------------------------------------------------------- .SH NOTES These functions may be macros: @@ -362,7 +363,7 @@ the \fIopts\fP parameter is ignored except except to check that it is \fBNULL\fP. .\" --------------------------------------------------------------------------- .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. The standard defined the dedicated type for highlights, \fBattr_t\fP, which was not defined in SVr4 curses. The functions taking \fBattr_t\fP arguments were not supported under SVr4. @@ -371,7 +372,7 @@ Very old versions of this library did not force an update of the screen when changing the attributes. Use \fBtouchwin\fP to force the screen to match the updated attributes. .PP -The XSI Curses standard states that whether the traditional functions +X/Open Curses states that whether the traditional functions \fBattron\fP/\fBattroff\fP/\fBattrset\fP can manipulate attributes other than \fBA_BLINK\fP, \fBA_BOLD\fP, \fBA_DIM\fP, \fBA_REVERSE\fP, \fBA_STANDOUT\fP, or \fBA_UNDERLINE\fP is \*(``unspecified\*(''. @@ -379,7 +380,7 @@ Under this implementation as well as SVr4 curses, these functions correctly manipulate all other highlights (specifically, \fBA_ALTCHARSET\fP, \fBA_PROTECT\fP, and \fBA_INVIS\fP). .PP -XSI Curses added these entry points: +X/Open Curses added these entry points: .sp .RS \fBattr_get\fP, \fBattr_on\fP, @@ -411,11 +412,11 @@ WA_ALTCHARSET Alternate character set .TE .RE .PP -XSI curses does not assign values to these symbols, +X/Open Curses does not assign values to these symbols, nor does it state whether or not they are related to the similarly-named A_NORMAL, etc.: .bP -The XSI curses standard specifies that each pair of corresponding \fBA_\fP +X/Open Curses specifies that each pair of corresponding \fBA_\fP and \fBWA_\fP-using functions operates on the same current-highlight information. .bP @@ -445,7 +446,7 @@ no change is made to the window's color. This is consistent with SVr4 curses; X/Open Curses does not specify this. .PP -The XSI standard extended conformance level adds new highlights +The X/Open Curses extended conformance level adds new highlights \fBA_HORIZONTAL\fP, \fBA_LEFT\fP, \fBA_LOW\fP, \fBA_RIGHT\fP, \fBA_TOP\fP, \fBA_VERTICAL\fP (and corresponding \fBWA_\fP macros for each). As of August 2013, diff --git a/man/curs_beep.3x b/man/curs_beep.3x index 1ba3fdd9..9806f42b 100644 --- a/man/curs_beep.3x +++ b/man/curs_beep.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_beep.3x,v 1.27 2024/03/16 15:35:01 tom Exp $ -.TH curs_beep 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_beep.3x,v 1.29 2024/04/20 21:20:07 tom Exp $ +.TH curs_beep 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME \fB\%beep\fP, \fB\%flash\fP \- @@ -57,7 +57,7 @@ These routines return \fBOK\fP if they succeed in beeping or flashing, SVr4's beep and flash routines always returned \fBOK\fP, so it was not possible to tell when the beep or flash failed. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. Like SVr4, it specifies that they always return \fBOK\fP. .SH SEE ALSO \fB\%curses\fP(3X) diff --git a/man/curs_bkgd.3x b/man/curs_bkgd.3x index ec9fe376..25ba1f9f 100644 --- a/man/curs_bkgd.3x +++ b/man/curs_bkgd.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgd.3x,v 1.59 2024/03/23 19:58:58 tom Exp $ -.TH curs_bkgd 3X 2024-03-23 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_bkgd.3x,v 1.61 2024/04/20 18:54:36 tom Exp $ +.TH curs_bkgd 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -184,7 +184,8 @@ like SVr4 \fIcurses\fP, checks to ensure that, and will reuse the old background character if the check fails. .SH PORTABILITY -X/Open Curses, Issue 4, describes these functions. +X/Open Curses, +Issue 4 describes these functions. It specifies that \fB\%bkgd\fP, \fB\%wbkgd\fP, diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x index 2b49db04..2551924c 100644 --- a/man/curs_bkgrnd.3x +++ b/man/curs_bkgrnd.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgrnd.3x,v 1.40 2024/03/23 19:59:45 tom Exp $ -.TH curs_bkgrnd 3X 2024-03-23 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_bkgrnd.3x,v 1.42 2024/04/20 18:54:36 tom Exp $ +.TH curs_bkgrnd 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -199,7 +199,8 @@ and attribute in a modifiable parameter, not as the return value. .SH PORTABILITY -X/Open Curses, Issue 4, describes these functions. +X/Open Curses, +Issue 4 describes these functions. It specifies no error conditions for them. .PP X/Open Curses does not provide details of how the rendition is updated. diff --git a/man/curs_border.3x b/man/curs_border.3x index bd6f040c..2a5e72c1 100644 --- a/man/curs_border.3x +++ b/man/curs_border.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_border.3x,v 1.46 2024/03/16 15:38:43 tom Exp $ -.TH curs_border 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_border.3x,v 1.49 2024/04/20 21:20:07 tom Exp $ +.TH curs_border 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -145,16 +145,18 @@ X/Open Curses does not specify any error conditions. This implementation returns an error if the window pointer is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES The borders generated by these functions are \fIinside\fP borders (this is also true of SVr4 curses, though the fact is not documented). .PP Note that \fBborder\fP and \fBbox\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO \fB\%curses\fP(3X), \fB\%curs_outopts\fP(3X) diff --git a/man/curs_border_set.3x b/man/curs_border_set.3x index da9b1448..3077da6b 100644 --- a/man/curs_border_set.3x +++ b/man/curs_border_set.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_border_set.3x,v 1.33 2024/03/16 15:35:01 tom Exp $ -.TH curs_border_set 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_border_set.3x,v 1.36 2024/04/20 21:20:07 tom Exp $ +.TH curs_border_set 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -179,9 +179,11 @@ Otherwise, they return .PP Functions using a window parameter return an error if it is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES Note that \fBborder_set\fP, @@ -193,7 +195,7 @@ Note that \fBvline_set\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO \fB\%curses\fP(3X), \fB\%curs_add_wch\fP(3X), diff --git a/man/curs_clear.3x b/man/curs_clear.3x index 2e3f2be6..0ab00645 100644 --- a/man/curs_clear.3x +++ b/man/curs_clear.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_clear.3x,v 1.46 2024/03/16 15:35:01 tom Exp $ -.TH curs_clear 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_clear.3x,v 1.48 2024/04/20 21:20:07 tom Exp $ +.TH curs_clear 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -104,7 +104,7 @@ if the cursor position is about to wrap. Note that \fBerase\fP, \fBwerase\fP, \fBclear\fP, \fBwclear\fP, \fBclrtobot\fP, and \fBclrtoeol\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .PP The SVr4.0 manual says that these functions could return \*(``or a non-negative integer if \fB\%immedok\fP is set\*('', diff --git a/man/curs_color.3x b/man/curs_color.3x index eb495870..7a5a02f2 100644 --- a/man/curs_color.3x +++ b/man/curs_color.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_color.3x,v 1.98 2024/03/16 15:35:01 tom Exp $ -.TH curs_color 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_color.3x,v 1.100 2024/04/20 21:24:19 tom Exp $ +.TH curs_color 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -506,7 +506,7 @@ extensions should condition their use on the visibility of the .B \%NCURSES_VERSION preprocessor macro. .PP -This implementation satisfies XSI Curses's minimum maximums +This implementation satisfies X/Open Curses's minimum maximums for \fB\%COLORS\fP and \fB\%COLOR_PAIRS\fP. .PP The \fB\%init_pair\fP routine accepts negative values of foreground diff --git a/man/curs_delch.3x b/man/curs_delch.3x index 7a3cb202..e62ecc13 100644 --- a/man/curs_delch.3x +++ b/man/curs_delch.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_delch.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ -.TH curs_delch 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_delch.3x,v 1.34 2024/04/20 19:24:14 tom Exp $ +.TH curs_delch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -44,7 +44,7 @@ \fB\%wdelch\fP, \fB\%mvdelch\fP, \fB\%mvwdelch\fP \- -delete the character at the cursor in a \fIcurses\fR window +delete a character from a \fIcurses\fR window .SH SYNOPSIS .nf \fB#include @@ -55,28 +55,59 @@ delete the character at the cursor in a \fIcurses\fR window \fBint mvwdelch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); .fi .SH DESCRIPTION -These routines delete the character under the cursor; all characters to the -right of the cursor on the same line are moved to the left one position and the -last character on the line is filled with a blank. -The cursor position does -not change (after moving to \fIy\fP, \fIx\fP, if specified). -(This does not -imply use of the hardware delete character feature.) +.B \%wdelch +deletes the character at the cursor position in +.IR win . +\fB\%ncurses\fP(3X) describes the variants of this function. +.PP +.B \%wdelch +moves all characters to the right of the cursor on the same line to the +left one position and replaces the contents of the rightmost position on +the line with the window's blank character; +see \fB\%bkgd\fP(3X) +(wide-character API users may consult \fB\%bkgrnd\fP(3X) instead). +The cursor position does not change +(after moving to +.RI ( y , +.IR x ), +if specified). .SH RETURN VALUE -All routines return the integer \fBERR\fP upon failure and an \fBOK\fP -(SVr4 specifies only -\*(``an integer value other than \fBERR\fP\*('') -upon successful completion. +These functions return +.B OK +on success and +.B ERR +on failure. +.PP +Functions taking a +.I \%WINDOW +pointer argument fail if the pointer is +.BR NULL . .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -Note that \fBdelch\fP, \fBmvdelch\fP, and \fBmvwdelch\fP may be macros. +.BR \%delch , +.BR \%mvdelch , +and +.B \%mvwdelch +may be implemented as macros. +.PP +A terminal's +.B \%delete_character +.RB ( dch1 ) +capability +is not necessarily employed. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. -The -standard specifies that they return \fBERR\fP on failure, but specifies no -error conditions. +X/Open Curses, +Issue 4 describes these functions. +.PP +SVr4 +.I curses +describes a successful return value only as +\*(``an integer value other than +.BR ERR \*(''. .SH SEE ALSO \fB\%curses\fP(3X) diff --git a/man/curs_deleteln.3x b/man/curs_deleteln.3x index cf1be3f8..6d70a435 100644 --- a/man/curs_deleteln.3x +++ b/man/curs_deleteln.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_deleteln.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ -.TH curs_deleteln 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_deleteln.3x,v 1.38 2024/04/20 21:20:07 tom Exp $ +.TH curs_deleteln 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -96,7 +96,7 @@ terminal. In fact, they will not use hardware line delete/insert unless \fBidlok(..., TRUE)\fP has been set on the current window. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. The standard specifies that they return \fBERR\fP on failure, but specifies no error conditions. diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x index ca171c19..02932b91 100644 --- a/man/curs_get_wch.3x +++ b/man/curs_get_wch.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_get_wch.3x,v 1.38 2024/04/13 22:14:06 tom Exp $ -.TH curs_get_wch 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_get_wch.3x,v 1.40 2024/04/20 19:23:03 tom Exp $ +.TH curs_get_wch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -60,7 +60,7 @@ get (or push back) a wide character from \fIcurses\fR terminal keyboard \fBint mvget_wch(int \fIy\fP, int \fIx\fP, wint_t *\fIwch\fP); \fBint mvwget_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wint_t *\fIwch\fP); .PP -\fBint unget_wch(const wchar_t \fIwch\fP); +\fBint unget_wch(const wchar_t \fIwc\fP); .fi .SH DESCRIPTION .SS "Reading Characters" @@ -190,13 +190,11 @@ in which case is set to .BR \%EINTR . .PP -Functions with a \*(``mv\*('' prefix first perform cursor movement using -\fB\%wmove\fP(3X) and fail if the position is outside the window, -or -(for \*(``mvw\*('' functions) -if the -.I win -parameter is a null pointer. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .PP .B \%unget_wch returns @@ -241,7 +239,8 @@ extensions should condition their use on the visibility of the .B \%NCURSES_VERSION preprocessor macro. .PP -X/Open Curses, Issue 4, describes these functions. +X/Open Curses, +Issue 4 describes these functions. It specifies no error conditions for them. .PP See the \*(``PORTABILITY\*('' section of \fB\%wgetch\fP(3X) regarding diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x index ba1f5002..32ae541a 100644 --- a/man/curs_get_wstr.3x +++ b/man/curs_get_wstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_get_wstr.3x,v 1.46 2024/04/13 22:14:06 tom Exp $ -.TH curs_get_wstr 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_get_wstr.3x,v 1.48 2024/04/20 19:18:18 tom Exp $ +.TH curs_get_wstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -147,9 +147,11 @@ if the associated call to \fBwget_wch\fP failed. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES Any of these functions other than \fBwgetn_wstr\fP diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x index 009d63dc..523cc99d 100644 --- a/man/curs_getcchar.3x +++ b/man/curs_getcchar.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getcchar.3x,v 1.47 2024/04/13 22:08:22 tom Exp $ -.TH curs_getcchar 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_getcchar.3x,v 1.49 2024/04/20 18:55:09 tom Exp $ +.TH curs_getcchar 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 @@ -42,15 +42,15 @@ convert between a wide-character string and a \fIcurses\fR complex character \fB#include .PP \fBint getcchar( -.B " const cchar_t *\fIwcval\fP," -.B " wchar_t *\fIwch\fP," +.B " const cchar_t *\fIwch\fP," +.B " wchar_t *\fIwc\fP," .B " attr_t *\fIattrs\fP," .B " short *\fIcolor_pair\fP," .B " void *\fIopts\fP );" .PP .B "int setcchar(" -.B " cchar_t *\fIwcval\fP," -.B " const wchar_t *\fIwch\fP," +.B " cchar_t *\fIwch\fP," +.B " const wchar_t *\fIwc\fP," .B " const attr_t \fIattrs\fP," .B " short \fIcolor_pair\fP," .B " const void *\fIopts\fP );" @@ -59,32 +59,32 @@ convert between a wide-character string and a \fIcurses\fR complex character .SS getcchar The \fBgetcchar\fP function gets a wide-character string and rendition from a \fBcchar_t\fP argument. -When \fIwch\fP is not a null pointer, +When \fIwc\fP is not a null pointer, the \fBgetcchar\fP function does the following: .bP -Extracts information from a \fBcchar_t\fP value \fIwcval\fP +Extracts information from a \fBcchar_t\fP value \fIwch\fP .bP Stores the character attributes in the location pointed to by \fIattrs\fP .bP Stores the color pair in the location pointed to by \fIcolor_pair\fP .bP Stores the wide-character string, -characters referenced by \fIwcval\fP, into the array pointed to by \fIwch\fP. +characters referenced by \fIwch\fP, into the array pointed to by \fIwc\fP. .PP When -\fIwch\fP +\fIwc\fP is a null pointer, the \fBgetcchar\fP function does the following: .bP -Obtains the number of wide characters pointed to by \fIwcval\fP +Obtains the number of wide characters pointed to by \fIwch\fP .bP Does not change the data referenced by \fIattrs\fP or \fIcolor_pair\fP .SS setcchar -The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP +The \fBsetcchar\fP function initializes the location pointed to by \fIwch\fP by using: .bP The character attributes in @@ -93,7 +93,7 @@ The character attributes in The color pair in \fIcolor_pair\fP .bP -The wide-character string pointed to by \fIwch\fP. +The wide-character string pointed to by \fIwc\fP. The string must be L'\e0' terminated, contain at most one spacing character, which must be the first. @@ -104,21 +104,21 @@ Additional non-spacing characters are ignored. The string may contain a single control character instead. In that case, no non-spacing characters are allowed. .SH RETURN VALUE -When \fIwch\fP is a null pointer, +When \fIwc\fP is a null pointer, \fBgetcchar\fP returns the number of wide characters referenced by -\fIwcval\fP, +\fIwch\fP, including one for a trailing null. .PP -When \fIwch\fP is not a null pointer, +When \fIwc\fP is not a null pointer, \fBgetcchar\fP returns \fBOK\fP upon successful completion, and \fBERR\fP otherwise. .PP Upon successful completion, \fBsetcchar\fP returns \fBOK\fP. Otherwise, it returns \fBERR\fP. .SH NOTES -The \fIwcval\fP argument may be a value generated by a call to +The \fIwch\fP argument may be a value generated by a call to \fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument. -If \fIwcval\fP is constructed by any other means, the effect is unspecified. +If \fIwch\fP is constructed by any other means, the effect is unspecified. .SH EXTENSIONS X/Open Curses documents the \fIopts\fP argument as reserved for future use, saying that it must be null. diff --git a/man/curs_getch.3x b/man/curs_getch.3x index b06c5d3a..9433c614 100644 --- a/man/curs_getch.3x +++ b/man/curs_getch.3x @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getch.3x,v 1.85 2024/04/13 22:18:51 tom Exp $ -.TH curs_getch 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_getch.3x,v 1.87 2024/04/20 19:18:18 tom Exp $ +.TH curs_getch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -67,11 +67,11 @@ get (or push back) characters from \fIcurses\fR terminal keyboard .B int mvgetch(int \fIy\fP, int \fIx\fP); .B int mvwgetch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); .PP -.B int ungetch(int \fIch\fP); +.B int ungetch(int \fIc\fP); .PP .\" XXX: Move has_key into its own page like define_key and key_defined? \fI/* extension */\fP -.B int has_key(int \fIch\fP); +.B int has_key(int \fIc\fP); .fi .SH DESCRIPTION .SS "Reading Characters" @@ -116,13 +116,13 @@ If \fB\%echo\fP(3X) has been called, and the window is not a pad, .I curses writes the returned character -.I ch +.I c to the window (at the cursor position) per the following rules. .bP If -.I ch +.I c matches the terminal's erase character, the cursor moves leftward one position and the new position is erased @@ -136,7 +136,7 @@ are handled the same way. .bP .I curses writes any other -.I ch +.I c to the window, as with \fB\%wechochar\fP(3X). .bP @@ -147,12 +147,10 @@ calls .BR \%wrefresh . .PP If -.I ch +.I c is a carriage return and \fBnl\fP(3X) has been called, .B \%wgetch -returns the character code for newline -(line feed) -instead. +returns the character code for line feed instead. .SS "Keypad Mode" To .IR curses , @@ -192,7 +190,7 @@ character codes. In .IR \%ncurses , .I "user-defined function keys" -are configured with \fBdefine_key\fP(3X); +are configured with \fB\%define_key\fP(3X); they have no names, but are also expected to have values outside the range of eight-bit codes. @@ -244,7 +242,7 @@ further typing \*(``awakens\*('' .SS "Ungetting Characters" .B \%ungetch places -.I ch +.I c into the input queue to be returned by the next call to .BR \%wgetch . A single input queue serves all windows. @@ -264,7 +262,7 @@ Not all of these are necessarily supported on any particular terminal. The naming convention may seem obscure, with some apparent misspellings (such as \*(``RSUME\*('' for \*(``resume\*(''); -The names correspond to the +the names correspond to the .I \%term\%info capability names for the keys, and were standardized before the IBM PC/AT keyboard layout achieved a @@ -378,7 +376,7 @@ KEY_SUNDO Shifted undo key .TE .RE .PP -The keypad is arranged as follows. +Many keyboards feature a nine-key directional pad. .PP .RS .TS @@ -390,29 +388,29 @@ C1 down C3 .TE .RE .sp -Two of these symbols do +Two of the symbols in the list above do .I not -correspond to a real key. +correspond to a physical key. .bP .B \%wgetch returns -.B \%KEY_RESIZE -(even if the window's keypad mode is disabled) +.BR \%KEY_RESIZE , +even if the window's keypad mode is disabled, when .I \%ncurses -detects the +handles a .B \%SIGWINCH signal; -see \fBinitscr\fP(3X) and \fBresizeterm\fP(3X). +see \fB\%initscr\fP(3X) and \fB\%resizeterm\fP(3X). .bP .B \%wgetch returns .B \%KEY_MOUSE to indicate that a mouse event is pending collection; -see \fBcurs_mouse\fP(3X). +see \fB\%curs_mouse\fP(3X). Receipt of this code requires a window's keypad mode to be enabled, because to interpret mouse input -(as with with \fIxterm\fP(1)'s mouse prototocol), +(as with with \fI\%xterm\fP(1)'s mouse prototocol), .I \%ncurses must read an escape sequence, as with a function key. @@ -420,21 +418,32 @@ as with a function key. In .IR \%ncurses , .B \%has_key -takes a key code value from the above list, -and returns a Boolean value indicating the terminal's recognition of it. +returns a Boolean value indicating whether the terminal type recognizes +its parameter as a key code value. See also -\fBdefine_key\fP(3X) and \fBkey_defined\fP(3X). +\fB\%define_key\fP(3X) and \fB\%key_defined\fP(3X). .SH RETURN VALUE -.B \%wgetch -returns +Except for +.BR \%has_key , +these functions return +.B OK +on success and .B ERR -if -.bP -the +on failure. +.PP +Functions taking a .I \%WINDOW -pointer is -.BR NULL , -or +pointer argument fail if the pointer is +.BR NULL . +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. +.PP +.B \%wgetch +also fails if .bP its timeout expires without any data arriving, or @@ -445,20 +454,8 @@ in which case is set to .BR \%EINTR . .PP -Functions with a \*(``mv\*('' prefix first perform cursor movement using -\fB\%wmove\fP(3X) and fail if the position is outside the window, -or -(for \*(``mvw\*('' functions) -if the -.I win -parameter is a null pointer. -.PP .B \%ungetch -returns -.B OK -on success and -.B ERR -if there is no more room in the input queue. +fails if there is no more room in the input queue. .PP .B \%has_key returns @@ -503,16 +500,18 @@ others treat such control characters specially. distinguishes the Enter keys in the alphabetic and numeric keypad sections of a keyboard because (most) terminals do. .B \%KEY_ENTER -refers to the key on the (numeric) keypad and, +refers to the key on the numeric keypad and, like other function keys, -is reliably recognized only if the window's keypad mode is enabled. +and is reliably recognized only if the window's keypad mode is enabled. .bP The .I \%term\%info .B \%key_enter .RB ( kent ) -capability describes the character (sequence) sent by the terminal's -keypad Enter key. +capability describes the character (sequence) sent by the Enter key of +a terminal's numeric +(or similar) +keypad. .bP \*(``Enter or send\*('' is X/Open Curses's description of this key. .PP @@ -547,8 +546,8 @@ function-key-rich keyboard of the AT&T 7300 (also known variously as the \*(``3B1\*('', \*(``Safari 4\*('', and \*(``UNIX PC\*(''), a 1985 machine. -Today's computer keyboards are based on the IBM PC/AT keyboard and tend -to have fewer. +Today's computer keyboards are based that of the IBM PC/AT and tend to +have fewer. A .I curses application can expect such a keyboard to transmit key codes @@ -604,7 +603,8 @@ extensions should condition their use on the visibility of the .B \%NCURSES_VERSION preprocessor macro. .PP -X/Open Curses, Issue 4, describes +X/Open Curses, +Issue 4 describes \fB\%getch\fP, \fB\%wgetch\fP, \fB\%mvgetch\fP, @@ -629,7 +629,7 @@ In historical .I curses implementations, it varied depending on whether the operating system's dispatch of a -signal to a handler interrupts a \fIread\fP(2) call in progress or not, +signal to a handler interrupting a \fIread\fP(2) call in progress, and also (in some implementations) whether an input timeout or non-blocking mode has been set. diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x index 43a290db..4a49352a 100644 --- a/man/curs_getstr.3x +++ b/man/curs_getstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getstr.3x,v 1.56 2024/04/13 22:14:06 tom Exp $ -.TH curs_getstr 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_getstr.3x,v 1.58 2024/04/20 19:18:18 tom Exp $ +.TH curs_getstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -149,9 +149,11 @@ This implementation provides an extension as well. If a \fBSIGWINCH\fP interrupts the function, it will return \fBKEY_RESIZE\fP rather than \fBOK\fP or \fBERR\fP. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES Any of these functions other than \fBwgetnstr\fP diff --git a/man/curs_getyx.3x b/man/curs_getyx.3x index 7b1830c9..eadcecef 100644 --- a/man/curs_getyx.3x +++ b/man/curs_getyx.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getyx.3x,v 1.42 2024/03/16 15:35:01 tom Exp $ -.TH curs_getyx 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_getyx.3x,v 1.44 2024/04/20 21:20:07 tom Exp $ +.TH curs_getyx 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -78,7 +78,7 @@ The \fB\%getparyx\fP, \fB\%getbegyx\fP and \fB\%getmaxyx\fP -macros are described in the XSI Curses standard, Issue 4. +macros are described in X/Open Curses, Issue 4. .PP This implementation also provides functions \fB\%getbegx\fP, diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x index b3f9c08b..8512e6d3 100644 --- a/man/curs_in_wch.3x +++ b/man/curs_in_wch.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wch.3x,v 1.28 2024/04/13 22:14:06 tom Exp $ -.TH curs_in_wch 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_in_wch.3x,v 1.31 2024/04/20 21:20:07 tom Exp $ +.TH curs_in_wch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -49,30 +49,32 @@ get a \fIcurses\fR complex character from a window .nf \fB#include .PP -\fBint in_wch(cchar_t *\fIwcval\fP); -\fBint win_wch(WINDOW *\fIwin\fP, cchar_t *\fIwcval\fP); +\fBint in_wch(cchar_t *\fIwch\fP); +\fBint win_wch(WINDOW *\fIwin\fP, cchar_t *\fIwch\fP); .PP -\fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t *\fIwcval\fP); -\fBint mvwin_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwcval\fP); +\fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t *\fIwch\fP); +\fBint mvwin_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwch\fP); .fi .SH DESCRIPTION These functions extract the complex character and rendition from the current position in the named window into the \fBcchar_t\fP object -referenced by wcval. +referenced by wch. .SH RETURN VALUE -No errors are defined in the XSI Curses standard. +No errors are defined in X/Open Curses. This implementation checks for null pointers, returns \fBERR\fP in that case. Also, the \fImv\fP routines check for error moving the cursor, returning \fBERR\fP in that case. Otherwise they return \fBOK\fP. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES Note that all of these routines may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO \fB\%curs_inch\fP(3X) describes comparable functions of the .I \%ncurses diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x index 295ccc81..53c98464 100644 --- a/man/curs_in_wchstr.3x +++ b/man/curs_in_wchstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wchstr.3x,v 1.36 2024/04/13 22:21:16 tom Exp $ -.TH curs_in_wchstr 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_in_wchstr.3x,v 1.39 2024/04/20 21:24:19 tom Exp $ +.TH curs_in_wchstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -95,9 +95,11 @@ if the \fIwin\fP parameter is null or .bP if the \fIwchstr\fP parameter is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All routines except \fBwin_wchnstr\fP may be macros. .PP @@ -117,7 +119,7 @@ Therefore, the use of \fBwin_wchnstr\fP is recommended. .SH PORTABILITY -The XSI Curses defines no error conditions. +X/Open Curses defines no error conditions. This implementation checks for null pointers, returning \fBERR\fP in that case. .SH SEE ALSO diff --git a/man/curs_inch.3x b/man/curs_inch.3x index c540c5fb..962e9dc8 100644 --- a/man/curs_inch.3x +++ b/man/curs_inch.3x @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inch.3x,v 1.48 2024/04/13 22:14:06 tom Exp $ -.TH curs_inch 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_inch.3x,v 1.51 2024/04/20 21:20:07 tom Exp $ +.TH curs_inch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -83,9 +83,11 @@ A_ATTRIBUTES Extract attributes A_COLOR Extract color pair information .TE .SH RETURN VALUE -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .PP The \fBwinch\fP function does not return an error if the window contains characters larger than 8-bits (255). @@ -93,7 +95,7 @@ Only the low-order 8 bits of the character are used by \fBwinch\fP. .SH NOTES Note that all of these routines may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .PP Very old systems (before standardization) provide a different function with the same name: diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x index d019fc61..bcd5d685 100644 --- a/man/curs_inchstr.3x +++ b/man/curs_inchstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inchstr.3x,v 1.42 2024/03/16 15:35:01 tom Exp $ -.TH curs_inchstr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_inchstr.3x,v 1.45 2024/04/20 21:20:07 tom Exp $ +.TH curs_inchstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -94,9 +94,11 @@ if the \fIwin\fP parameter is null or .bP if the \fIchstr\fP parameter is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All routines except \fBwinchnstr\fP may be macros. .PP @@ -121,7 +123,7 @@ Therefore, the use of \fBwinchnstr\fP is recommended. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. It is no more specific than the SVr4 documentation on the trailing 0. It does specify diff --git a/man/curs_initscr.3x b/man/curs_initscr.3x index 5a54c41f..0f460af1 100644 --- a/man/curs_initscr.3x +++ b/man/curs_initscr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_initscr.3x,v 1.66 2024/04/13 22:18:11 tom Exp $ -.TH curs_initscr 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_initscr.3x,v 1.69 2024/04/20 21:24:19 tom Exp $ +.TH curs_initscr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -174,7 +174,7 @@ i.e., \fBset_term\fP returns no error. .SH PORTABILITY -These functions were described in the XSI Curses standard, Issue 4. +These functions were described in X/Open Curses, Issue 4. As of 2015, the current document is X/Open Curses, Issue 7. .SS Differences X/Open Curses specifies that portable applications must not @@ -189,7 +189,7 @@ This implementation allows using \fBinitscr\fP after \fBendwin\fP. Old versions of curses, e.g., BSD 4.4, would return a null pointer from \fBinitscr\fP when an error is detected, rather than exiting. It is safe but redundant to check the return value of \fBinitscr\fP -in XSI Curses. +in X/Open Curses. .PP Calling \fBendwin\fP does not dispose of the memory allocated in \fBinitscr\fP or \fBnewterm\fP. diff --git a/man/curs_ins_wch.3x b/man/curs_ins_wch.3x index 6730a770..90b03f64 100644 --- a/man/curs_ins_wch.3x +++ b/man/curs_ins_wch.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_ins_wch.3x,v 1.28 2024/03/16 15:35:01 tom Exp $ -.TH curs_ins_wch 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_ins_wch.3x,v 1.30 2024/04/20 19:18:18 tom Exp $ +.TH curs_ins_wch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -75,11 +75,11 @@ Functions taking a pointer argument fail if the pointer is .BR NULL . .PP -Functions prefixed with \*(``mv\*('' first perform cursor movement using -\fB\%wmove\fP and fail if the position +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position .RI ( y , .IR x ) -is outside the window. +is outside the window boundaries. .SH NOTES A terminal's .B \%insert_character @@ -93,7 +93,8 @@ and \fB\%mvwins_wch\fP may be implemented as macros. .SH PORTABILITY -X/Open Curses, Issue 4, describes these functions. +X/Open Curses, +Issue 4 describes these functions. .PP SVr4 describes successful return values only as \*(``an integer value other than \fBERR\fP\*(''. diff --git a/man/curs_ins_wstr.3x b/man/curs_ins_wstr.3x index 57212745..4ebd3ace 100644 --- a/man/curs_ins_wstr.3x +++ b/man/curs_ins_wstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_ins_wstr.3x,v 1.34 2024/04/13 22:14:06 tom Exp $ -.TH curs_ins_wstr 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_ins_wstr.3x,v 1.38 2024/04/20 21:23:08 tom Exp $ +.TH curs_ins_wstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -98,18 +98,20 @@ if the \fIwstr\fP parameter is null or .bP if the \fBwins_wch\fP function returns an error. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP(3X), and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All but \fBwins_nwstr\fP may be macros. .PP If the first character in the string is a non-spacing character, these functions will fail. -XSI does not define what will happen if a non-spacing character follows -a control character. +X/Open Curses does not define what will happen +if a non-spacing character follows a control character. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4, +These functions are described in X/Open Curses, Issue 4, which adds \fI\%const\fP qualifiers to the arguments. .PP X/Open states that the entire string is inserted if \fIn\fP is less than 1. diff --git a/man/curs_insch.3x b/man/curs_insch.3x index 73c34a90..baf2f6cc 100644 --- a/man/curs_insch.3x +++ b/man/curs_insch.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_insch.3x,v 1.38 2024/03/16 15:35:01 tom Exp $ -.TH curs_insch 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_insch.3x,v 1.40 2024/04/20 19:03:47 tom Exp $ +.TH curs_insch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -44,7 +44,7 @@ \fB\%winsch\fP, \fB\%mvinsch\fP, \fB\%mvwinsch\fP \- -insert a \fIcurses\fR character in a window +insert a \fIcurses\fP character in a window .SH SYNOPSIS .nf \fB#include \fP @@ -68,35 +68,43 @@ cell to the right; the rightmost character on the line is discarded. The cursor does not advance. .SH "RETURN VALUE" -These functions return \fBOK\fP on success and \fBERR\fP on failure. +These functions return +.B OK +on success and +.B ERR +on failure. .PP Functions taking a .I \%WINDOW pointer argument fail if the pointer is .BR NULL . .PP -Functions prefixed with \*(``mv\*('' first perform cursor movement using -\fB\%wmove\fP and fail if the position +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position .RI ( y , .IR x ) -is outside the window. +is outside the window boundaries. .SH NOTES +.BR \%insch , +.BR \%mvinsch , +and +.B \%mvwinsch +may be implemented as macros. +.PP A terminal's .B \%insert_character .RB ( ich1 ) capability is not necessarily employed. -.PP -\fB\%insch\fP, -\fB\%mvinsch\fP, -and -\fB\%mvwinsch\fP -may be implemented as macros. .SH PORTABILITY -X/Open Curses, Issue 4, describes these functions. +X/Open Curses, +Issue 4 describes these functions. .PP -SVr4 describes successful return values only as -\*(``an integer value other than \fBERR\fP\*(''. +SVr4 +.I curses +describes a successful return value only as +\*(``an integer value other than +.BR ERR \*(''. .SH "SEE ALSO" \fB\%curs_ins_wch\fP(3X) describes comparable functions in the wide-character diff --git a/man/curs_insstr.3x b/man/curs_insstr.3x index 6c703536..888d4250 100644 --- a/man/curs_insstr.3x +++ b/man/curs_insstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_insstr.3x,v 1.48 2024/03/16 15:49:07 tom Exp $ -.TH curs_insstr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_insstr.3x,v 1.51 2024/04/20 21:20:07 tom Exp $ +.TH curs_insstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -97,13 +97,15 @@ if the \fIstr\fP parameter is null or .bP the \fBwinsch\fP(3X) function returns an error. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP(3X), and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All but \fBwinsnstr\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4, +These functions are described in X/Open Curses, Issue 4, which adds \fI\%const\fP qualifiers to the arguments. .PP The Single Unix Specification, Version 2 states that diff --git a/man/curs_instr.3x b/man/curs_instr.3x index c53a6168..5b6e4b76 100644 --- a/man/curs_instr.3x +++ b/man/curs_instr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_instr.3x,v 1.48 2024/04/13 22:14:06 tom Exp $ -.TH curs_instr 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_instr.3x,v 1.51 2024/04/20 21:24:19 tom Exp $ +.TH curs_instr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -89,9 +89,11 @@ if the \fIwin\fP parameter is null or .bP if the \fIchstr\fP parameter is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All routines except \fBwinnstr\fP may be macros. .PP @@ -114,7 +116,7 @@ is recommended. SVr4 does not document whether a length limit includes or excludes the trailing NUL. .PP -The \fI\%ncurses\fP library extends the XSI description by allowing a +The \fI\%ncurses\fP library extends the X/Open Curses description by allowing a negative value for \fIn\fP. In this case, the functions return the string ending at the right margin. .SH SEE ALSO diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x index 095c2fa1..eec361d7 100644 --- a/man/curs_inwstr.3x +++ b/man/curs_inwstr.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inwstr.3x,v 1.38 2024/03/16 15:35:01 tom Exp $ -.TH curs_inwstr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_inwstr.3x,v 1.41 2024/04/20 21:20:07 tom Exp $ +.TH curs_inwstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -99,9 +99,11 @@ if the \fIwstr\fP parameter is null, or .bP if no characters could be read. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All routines except \fBwinnwstr\fP @@ -130,7 +132,7 @@ Therefore, the use of \fBwinnwstr\fP is recommended. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO \fB\%curses\fP(3X), \fB\%curs_inch\fP(3X), diff --git a/man/curs_kernel.3x b/man/curs_kernel.3x index 3ab1c790..e85c1327 100644 --- a/man/curs_kernel.3x +++ b/man/curs_kernel.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_kernel.3x,v 1.58 2024/04/13 22:19:08 tom Exp $ -.TH curs_kernel 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_kernel.3x,v 1.61 2024/04/20 21:24:19 tom Exp $ +.TH curs_kernel 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -210,8 +210,8 @@ There is no way for \fI\%ncurses\fP to determine the initial cursor state to restore that. .SH PORTABILITY The \fIvirtual screen\fP functions \fBsetsyx\fP and \fBgetsyx\fP -are not described in the XSI Curses standard, Issue 4. -All other functions are as described in XSI Curses. +are not described in X/Open Curses, Issue 4. +All other functions are as described in X/Open Curses. .PP The SVr4 documentation describes \fBsetsyx\fP and \fBgetsyx\fP as having return type int. diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x index 04df96f1..8e5c7018 100644 --- a/man/curs_mouse.3x +++ b/man/curs_mouse.3x @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_mouse.3x,v 1.96 2024/03/23 20:38:57 tom Exp $ -.TH curs_mouse 3X 2024-03-23 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_mouse.3x,v 1.98 2024/04/20 19:02:07 tom Exp $ +.TH curs_mouse 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -69,16 +69,17 @@ get mouse events in \fIcurses\fR .PP \fBbool has_mouse(void); .PP +\fBmmask_t mousemask(mmask_t \fInewmask\fP, mmask_t *\fIoldmask\fP); +.PP \fBint getmouse(MEVENT *\fIevent\fP); \fBint ungetmouse(MEVENT *\fIevent\fP); .PP -\fBmmask_t mousemask(mmask_t \fInewmask\fP, mmask_t *\fIoldmask\fP); -.PP \fBbool wenclose(const WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); .PP \fBbool mouse_trafo(int* \fIpY\fP, int* \fIpX\fP, bool \fIto_screen\fP); \fBbool wmouse_trafo(const WINDOW* \fIwin\fP, - \fBint* \fIpY\fB, int* \fIpX\fB, bool \fIto_screen\fB);\fR +.ti +18n \" "bool wmouse_trafo(" +\fBint* \fIpY\fB, int* \fIpX\fB, bool \fIto_screen\fB); .PP \fBint mouseinterval(int \fIerval\fB);\fR .fi @@ -87,6 +88,15 @@ These functions provide an interface to mouse events from \fB\%ncurses\fP(3X). Mouse events are represented by \fB\%KEY_MOUSE\fP pseudo-key values in the \fB\%wgetch\fP(3X) input stream. +.SS has_mouse +The \fB\%has_mouse\fP function returns \fBTRUE\fP if the mouse driver +has been successfully initialized, +and \fBFALSE\fP otherwise. +.PP +Mouse events are ignored when input is in cooked mode, and +cause an error beep when cooked mode is being simulated in a window by a +function such as \fB\%getstr\fP that expects a linefeed for input-loop +termination. .SS mousemask To make mouse events visible, use the \fB\%mousemask\fP function. This sets the mouse events to be reported. @@ -255,15 +265,6 @@ Use \fB\%mouseinterval(\-1)\fP to obtain the interval without altering it. The mouse interval is set to one sixth of a second when the corresponding screen is initialized, e.g., in \fBinitscr\fP(3X) or \fBsetupterm\fP(3X). -.SS has_mouse -The \fB\%has_mouse\fP function returns \fBTRUE\fP if the mouse driver -has been successfully initialized, -and \fBFALSE\fP otherwise. -.PP -Mouse events are ignored when input is in cooked mode, and -cause an error beep when cooked mode is being simulated in a window by a -function such as \fB\%getstr\fP that expects a linefeed for input-loop -termination. .SH RETURN VALUE \fB\%has_mouse\fP, \fB\%wenclose\fP, diff --git a/man/curs_move.3x b/man/curs_move.3x index cb244bd1..3966325c 100644 --- a/man/curs_move.3x +++ b/man/curs_move.3x @@ -27,19 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_move.3x,v 1.35 2024/03/16 15:35:01 tom Exp $ -.TH curs_move 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" -.ie \n(.g \{\ -.ds `` \(lq -.ds '' \(rq -.\} -.el \{\ -.ie t .ds `` `` -.el .ds `` "" -.ie t .ds '' '' -.el .ds '' "" -.\} -. +.\" $Id: curs_move.3x,v 1.38 2024/04/20 19:51:33 tom Exp $ +.TH curs_move 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME \fB\%move\fP, \fB\%wmove\fP \- @@ -52,25 +41,48 @@ move cursor in a \fIcurses\fR window \fBint wmove(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); .fi .SH DESCRIPTION -These routines move the cursor associated with the window to line \fIy\fP and -column \fIx\fP. -This routine does not move the physical cursor of the terminal -until \fBrefresh\fP(3X) is called. -The position specified is relative to the upper -left-hand corner of the window, which is (0,0). +.B \%wmove +relocates the cursor associated with the +.I curses +window +.I win +to line +.I y +and column +.IR x . +The terminal's cursor does not move until \fB\%refresh\fP(3X) is called. +The position +.RI ( x , +.IR y ) +is relative to the upper left-hand corner of the window, +which has coordinates +(0,\ 0). +\fB\%ncurses\fP(3X) describes the +.B \%move +variant of this function. .SH RETURN VALUE -These routines return the integer \fBERR\fP upon failure and an \fBOK\fP -(SVr4 specifies only -\*(``an integer value other than \fBERR\fP\*('') -upon successful completion. +These functions return +.B OK +on success and +.B ERR +on failure. .PP -Specifically, they return an error -if the window pointer is null, or -if the position is outside the window. +They fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. +.PP +.B \%wmove +fails if its +.I \%WINDOW +pointer argument is +.BR NULL . .SH NOTES -Note that \fBmove\fP may be a macro. +.B \%move +may be implemented as a macro. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +X/Open Curses, +Issue 4 describes these functions. .SH SEE ALSO \fB\%curses\fP(3X), \fB\%curs_refresh\fP(3X) diff --git a/man/curs_outopts.3x b/man/curs_outopts.3x index 0e20a801..df263f2c 100644 --- a/man/curs_outopts.3x +++ b/man/curs_outopts.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_outopts.3x,v 1.60 2024/04/13 22:23:57 tom Exp $ -.TH curs_outopts 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_outopts.3x,v 1.64 2024/04/20 21:24:19 tom Exp $ +.TH curs_outopts 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 @@ -151,7 +151,8 @@ those functions that have a window pointer will return an error if the window pointer is null .bP \fBwsetscrreg\fP -returns an error if the scrolling region limits extend outside the window. +returns an error if the scrolling region limits extend outside the +window boundaries. .SH NOTES Note that \fBclearok\fP, @@ -163,7 +164,7 @@ Note that The \fBimmedok\fP routine is useful for windows that are used as terminal emulators. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .PP Some historic curses implementations had, as an undocumented feature, the ability to do the equivalent of \fBclearok(..., 1)\fP by saying @@ -173,11 +174,11 @@ This will not work under \fI\%ncurses\fP. Earlier System V curses implementations specified that with \fBscrollok\fP enabled, any window modification triggering a scroll also forced a physical refresh. -XSI Curses does not require this, and \fI\%ncurses\fP avoids doing +X/Open Curses does not require this, and \fI\%ncurses\fP avoids doing it to perform better vertical-motion optimization at \fBwrefresh\fP time. .PP -The XSI Curses standard does not mention that the cursor should be +X/Open Curses does not mention that the cursor should be made invisible as a side-effect of \fBleaveok\fP. SVr4 curses documentation does this, but the code does not. Use \fBcurs_set\fP to make the cursor invisible. diff --git a/man/curs_overlay.3x b/man/curs_overlay.3x index cfeccc79..2d4eb729 100644 --- a/man/curs_overlay.3x +++ b/man/curs_overlay.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_overlay.3x,v 1.41 2024/03/16 15:35:01 tom Exp $ -.TH curs_overlay 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_overlay.3x,v 1.43 2024/04/20 21:20:07 tom Exp $ +.TH curs_overlay 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -88,7 +88,7 @@ if some part of the window would be placed off-screen. .SH NOTES Note that \fBoverlay\fP and \fBoverwrite\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4, +These functions are described in X/Open Curses, Issue 4, which adds \fI\%const\fP qualifiers to the arguments. It further specifies their behavior in the presence of characters with multibyte renditions (not yet supported in this implementation). diff --git a/man/curs_pad.3x b/man/curs_pad.3x index ae17b589..37118dd0 100644 --- a/man/curs_pad.3x +++ b/man/curs_pad.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_pad.3x,v 1.57 2024/04/13 22:13:17 tom Exp $ -.TH curs_pad 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_pad.3x,v 1.59 2024/04/20 21:20:07 tom Exp $ +.TH curs_pad 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -218,7 +218,7 @@ and select text from the pad. .PP The two uses may be related. .PP -The XSI Curses standard, Issue 4 describes these functions, +X/Open Curses, Issue 4 describes these functions, without significant change from the SVr3 documentation. It describes no error conditions. The behavior of \fB\%subpad\fP if the parent window is not diff --git a/man/curs_printw.3x b/man/curs_printw.3x index a9fabc5c..282536b3 100644 --- a/man/curs_printw.3x +++ b/man/curs_printw.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_printw.3x,v 1.51 2024/03/23 20:38:57 tom Exp $ -.TH curs_printw 3X 2024-03-23 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_printw.3x,v 1.53 2024/04/20 19:18:18 tom Exp $ +.TH curs_printw 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -103,9 +103,11 @@ or if the window pointer .I win is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement -using \fB\%wmove\fP, -and fail if the position is outside the window. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES No wide character counterpart functions are defined by the \*(``wide\*('' @@ -116,7 +118,8 @@ To format and write a wide-character string to a window, consider using \fI\%swprintf\fP(3) and \fB\%waddwstr\fP(3X) or similar. .SH PORTABILITY -X/Open Curses, Issue 4, describes these functions. +X/Open Curses, +Issue 4 describes these functions. It specifies no error conditions for them. .PP .I \%ncurses @@ -125,7 +128,8 @@ legacy applications. However, the latter is obsolete. .bP -X/Open Curses, Issue 4, Version 2 (1996), +X/Open Curses, +Issue 4 Version 2 (1996), marked \fB\%vwprintw\fP as requiring \fI\%varargs.h\fP and \*(``TO BE WITHDRAWN\*('', and specified \fB\%vw_printw\fP using the \fI\%stdarg.h\fP interface. diff --git a/man/curs_refresh.3x b/man/curs_refresh.3x index b193d28e..ac81d1e6 100644 --- a/man/curs_refresh.3x +++ b/man/curs_refresh.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_refresh.3x,v 1.44 2024/03/16 15:49:39 tom Exp $ -.TH curs_refresh 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_refresh.3x,v 1.46 2024/04/20 21:20:07 tom Exp $ +.TH curs_refresh 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -149,7 +149,7 @@ if the associated call to \fBtouchln\fP returns an error. .SH NOTES Note that \fBrefresh\fP and \fBredrawwin\fP may be macros. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions. +X/Open Curses, Issue 4 describes these functions. .PP Whether \fBwnoutrefresh\fP copies to the virtual screen the entire contents of a window or just its changed portions has never been well-documented in diff --git a/man/curs_scanw.3x b/man/curs_scanw.3x index e5dcae6f..409c297f 100644 --- a/man/curs_scanw.3x +++ b/man/curs_scanw.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scanw.3x,v 1.51 2024/03/23 20:41:15 tom Exp $ -.TH curs_scanw 3X 2024-03-23 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_scanw.3x,v 1.53 2024/04/20 19:18:18 tom Exp $ +.TH curs_scanw 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -104,9 +104,11 @@ or if the window pointer .I win is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement -using \fB\%wmove\fP, -and fail if the position is outside the window. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES No wide character counterpart functions are defined by the \*(``wide\*('' @@ -124,7 +126,8 @@ respectively. implements \fI\%vsscanf\fP(3) internally if it is unavailable when the library is configured. .SH PORTABILITY -X/Open Curses, Issue 4, describes these functions. +X/Open Curses, +Issue 4 describes these functions. It specifies no error conditions for them. .PP .I \%ncurses @@ -133,13 +136,15 @@ legacy applications. However, the latter is obsolete. .bP -X/Open Curses, Issue 4, Version 2 (1996), +X/Open Curses, +Issue 4 Version 2 (1996), marked \fB\%vwscanw\fP as requiring \fI\%varargs.h\fP and \*(``TO BE WITHDRAWN\*('', and specified \fB\%vw_scanw\fP using the \fI\%stdarg.h\fP interface. .bP -X/Open Curses, Issue 5, Draft 2 -(December 2007) marked \fB\%vwscanw\fP (along with +X/Open Curses, +Issue 5, +Draft 2 (December 2007) marked \fB\%vwscanw\fP (along with \fB\%vwscanw\fP and the \fItermcap\fP interface) as withdrawn. After incorporating review comments, this became diff --git a/man/curs_scr_dump.3x b/man/curs_scr_dump.3x index 427ae2eb..5f14a228 100644 --- a/man/curs_scr_dump.3x +++ b/man/curs_scr_dump.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scr_dump.3x,v 1.41 2024/03/23 20:41:15 tom Exp $ -.TH curs_scr_dump 3X 2024-03-23 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_scr_dump.3x,v 1.43 2024/04/20 18:54:36 tom Exp $ +.TH curs_scr_dump 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -132,7 +132,8 @@ each function fails if it cannot open and \fB\%scr_restore\fP may be macros. .SH PORTABILITY -X/Open Curses, Issue 4, describes these functions. +X/Open Curses, +Issue 4 describes these functions. .PP .\" SVID 4, p. 529 SVr4 omitted the diff --git a/man/curs_scroll.3x b/man/curs_scroll.3x index b8599d5f..16d5a501 100644 --- a/man/curs_scroll.3x +++ b/man/curs_scroll.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scroll.3x,v 1.41 2024/04/14 00:14:28 tom Exp $ -.TH curs_scroll 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_scroll.3x,v 1.43 2024/04/20 18:54:36 tom Exp $ +.TH curs_scroll 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -110,7 +110,8 @@ accepting a \fI\%WINDOW\fP pointer argument. .PP \fB\%scrl\fP and \fB\%scroll\fP may be implemented as macros. .SH PORTABILITY -X/Open Curses, Issue 4, describes these functions. +X/Open Curses, +Issue 4 describes these functions. It defines no error conditions. .PP SVr4 specifies only diff --git a/man/curs_slk.3x b/man/curs_slk.3x index 33119b64..fbc71811 100644 --- a/man/curs_slk.3x +++ b/man/curs_slk.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_slk.3x,v 1.69 2024/03/16 15:35:01 tom Exp $ -.TH curs_slk 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_slk.3x,v 1.71 2024/04/20 18:54:36 tom Exp $ +.TH curs_slk 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -277,7 +277,8 @@ if \fIopts\fP is set it is treated as a pointer to \fIint\fP, and used to set the color pair instead of the \fIshort\fP pair parameter. .SH PORTABILITY -X/Open Curses, Issue 4, describes these functions, +X/Open Curses, +Issue 4 describes these functions, with some differences from SVr4 \fIcurses\fP: .bP X/Open added functions like the SVr4 attribute-manipulation functions diff --git a/man/curs_sp_funcs.3x b/man/curs_sp_funcs.3x index c4c2b132..e58a48e3 100644 --- a/man/curs_sp_funcs.3x +++ b/man/curs_sp_funcs.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_sp_funcs.3x,v 1.48 2024/03/16 15:35:01 tom Exp $ -.TH curs_sp_funcs 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_sp_funcs.3x,v 1.50 2024/04/20 18:56:31 tom Exp $ +.TH curs_sp_funcs 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -63,7 +63,7 @@ \fBint echo_sp(SCREEN* \fIsp\fP); \fBint endwin_sp(SCREEN* \fIsp\fP); \fBchar erasechar_sp(SCREEN* \fIsp\fP); -\fBint erasewchar_sp(SCREEN* \fIsp\fP, wchar_t *\fIch\fP); +\fBint erasewchar_sp(SCREEN* \fIsp\fP, wchar_t *\fIwc\fP); \fBint extended_color_content_sp(SCREEN * \fIsp\fP, int \fIcolor\fP, int * \fIr\fP, int * \fIg\fP, int * \fIb\fP); \fBint extended_pair_content_sp(SCREEN* \fIsp\fP, int \fIpair\fP, int * \fIfg\fP, int * \fIbg\fP); \fBint extended_slk_color_sp(SCREEN* \fIsp\fP, int \fIpair\fP); @@ -81,7 +81,7 @@ .PP \fBbool has_ic_sp(SCREEN* \fIsp\fP); \fBbool has_il_sp(SCREEN* \fIsp\fP); -\fBint has_key_sp(SCREEN* \fIsp\fP, int \fIch\fP); +\fBint has_key_sp(SCREEN* \fIsp\fP, int \fIc\fP); \fBbool has_mouse_sp(SCREEN* \fIsp\fP); \fBint init_color_sp(SCREEN* \fIsp\fP, short \fIcolor\fP, short \fIr\fP, short \fIg\fP, short \fIb\fP); \fBint init_extended_color_sp(SCREEN* \fIsp\fP, int \fIcolor\fP, int \fIr\fP, int \fIg\fP, int \fIb\fP); @@ -101,7 +101,7 @@ \fBint keyok_sp(SCREEN* \fIsp\fP, int \fIkeycode\fP, bool \fIenable\fP); \fBchar killchar_sp(SCREEN* \fIsp\fP); .PP -\fBint killwchar_sp(SCREEN* \fIsp\fP, wchar_t *\fIch\fP); +\fBint killwchar_sp(SCREEN* \fIsp\fP, wchar_t *\fIwc\fP); \fBchar* longname_sp(SCREEN* \fIsp\fP); \fBint mcprint_sp(SCREEN* \fIsp\fP, char *\fIdata\fP, int \fIlen\fP); \fBint mouseinterval_sp(SCREEN* \fIsp\fP, int \fIerval\fP); @@ -159,8 +159,8 @@ \fBchtype termattrs_sp(SCREEN* \fIsp\fP); \fBchar* termname_sp(SCREEN* \fIsp\fP); \fBint typeahead_sp(SCREEN* \fIsp\fP, int \fIfd\fP); -\fBint unget_wch_sp(SCREEN* \fIsp\fP, const wchar_t \fIwch\fP); -\fBint ungetch_sp(SCREEN* \fIsp\fP, int \fIch\fP); +\fBint unget_wch_sp(SCREEN* \fIsp\fP, const wchar_t \fIwc\fP); +\fBint ungetch_sp(SCREEN* \fIsp\fP, int \fIc\fP); \fBint ungetmouse_sp(SCREEN* \fIsp\fP, MEVENT* \fIevent\fP); \fBint use_default_colors_sp(SCREEN* \fIsp\fP); \fBvoid use_env_sp(SCREEN* \fIsp\fP, bool \fIbf\fP); @@ -171,7 +171,7 @@ \fBint vid_puts_sp(SCREEN* \fIsp\fP, attr_t \fIattrs\fP, short \fIpair\fP, void * \fIopts\fP, NCURSES_SP_OUTC \fIputc\fP); \fBint vidattr_sp(SCREEN* \fIsp\fP, chtype \fIattrs\fP); \fBint vidputs_sp(SCREEN* \fIsp\fP, chtype \fIattrs\fP, NCURSES_SP_OUTC \fIputc\fP); -\fBwchar_t* wunctrl_sp(SCREEN* \fIsp\fP, cchar_t *\fIch\fP); +\fBwchar_t* wunctrl_sp(SCREEN* \fIsp\fP, cchar_t *\fIwch\fP); .PP \fB#include .PP @@ -208,7 +208,7 @@ .PP \fB#include .PP -\fBNCURSES_CONST char* unctrl_sp(SCREEN* \fIsp\fP, chtype \fIc\fP); +\fBNCURSES_CONST char* unctrl_sp(SCREEN* \fIsp\fP, chtype \fIch\fP); .fi .SH DESCRIPTION This implementation can be configured to provide a set of functions which diff --git a/man/curs_termattrs.3x b/man/curs_termattrs.3x index 18134ddd..dacd3b0f 100644 --- a/man/curs_termattrs.3x +++ b/man/curs_termattrs.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_termattrs.3x,v 1.38 2024/04/13 22:16:39 tom Exp $ -.TH curs_termattrs 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_termattrs.3x,v 1.41 2024/04/20 21:20:07 tom Exp $ +.TH curs_termattrs 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME \fB\%baudrate\fP, \fB\%erasechar\fP, @@ -48,11 +48,11 @@ .PP \fBint baudrate(void); \fBchar erasechar(void); -\fBint erasewchar(wchar_t *\fIch\fP); +\fBint erasewchar(wchar_t *\fIwc\fP); \fBbool has_ic(void); \fBbool has_il(void); \fBchar killchar(void); -\fBint killwchar(wchar_t *\fIch\fP); +\fBint killwchar(wchar_t *\fIwc\fP); \fBchar *longname(void); \fBattr_t term_attrs(void); \fBchtype termattrs(void); @@ -68,9 +68,9 @@ integer. The \fBerasechar\fP routine returns the user's current erase character. .PP The \fBerasewchar\fP routine stores the current erase character -in the location referenced by \fIch\fP. +in the location referenced by \fIwc\fP. If no erase character has been defined, the routine fails -and the location referenced by \fIch\fP is not changed. +and the location referenced by \fIwc\fP is not changed. .SS "has_ic, has_il" The \fBhas_ic\fP routine is true if the terminal has insert- and delete- character capabilities. @@ -84,9 +84,9 @@ scrolling using \fBscrollok\fP(3X). The \fBkillchar\fP routine returns the user's current line kill character. .PP The \fBkillwchar\fP routine stores the current line-kill character -in the location referenced by \fIch\fP. +in the location referenced by \fIwc\fP. If no line-kill character has been defined, -the routine fails and the location referenced by \fIch\fP is not changed. +the routine fails and the location referenced by \fIwc\fP is not changed. .SS longname The \fBlongname\fP routine returns a pointer to a static area containing a verbose description of the current terminal. @@ -118,7 +118,7 @@ completion. .SH NOTES Note that \fBtermattrs\fP may be a macro. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions. +X/Open Curses, Issue 4 describes these functions. It changes the return type of \fBtermattrs\fP to the new type \fBattr_t\fP. Most versions of curses truncate the result returned by \fBtermname\fP to diff --git a/man/curs_termcap.3x b/man/curs_termcap.3x index f292f9d8..6bd2a66a 100644 --- a/man/curs_termcap.3x +++ b/man/curs_termcap.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_termcap.3x,v 1.83 2024/03/16 15:35:01 tom Exp $ -.TH curs_termcap 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_termcap.3x,v 1.85 2024/04/20 19:13:12 tom Exp $ +.TH curs_termcap 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -115,7 +115,7 @@ as do other \fItermcap\fP implementations conforming to portions of X/Open Curses now withdrawn. The BSD \fItermcap\fP library would store a copy of the terminal type description in the area referenced by this pointer. -\fI\%ncurses\fP stores terminal type descriptions in compiled form, +\fI\%term\%info\fP stores terminal type descriptions in compiled form, which is not the same thing. .bP The meanings of the return values differ. @@ -493,8 +493,8 @@ be aware that it is returned in \fI\%term\%info\fP notation, not the older and not-quite-compatible \fItermcap\fP notation. This does not cause problems if all you do with it is call \fB\%tgoto\fP or \fB\%tparm\fP, -which both expand \fI\%term\%info\fP-style strings as \fI\%term\%info\fP -does. +which both parametrically expand \fI\%term\%info\fP-style string +capabilities as \fI\%term\%info\fP does. (If .I \%ncurses is configured to support \fItermcap,\fP diff --git a/man/curs_touch.3x b/man/curs_touch.3x index 22391fd6..613b6958 100644 --- a/man/curs_touch.3x +++ b/man/curs_touch.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_touch.3x,v 1.44 2024/03/16 15:49:58 tom Exp $ -.TH curs_touch 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_touch.3x,v 1.47 2024/04/20 21:20:07 tom Exp $ +.TH curs_touch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME \fB\%touchwin\fP, \fB\%touchline\fP, @@ -88,7 +88,7 @@ In this implementation \fBis_linetouched\fP returns an error if the window pointer is null, or -if the line number is outside the window. +if the line number is outside the window boundaries. .IP The constant \fBERR\fP is distinct from \fBTRUE\fP and \fBFALSE\fP, which are the normal return values of this function. @@ -103,7 +103,7 @@ The actual function returns \fBFALSE\fP when it detects an error. \fBwtouchln\fP returns an error if the window pointer is null, or -if the line number is outside the window. +if the line number is outside the window boundaries. .RE .SH NOTES All of these routines except \fB\%wtouchln\fP may be macros. @@ -116,7 +116,7 @@ SVr4 \fIcurses\fP does not check the window parameter \fIwin\fP to ensure that it is not \fBNULL\fP; otherwise this implementation behaves the same as SVr4. .PP -The XSI Curses standard, Issue 4 describes these functions, +X/Open Curses, Issue 4 describes these functions, but defines no error conditions. .SH SEE ALSO \fB\%curses\fP(3X), diff --git a/man/curs_trace.3x b/man/curs_trace.3x index b985ffb3..ddae7911 100644 --- a/man/curs_trace.3x +++ b/man/curs_trace.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_trace.3x,v 1.47 2024/03/16 15:35:01 tom Exp $ -.TH curs_trace 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_trace.3x,v 1.50 2024/04/20 21:24:19 tom Exp $ +.TH curs_trace 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -74,7 +74,7 @@ .nf \fB#include .PP -\fBunsigned curses_trace(const unsigned \fIparam\fP); +\fBunsigned curses_trace(const unsigned \fItrace-mask\fP); .PP \fBvoid _tracef(const char *\fIformat\fP, ...); .PP @@ -82,7 +82,7 @@ \fBchar *_traceattr2(int \fIbuffer\fP, chtype \fIch\fP); \fBchar *_tracecchar_t(const cchar_t *\fIstring\fP); \fBchar *_tracecchar_t2(int \fIbuffer\fP, const cchar_t *\fIstring\fP); -\fBchar *_tracechar(int \fIch\fP); +\fBchar *_tracechar(int \fIc\fP); \fBchar *_tracechtype(chtype \fIch\fP); \fBchar *_tracechtype2(int \fIbuffer\fP, chtype \fIch\fP); .PP @@ -91,7 +91,7 @@ \fBchar *_tracemouse(const MEVENT *\fIevent\fP); .PP \fI/* deprecated */\fP -\fBvoid trace(const unsigned int \fIparam\fP); +\fBvoid trace(const unsigned int \fItrace-mask\fP); .fi .SH DESCRIPTION The \fIcurses trace\fP routines are used for debugging the @@ -250,7 +250,7 @@ were called. .RE .dE .SH PORTABILITY -These functions are not part of the XSI interface. +These functions are not part of the X/Open Curses interface. Some other curses implementations are known to have similar features, but they are not compatible with \fI\%ncurses\fP: diff --git a/man/curs_util.3x b/man/curs_util.3x index 7e162e95..1df0a1d3 100644 --- a/man/curs_util.3x +++ b/man/curs_util.3x @@ -28,8 +28,8 @@ .\" 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.101 2024/04/20 21:20:07 tom Exp $ +.TH curs_util 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -63,11 +63,11 @@ miscellaneous \fIcurses\fR utility routines .nf \fB#include .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); -\fBconst char *key_name(wchar_t \fIw\fP); +\fBconst char *key_name(wchar_t \fIwc\fP); .PP \fBvoid filter(void); .PP @@ -86,7 +86,7 @@ miscellaneous \fIcurses\fR utility routines .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. @@ -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 -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. @@ -302,7 +302,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. -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 @@ -364,7 +364,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" -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: diff --git a/man/curs_window.3x b/man/curs_window.3x index 1bb1a57d..d3d55c75 100644 --- a/man/curs_window.3x +++ b/man/curs_window.3x @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_window.3x,v 1.46 2024/03/16 15:35:01 tom Exp $ -.TH curs_window 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_window.3x,v 1.48 2024/04/20 21:20:07 tom Exp $ +.TH curs_window 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 @@ -222,7 +222,7 @@ degrade performance. .PP Note that \fBsyncok\fP may be a macro. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions. +X/Open Curses, Issue 4 describes these functions. .PP X/Open Curses states regarding \fBdelwin\fP: .bP diff --git a/man/form_driver.3x b/man/form_driver.3x index 893f7d81..882a49dd 100644 --- a/man/form_driver.3x +++ b/man/form_driver.3x @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_driver.3x,v 1.59 2024/03/16 15:35:01 tom Exp $ -.TH form_driver 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: form_driver.3x,v 1.61 2024/04/20 18:55:09 tom Exp $ +.TH form_driver 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 @@ -43,7 +43,7 @@ command-processing loop of the form system \fB#include .PP \fBint form_driver(FORM *\fIform\fP, int \fIc\fP); -\fBint form_driver_w(FORM *\fIform\fP, int \fIc\fP, wchar_t \fIwch\fP); +\fBint form_driver_w(FORM *\fIform\fP, int \fIc\fP, wchar_t \fIwc\fP); .fi .SH DESCRIPTION .SS form_driver diff --git a/man/legacy_coding.3x b/man/legacy_coding.3x index 7bf1cdcc..ccfdd556 100644 --- a/man/legacy_coding.3x +++ b/man/legacy_coding.3x @@ -29,8 +29,8 @@ .\" .\" Author: Thomas E. Dickey .\" -.\" $Id: legacy_coding.3x,v 1.26 2024/03/16 15:35:01 tom Exp $ -.TH legacy_coding 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: legacy_coding.3x,v 1.28 2024/04/20 19:13:50 tom Exp $ +.TH legacy_coding 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME \fB\%use_legacy_coding\fP \- override \fIcurses\fR locale encoding checks @@ -41,38 +41,63 @@ override \fIcurses\fR locale encoding checks \fBint use_legacy_coding(int \fIlevel\fP); .fi .SH DESCRIPTION -The \fBuse_legacy_coding\fP function is an extension to the curses library. -It allows the caller to change the result of \fBunctrl\fP, -and suppress related checks within the library that would normally -cause nonprinting characters to be rendered in visible form. -This affects only 8-bit characters. +.B \%use_legacy_coding +is an extension to the +.I curses +library. +It allows the caller to change the result of \fB\%unctrl\fP(3X), +suppressing \fI\%isprint\fP(3)-based checks within the library that +would normally cause nonprinting characters to be rendered in visible +form. +The alteration affects only eight-bit characters. .PP -The \fIlevel\fP parameter controls the result: +The +.I level +parameter controls the result. .RS .TP 5 -0 -the library functions normally, -rendering nonprinting characters as described in \fBunctrl\fP. +.B 0 +The library functions normally, +rendering nonprinting characters as described in \fB\%unctrl\fP(3X), .TP -1 -the library ignores \fBisprintf\fP for codes in the range 160-255. +.B 1 +the library ignores +.I \%isprint +for codes in the range 160-255. .TP -2 -the library ignores \fBisprintf\fP for codes in the range 128-255. -It also modifies the output of \fBunctrl\fP, showing codes in the -range 128-159 as is. +.B 2 +the library ignores +.I \%isprint +for codes in the range 128-255. +It also modifies the output of \fB\%unctrl\fP(3X), +showing codes in the range 128-159 as is. .RE .SH RETURN VALUE If the screen has not been initialized, -or the \fIlevel\fP parameter is out of range, -the function returns \fBERR\fP. -Otherwise, it returns the previous level: \fB0\fP, \fB1\fP or \fB2\fP. +or the +.I level +parameter is out of range, +.B \%use_legacy_coding +returns +.BR ERR . +Otherwise, +it returns the previous level: +.BR 0 , +.BR 1 , +or +.BR 2 . .SH PORTABILITY -This routine is specific to \fI\%ncurses\fP. +.B \%use_legacy_coding +is specific to +.IR \%ncurses . It was not supported on Version 7, BSD or System V implementations. -It is recommended that any code depending on \fI\%ncurses\fP extensions -be conditioned using NCURSES_VERSION. +Applications employing +.I \%ncurses +extensions should condition their use on the visibility of the +.B \%NCURSES_VERSION +preprocessor macro. .SH AUTHORS -Thomas Dickey (to support lynx's font-switching feature). +Thomas Dickey +(to support \fI\%lynx\fP(1)'s font-switching feature). .SH SEE ALSO \fB\%unctrl\fP(3X) diff --git a/man/manhtml.externs b/man/manhtml.externs index c5dff79d..41aa6359 100644 --- a/man/manhtml.externs +++ b/man/manhtml.externs @@ -1,4 +1,4 @@ -# $Id: manhtml.externs,v 1.24 2024/04/14 00:15:03 tom Exp $ +# $Id: manhtml.externs,v 1.25 2024/04/20 19:26:05 tom Exp $ # Items in this list will not be linked by man2html #*************************************************************************** # Copyright 2019-2023,2024 Thomas E. Dickey * @@ -48,6 +48,7 @@ mutt(1) nvi(1) od(1) ioctl(2) +isprint(3) printf(3) profile(5) putc(3) diff --git a/man/manlinks.sed b/man/manlinks.sed index 2f09cbbe..18f67c24 100644 --- a/man/manlinks.sed +++ b/man/manlinks.sed @@ -1,4 +1,4 @@ -# $Id: manlinks.sed,v 1.19 2023/09/17 08:26:33 tom Exp $ +# $Id: manlinks.sed,v 1.20 2024/04/20 22:25:36 tom Exp $ ############################################################################## # Copyright 2020-2021,2023 Thomas E. Dickey # # Copyright 2000-2003,2008 Free Software Foundation, Inc. # @@ -84,6 +84,7 @@ s/ /\ # # Finally, remove the parameter list, which begins with a '('. /^\.SH_(SYNOPSIS/,/^\.SH_(DESCRIPTION/{ +/^\.ti/d /^[^(]*$/d # reduce # .B "int add_wch( const cchar_t *\fIwch\fB );" diff --git a/man/ncurses.3x b/man/ncurses.3x index 48c64944..b8594626 100644 --- a/man/ncurses.3x +++ b/man/ncurses.3x @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: ncurses.3x,v 1.207 2024/04/14 00:34:00 tom Exp $ -.TH ncurses 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: ncurses.3x,v 1.210 2024/04/20 21:24:19 tom Exp $ +.TH ncurses 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -46,6 +46,14 @@ .el .IP \(bu 2 .. . +.\" Add supplementary paragraph tag on its own line after TP. +.\" Adapted from TQ (which would produce mandoc warnings). +.de tQ +. br +. ns +. TP +.. +. .ds d @TERMINFO@ .SH NAME \fB\%ncurses\fP \- @@ -67,8 +75,10 @@ System V Release 4 Unix (\*(``SVr4\*('') and 4.4BSD Unix, the development of which ceased in the 1990s. -This describes \fI\%ncurses\fP -version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). +This document describes +.I \%ncurses +version @NCURSES_MAJOR@.@NCURSES_MINOR@ +(patch @NCURSES_PATCH@). .PP .I \%ncurses permits control of the terminal screen's contents; @@ -404,6 +414,10 @@ man pages apply the following names to parameters. center; Li L. bf \fIbool\fP (\fBTRUE\fP or \fBFALSE\fP) +c a \fIchar\fP or \fIint\fP +ch a \fIchtype\fP +wc a \fIwchar_t\fP or \fIwint_t\fP +wch a \fIcchar_t\fP win pointer to a \fIWINDOW\fP pad pointer to a \fIWINDOW\fP that is a pad .TE @@ -1030,8 +1044,11 @@ on failure. Typically, .I \%ncurses treats a null pointer passed as a function parameter as a failure. -Functions with a \*(``mv\*('' prefix first perform cursor movement using -\fB\%wmove\fP(3X) and fail if the position is outside the window. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH ENVIRONMENT The following symbols from the process environment customize the runtime behavior of @@ -1428,142 +1445,206 @@ If defined with an integral value, the library calls \fB\%curses_trace\fP(3X) with that value as the argument. .SS "\fITERM\fP" -Denotes your terminal type. -Each terminal type is distinct, though many are similar. -.PP -\fITERM\fP is commonly set by terminal emulators to help -applications find a workable terminal description. -Some of those choose a popular approximation, e.g., -\*(``ansi\*('', \*(``vt100\*('', \*(``xterm\*('' rather than an exact fit. -Not infrequently, your application will have problems with that approach, -e.g., incorrect function-key definitions. -.PP -If you set \fITERM\fP in your environment, -it has no effect on the operation of the terminal emulator. -It only affects the way applications work within the terminal. -Likewise, as a general rule (\fBxterm\fP(1) being a rare exception), -terminal emulators which allow you to -specify \fITERM\fP as a parameter or configuration value do -not change their behavior to match that setting. +The +.I TERM +variable denotes the terminal type. +Each is distinct, +though many are similar. +It is commonly set by terminal emulators to help applications find a +workable terminal description. +Some choose a popular approximation such as \*(``ansi\*('', +\*(``vt100\*('', or \*(``xterm\*('' rather than an exact fit to their +capabilities. +Not infrequently, +an application will have problems with that approach; +for example, +a key stroke may not operate correctly, +or produce no effect but seeming garbage characters on the screen. +.PP +Setting +.I TERM +has no effect on hardware operation; +it affects the way applications communicate with the terminal. +Likewise, +as a general rule +(\fIxterm\fP(1) being a rare exception), +terminal emulators that allow you to specify +.I TERM +as a parameter or configuration value do not change their behavior to +match that setting. .SS "\fITERMCAP\fP" -If the \fI\%ncurses\fP library has been configured with \fItermcap\fP -support, \fI\%ncurses\fP will check for a terminal's description in -termcap form if it is not available in the terminfo database. -.PP -The \fI\%TERMCAP\fP environment variable contains -either a terminal description (with newlines stripped out), -or a file name telling where the information denoted by -the \fITERM\fP environment variable exists. -In either case, setting it directs \fI\%ncurses\fP to ignore -the usual place for this information, e.g., /etc/termcap. +If +.I \%ncurses +is configured with +.I termcap +support, +it checks for a terminal type description in +.I termcap +format if one in +.I \%term\%info +format is not available. +Setting this variable directs +.I \%ncurses +to ignore the usual +.I termcap +database location, +.IR \%/etc/termcap ; +see +.I \%TERMPATH +below. +.I \%TERMCAP +should contain either a terminal description +(with newlines stripped out), +or a file name indicating where the information required by the +.I TERM +environment variable is stored. .SS "\fITERMINFO\fP" -\fI\%ncurses\fP can be configured to read from multiple terminal -databases. -The \fI\%TERMINFO\fP variable overrides the location for -the default terminal database. -Terminal descriptions (in terminal format) are stored in terminal databases: +.I \%ncurses +can be configured to read terminal type description databases in various +locations using different formats. +This variable overrides the default location. .bP -Normally these are stored in a directory tree, -using subdirectories named by the first letter of the terminal names therein. -.IP -This is the scheme used in System V, which legacy Unix systems use, -and the \fI\%TERMINFO\fP variable is used by \fIcurses\fP applications -on those -systems to override the default location of the terminal database. -.IP \(bu 4 -If \fI\%ncurses\fP is built to use hashed databases, -then each entry in this list may be the path of a hashed database file, e.g., -.RS 4 -.PP -.RS 4 -.EX -/usr/share/terminfo.db -.EE -.RE -.PP +Descriptions in +.I \%term\%info +format are normally stored in a directory tree using subdirectories +named by the common first letters of the terminal types named therein. +This is the scheme used in System\ V. +.bP +If +.I \%ncurses +is configured to use hashed databases, +then +.I \%TERM\%INFO +may name its location, +such as +.IR \%/usr/share/terminfo.db , rather than +.IR \%/usr/share/terminfo/ . .PP -.RS 4 -.EX -/usr/share/terminfo/ -.EE -.RE -.PP -The hashed database uses less disk-space and is a little faster than the +The hashed database uses less disk space and is a little faster than the directory tree. However, some applications assume the existence of the directory tree, -reading it directly -rather than using the terminfo library calls. -.RE +and read it directly +rather than using the +.I \%term\%info +API. .bP -If \fI\%ncurses\fP is built with a support for reading termcap files -directly, then an entry in this list may be the path of a termcap file. -.IP \(bu 4 -If the \fI\%TERMINFO\fP variable begins with -\*(``hex:\*('' or \*(``b64:\*('', -\fI\%ncurses\fP uses the remainder of that variable as a compiled -terminal description. -You might produce the base64 format using \fBinfocmp\fP(1M): -.RS 4 -.PP +If +.I \%ncurses +is configured with +.I termcap +support, +this variable may contain the location of a +.I \%termcap +file. +.bP +If the value of +.I \%TERM\%INFO +begins with \*(``hex:\*('' or \*(``b64:\*('', +.I \%ncurses +uses the remainder of the value as a compiled +.I \%term\%info +description. +You might produce the base64 format using \fB\%infocmp\fP(1M). .RS 4 +.IP .EX -TERMINFO="$(infocmp \-0 \-Q2 \-q)" +TERMINFO=$(infocmp \-0 \-Q2 \-q) export TERMINFO .EE .RE +.IP +The compiled description is used only if it corresponds to the terminal +type identified by +.IR TERM . .PP -The compiled description is used if it corresponds to the terminal identified -by the \fITERM\fP variable. -.RE -.PP -Setting \fI\%TERMINFO\fP is the simplest, -but not the only way to set location of the default terminal database. -The complete list of database locations in order follows: -.RS 3 +Setting +.I \%TERM\%INFO +is the simplest, +but not the only, +way to direct +.I \%ncurses +to a terminal database. +The search path is as follows. .bP -the last terminal database to which \fI\%ncurses\fP wrote, -if any, is searched first +the last terminal database to which the running +.I \%ncurses +application wrote, +if any .bP -the location specified by the \fI\%TERMINFO\fP environment variable +the location specified by the +.I \%TERM\%INFO +environment variable .bP -$HOME/.terminfo +.I $HOME/.terminfo .bP -locations listed in the \fI\%TERMINFO_DIRS\fP environment variable +locations listed in the +.I \%TERMINFO_DIRS +environment variable +.ds td \" empty +.if !'@TERMINFO_DIRS@'no default value' .as td @TERMINFO_DIRS@ +.if !'@TERMINFO@\*(td'' \{\ .bP -one or more locations whose names are configured and compiled into the -\fI\%ncurses\fP library, i.e., +location(s) configured and compiled into +.I \%ncurses .RS 3 +.if !'\*(td'' \{\ .bP -@TERMINFO_DIRS@ (corresponding to the \fI\%TERMINFO_DIRS\fP variable) +.I \%@TERMINFO_DIRS@ +.\} +.if !'@TERMINFO'' .if !'\*(td'@TERMINFO@' \{\ .bP -@TERMINFO@ (corresponding to the \fITERMINFO\fP variable) -.RE +.I \%@TERMINFO@ +.\} +.\} .RE .SS "\fITERMINFO_DIRS\fP" -Specifies a list of locations to search for terminal descriptions. -Each location in the list is a terminal database as described in -the section on the \fI\%TERMINFO\fP variable. -The list is separated by colons (i.e., ":") on Unix, semicolons on OS/2 EMX. -.PP -There is no corresponding feature in System V terminfo; -it is an extension developed for \fI\%ncurses\fP. +This variable specifies a list of locations, +akin to +.IR PATH , +in which +.I \%ncurses +searches for the terminal type descriptions described by +.I \%TERMINFO +above. +The list items are separated by colons on Unix +and semicolons on OS/2 EMX. +System\ V +.I \%term\%info +lacks a corresponding feature; +.I \%TERMINFO_DIRS +is an +.I \%ncurses +extension. .SS "\fITERMPATH\fP" -If \fI\%TERMCAP\fP does not hold a file name then \fI\%ncurses\fP checks -the \fI\%TERMPATH\fP environment variable. -This is a list of filenames separated by spaces or colons (i.e., ":") on Unix, -semicolons on OS/2 EMX. -.PP -If the \fI\%TERMPATH\fP environment variable is not set, -\fI\%ncurses\fP looks in the files -.PP -.RS 4 -.EX -/etc/termcap, /usr/share/misc/termcap and $HOME/.termcap, -.EE -.RE +If +.I \%TERMCAP +does not hold a terminal type description or file name, +then +.I \%ncurses +checks the contents of +.IR \%TERMPATH , +a list of locations, +akin to +.IR PATH , +in which it searches for +.I termcap +terminal type descriptions. +The list items are separated by colons on Unix +and semicolons on OS/2 EMX. .PP +If both +.I \%TERMCAP +and +.I \%TERMPATH +are unset or invalid, +.I \%ncurses +searches for the files +.IR \%/etc/termcap , +.IR \%/usr/share/misc/termcap , +and +.IR \%$HOME/.termcap , in that order. .SH "ALTERNATE CONFIGURATIONS" Many different @@ -1579,7 +1660,7 @@ A few are of particular significance to the application developer employing .IR \%ncurses . .TP 5 -\-\-disable\-overwrite +.B \-\-disable\-overwrite The standard include for \fI\%ncurses\fP is as noted in \fBSYNOPSIS\fP: .RS 5 .PP @@ -1605,7 +1686,7 @@ It also omits a symbolic link which would allow you to use \fB\-lcurses\fP to build executables. .RE .TP 5 -\-\-enable\-widec +.B \-\-enable\-widec The configure script renames the library and (if the \fB\-\-disable\-overwrite\fP option is used) puts the header files in a different subdirectory. @@ -1630,7 +1711,8 @@ you link with You must also enable the wide-character features in the header file when compiling for the wide-character library to use the extended (wide-character) functions. -The symbol which enables these features has changed since XSI Curses, Issue 4: +The symbol which enables these features has changed +since X/Open Curses, Issue 4: .bP Originally, the wide-character feature required the symbol \fB_XOPEN_SOURCE_EXTENDED\fP @@ -1659,7 +1741,7 @@ to allow applications to be built using either library from the same set of headers. .RE .TP 5 -\-\-with\-pthread +.B \-\-with\-pthread The configure script renames the library. All of the library names have a \*(``t\*('' appended to them (before any \*(``w\*('' added by \fB\-\-enable\-widec\fP). @@ -1669,20 +1751,20 @@ allow read-only access. At the same time, setter-functions are provided to set these values. Some applications (very few) may require changes to work with this convention. .TP 5 -\-\-with\-shared -.TP -\-\-with\-normal -.TP -\-\-with\-debug -.TP -\-\-with\-profile +.B \-\-with\-shared +.tQ +.B \-\-with\-normal +.tQ +.B \-\-with\-debug +.tQ +.B \-\-with\-profile The shared and normal (static) library names differ by their suffixes, e.g., \fBlibncurses.so\fP and \fBlibncurses.a\fP. The debug and profiling libraries add a \*(``_g\*('' and a \*(``_p\*('' to the root names respectively, e.g., \fBlibncurses_g.a\fP and \fBlibncurses_p.a\fP. .TP 5 -\-\-with\-termlib +.B \-\-with\-termlib Low-level functions which do not depend upon whether the library supports wide-characters, are provided in the tinfo library. .IP @@ -1709,7 +1791,7 @@ database \fB\%curs_util\fP(3X) \- miscellaneous \fIcurses\fP utility routines .RE .TP 5 -\-\-with\-trace +.B \-\-with\-trace The \fBtrace\fP function normally resides in the debug library, but it is sometimes useful to configure this in the shared library. Configure scripts should check for the function's existence rather @@ -1743,15 +1825,15 @@ If the standard output file descriptor of an .I \%ncurses program is redirected to something that is not a terminal device, the library writes screen updates to the standard error file descriptor. -This was an undocumented feature of SVr3. +This was an undocumented feature of SVr3 +.IR curses . .PP -See subsection \*(``Header files\*('' below regarding symbols exposed by +See subsection \*(``Header Files\*('' below regarding symbols exposed by inclusion of \fI\%curses.h\fP. .SH EXTENSIONS .I \%ncurses enables an application to capture mouse events on certain terminals, -including -.IR \%xterm ; +including \fI\%xterm\fP(1); see \fB\%curs_mouse\fP(3X). .PP .I \%ncurses @@ -1768,10 +1850,11 @@ see \fB\%has_key\fP(3X). .I \%ncurses extends the fixed set of function key capabilities specified by X/Open Curses by allowing the application programmer to define additional key -sequences at runtime; +events at runtime; see \fB\%define_key\fP(3X), \fB\%key_defined\fP(3X), +\fB\%keybound\fP(3X), and \fB\%keyok\fP(3X). .PP @@ -1788,9 +1871,9 @@ See \fB\%default_colors\fP(3X). .PP An .I \%ncurses -application can choose to hide the internal details of +application can eschew knowledge of .I \%WINDOW -structures, +structure internals, instead using accessor functions such as \fB\%is_scrollok\fP(3X). .PP @@ -1806,7 +1889,10 @@ and \fB\%extended_slk_color\fP(3X) as a form of \fB\%slk_color\fP(3X) that can gather color information from them when many colors are supported. .PP -Some extensions are only available if +Some extensions are available only if +.I \%ncurses +permits modification of \fB\%unctrl\fP(3X)'s behavior; +see \fB\%use_legacy_coding\fP(3X). .I \%ncurses is compiled to support them; section \*(``ALTERNATE CONFIGURATIONS\*('' describes how. @@ -1856,7 +1942,7 @@ The latter includes several additional features, such as wide-character and color support. .I \%ncurses intends base-level conformance with X/Open Curses, -and supports nearly all its enhanced features. +and supports nearly all features of its enhanced level. .\" XXX: What's missing? GBR counts untic(1), and that's all. .PP Differences between X/Open Curses and @@ -1867,125 +1953,308 @@ pages. In many cases, X/Open Curses is vague about error conditions, omitting some of the SVr4 documentation. .PP -Unlike other implementations, this one checks parameters such as pointers -to \fI\%WINDOW\fP structures to ensure they are not null. -The main reason for providing this behavior is to guard against programmer -error. +Unlike other implementations, +.I \%ncurses +checks pointer parameters, +such as those to +.I \%WINDOW +structures, +to ensure that they are not null. +This is done primarily to guard against programmer error. The standard interface does not provide a way for the library -to tell an application which of several possible errors were detected. -Relying on this (or some other) extension will adversely affect the -portability of curses applications. +to tell an application which of several possible errors occurred. +Relying on this +(or some other) +extension adversely affects the portability of +.I curses +applications. .SS "Padding Differences" -In historic curses versions, delays embedded in the capabilities \fBcr\fP, -\fBind\fP, \fBcub1\fP, \fBff\fP and \fBtab\fP activated corresponding delay -bits in the Unix tty driver. -In this implementation, all padding is done by sending NUL bytes. -This method is slightly more expensive, but narrows the interface -to the Unix kernel significantly and increases the package's portability -correspondingly. +In historical +.I curses +implementations, +delays embedded in the +.I \%term\%info +capabilities +.B \%carriage_return +.RB ( cr ), +.B \%scroll_forward +.RB ( ind ), +.B \%cursor_left +.RB ( cub1 ), +.B \%form_feed +.RB ( ff ), +and +.B \%tab +.RB ( ht ) +activated corresponding delay bits in the Unix terminal driver. +.I \%ncurses +performs all padding by sending NUL bytes to the device. +This method is slightly more expensive, +but narrows the interface to the Unix kernel significantly and +correspondingly increases the package's portability. .SS "Header Files" -The header file \fI\%curses.h\fP itself includes the header files -\fI\%stdio.h\fP and \fI\%unctrl.h\fP. +The header file +.I \%curses.h +itself includes the header files +.I \%stdio.h +and +.IR \%unctrl.h . .PP X/Open Curses has more to say, -but does not finish the story: .RS 4 .PP -The inclusion of may make visible all symbols -from the headers , , , and . +The inclusion of +.I \%curses.h +may make visible all symbols from the headers +.IR \%stdio.h , +.IR \%term.h , +.IR \%termios.h , +and +.IR \%wchar.h . .RE .PP -Here is a more complete story: +but does not finish the story. +A more complete account follows. .bP -Starting with BSD curses, all implementations have included . +Starting with 4BSD +.I curses +(1980) +all implementations have provided a +.I \%curses.h +file. .IP -BSD curses included and from an internal header -file -.I \%curses.ext -(\*(``ext\*('' abbreviated \*(``externs\*(''). +BSD +.I curses +code included +.I \%curses.h +and +.I \%unctrl.h +from an internal header file +.IR \%curses.ext , +where +\*(``ext\*('' abbreviated \*(``externs\*(''. .IP -BSD curses used internally (for \fBprintw\fP and \fBscanw\fP), -but nothing in itself relied upon . +The implementations of +.I \%printw +and +.I \%scanw +used undocumented internal functions of the standard I/O library +.RI ( _doprnt +and +.IR _doscan ), +but nothing in +.I \%curses.h +itself relied upon +.IR \%stdio.h . .bP -SVr2 curses added \fBnewterm\fP(3X), which relies upon . -That is, the function prototype uses \fBFILE\fP. +SVr2 +.I curses +added +.IR \%newterm , +which relies upon +.I \%stdio.h +because its function prototype employs the +.I FILE +type. .IP -SVr4 curses added \fBputwin\fP and \fBgetwin\fP, which also use . +SVr4 +.I curses +added +.I \%putwin +and +.IR \%getwin , +which also use +.IR \%stdio.h . .IP -X/Open Curses documents all three of these functions. +X/Open Curses specifies all three of these functions. .IP -SVr4 curses and X/Open Curses do not require the developer to -include before including . -Both document curses showing as the only required header. +SVr4 +.I curses +and X/Open Curses do not require the developer to include +.I \%stdio.h +before +.IR \%curses.h . +Both document use of +.I curses +as requiring only +.IR \%curses.h . .IP -As a result, standard will always include . +As a result, +standard +.I \%curses.h +always includes +.IR \%stdio.h . .bP -X/Open Curses is inconsistent with respect to SVr4 regarding . +X/Open Curses and SVr4 +.I curses +are inconsistent with respect to +.IR \%unctrl.h . .IP As noted in \fBcurs_util\fP(3X), -\fI\%ncurses\fP includes from -(like SVr4). +.I \%ncurses +includes +.I \%unctrl.h +from +.I \%curses.h +(as SVr4 does). .bP -X/Open's comments about and may refer to HP-UX and AIX: +X/Open Curses's comments about +.I \%term.h +and +.I \%termios.h +may refer to HP-UX and AIX. .IP -HP-UX curses includes from -to declare \fBsetupterm\fP in curses.h, -but \fI\%ncurses\fP (and Solaris curses) do not. +HP-UX +.I curses +includes +.I \%term.h +from +.I \%curses.h +to declare +.I \%setupterm +in +.IR \%curses.h , +but +.I \%ncurses +and Solaris +.I curses +do not. .IP -AIX curses includes and . -Again, \fI\%ncurses\fP (and Solaris curses) do not. +AIX +.I curses +includes +.I \%term.h +and +.IR \% termios.h . +Again, +.I \%ncurses +and Solaris +.I curses +do not. .bP -X/Open says that \fImay\fP include , -but there is no requirement that it do that. +X/Open Curses says that +.I \%curses.h +.B may +include +.IR \%term.h , +but does not require it to do so. .IP -Some programs use functions declared in both and , -and must include both headers in the same module. -Very old versions of AIX curses required including -before including . +Some programs use functions declared in both +.I \%curses.h +and +.IR \%term.h , +and must include both header files in the same module. +Very old versions of AIX +.I curses +required inclusion of +.I \%curses.h +before +.IR \%term.h . .IP -Because \fI\%ncurses\fP header files include the headers needed to -define datatypes used in the headers, -\fI\%ncurses\fP header files can be included in any order. -But for portability, you should include before . +The header files supplied by +.I \%ncurses +include the standard library headers required for its declarations, +so +.IR \%ncurses 's +own header files can be included in any order. +But for portability, +you should include +.I \%curses.h +before +.IR \%term.h . .bP -X/Open Curses says \fI"may make visible"\fP -because including a header file does not necessarily make all symbols -in it visible (there are ifdef's to consider). +X/Open Curses says \*(``may make visible\*('' because including a header +file does not necessarily make visible all of the symbols in it +(consider +.B \%#ifdef +and similar). .IP -For instance, in \fI\%ncurses\fP \fImay\fP be included if -the proper symbol is defined, and if \fI\%ncurses\fP is configured for -wide-character support. -If the header is included, its symbols may be made visible. -That depends on the value used for \fB_XOPEN_SOURCE\fP +For instance, +.IR \%ncurses 's +.I \%curses.h +.B may \" bold to contrast with preceding italic +include +.I \%wchar.h +if the proper symbol is defined, +and if +.I \%ncurses +is configured for wide-character support. +If +.I \%wchar.h +is included, +its symbols +.B may \" bold for consistency in this paragraph +be made visible depending on the value of the +.B _XOPEN_SOURCE feature test macro. .bP -X/Open Curses documents one required header, -in a special case: before to prototype -the \fBvw_printw\fP and \fBvw_scanw\fP functions +X/Open Curses mandates an application's inclusion of one standard C +library header in a special case: +.I \%stdarg.h +before +.I \%curses.h +to prototype the functions +.I \%vw_printw +and +.I \%vw_scanw (as well as the obsolete -the \fBvwprintw\fP and \fBvwscanw\fP functions). -Each of those uses a \fBva_list\fP parameter. +.I \%vwprintw +and +.IR \%vwscanw ). +Each of these takes a variadic argument list, +a +.I \%va_list +parameter, +like that of \fI\%printf\fP(3). .IP -The two obsolete functions were introduced in SVr3. -The other functions were introduced in X/Open Curses. -In between, SVr4 curses provided for the possibility that -an application might include either or . -Initially, that was done by using \fBvoid*\fP for the \fBva_list\fP +SVr3 +.I curses +introduced +the two obsolete functions, +and X/Open Curses the others. +In between, +SVr4 +.I curses +provided for the possibility that an application might include either +.I \%varargs.h +or +.IR \%stdarg.h . +These represented contrasting approaches to handling variadic +argument lists. +The older interface, +.IR \%varargs.h , +used a pointer to +.I char \" V7, 32V, System III, 3BSD +for variadic functions' +.I \%va_list parameter. -Later, a special type (defined in ) was introduced, -to allow for compiler type-checking. -That special type is always available, -because is always included by . +Later, +the list acquired its own standard data type, +.IR \%va_list , +defined in +.IR \%stdarg.h , +empowering the compiler to check the types of a function call's actual +parameters against the formal ones declared in its prototype. .IP -None of the X/Open Curses implementations require an application -to include before because they either -have allowed for a special type, -or -(like \fI\%ncurses\fP) -include directly to provide a portable interface. +No conforming implementations of X/Open Curses require an application +to include +.I \%stdarg.h +before +.I \%curses.h +because they either have allowed for a special type, +or, +like +.IR \%ncurses , +they include +.I \%stdarg.h +themselves to provide a portable interface. .SH AUTHORS -Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. -Based on \fIpcurses\fP by Pavel Curtis. +Zeyd M. Ben-Halim, +Eric S. Raymond, +Thomas E. Dickey. +Based on +.I \%pcurses +by Pavel Curtis. .SH SEE ALSO \fB\%curs_variables\fP(3X), \fB\%terminfo\fP(5), diff --git a/man/tabs.1 b/man/tabs.1 index e942125b..059bc1ec 100644 --- a/man/tabs.1 +++ b/man/tabs.1 @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: tabs.1,v 1.57 2024/03/16 15:35:01 tom Exp $ -.TH @TABS@ 1 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" +.\" $Id: tabs.1,v 1.59 2024/04/20 19:08:15 tom Exp $ +.TH @TABS@ 1 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -272,15 +272,14 @@ and in 3BSD (later the same year); it supported a \*(``\-n\*('' option to set the first tab stop at the left margin. -That option is not documented by POSIX. +That option is not specified by POSIX. .PP The PWB/Unix .B tabs utility returned in System III (1980), -and used built-in tables, -rather than the terminal database, +and used built-in tables to support a half-dozen hardcopy terminal (printer) types. -It also had built-in logic to support setting the left margin, +It also had logic to support setting the left margin, as well as a feature for copying the tab settings from a file. .PP Versions of the program in later releases of AT&T Unix, diff --git a/man/term.5 b/man/term.5 index 3527c3ca..cec231f5 100644 --- a/man/term.5 +++ b/man/term.5 @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: term.5,v 1.75 2024/03/16 15:35:01 tom Exp $ -.TH term 5 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "File formats" +.\" $Id: term.5,v 1.77 2024/04/20 21:24:19 tom Exp $ +.TH term 5 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "File formats" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -327,7 +327,7 @@ The problem is that there are at least three versions of terminfo (under HP\-UX, AIX, and OSF/1) which diverged from System V terminfo after SVr1, and have added extension capabilities to the string table that (in the binary format) collide with -System V and XSI Curses extensions. +System V and X/Open Curses extensions. See \fBterminfo\fP(5) for detailed discussion of terminfo source compatibility issues. .PP diff --git a/man/terminfo.head b/man/terminfo.head index b0f49eda..717f849e 100644 --- a/man/terminfo.head +++ b/man/terminfo.head @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: terminfo.head,v 1.63 2024/01/13 23:07:27 tom Exp $ -.TH terminfo 5 2024-01-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "File formats" +.\" $Id: terminfo.head,v 1.65 2024/04/20 21:14:00 tom Exp $ +.TH terminfo 5 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "File formats" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -75,8 +75,10 @@ describes terminals by giving a set of capabilities which they have, by specifying how to perform screen operations, and by specifying padding requirements and initialization sequences. .PP -This manual describes \fI\%ncurses\fP -version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). +This document describes +.I \%ncurses +version @NCURSES_MAJOR@.@NCURSES_MINOR@ +(patch @NCURSES_PATCH@). .SS "\fIterminfo\fP Entry Syntax" Entries in .I terminfo diff --git a/man/terminfo.tail b/man/terminfo.tail index 9bc31e4d..4d6daa38 100644 --- a/man/terminfo.tail +++ b/man/terminfo.tail @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: terminfo.tail,v 1.144 2024/03/02 14:36:39 tom Exp $ +.\" $Id: terminfo.tail,v 1.148 2024/04/20 21:24:19 tom Exp $ .ps +1 .SS "User-Defined Capabilities" . @@ -892,7 +892,7 @@ and do \fBri\fP followed by \fBdl1\fP or \fBind\fP. If the data scrolled off the bottom of the region by the \fBri\fP re-appears, then scrolling is non-destructive. -System V and XSI Curses expect that \fBind\fP, \fBri\fP, +System V and X/Open Curses expect that \fBind\fP, \fBri\fP, \fBindn\fP, and \fBrin\fP will simulate destructive scrolling; their documentation cautions you not to define \fBcsr\fP unless this is true. This \fBcurses\fP implementation is more liberal and will do explicit erases @@ -914,7 +914,7 @@ or that scrolling back with \fBri\fP may bring down non-blank lines. .SS "Insert/Delete Character" There are two basic kinds of intelligent terminals with respect to insert/delete character which can be described using -.I terminfo. +.IR terminfo . The most common insert/delete character operations affect only the characters on the current line and shift characters off the end of the line rigidly. Other terminals, such as the Concept 100 and the Perkin Elmer Owl, make @@ -1008,7 +1008,7 @@ to delete a single character, with one parameter, .IR n , to delete -.I n characters, +.IR n "characters," and delete mode by giving \fBsmdc\fP and \fBrmdc\fP to enter and exit delete mode (any mode the terminal needs to be placed in for @@ -2045,7 +2045,7 @@ See the \fBInsert/Delete Character\fP subsection above. .PP The parameter substitutions for \fBset_clock\fP and \fBdisplay_clock\fP are -not documented in SVr4 or the XSI Curses standard. +not documented in SVr4 or X/Open Curses. They are deduced from the documentation for the AT&T 505 terminal. .PP @@ -2064,7 +2064,7 @@ If italics should work with colors, then the \fBncv\fP value must be specified, even if it is zero. .PP Different commercial ports of \fI\%terminfo\fP and \fIcurses\fP support -different subsets of XSI Curses and +different subsets of X/Open Curses and (in some cases) different extensions. Here is a summary, @@ -2110,7 +2110,7 @@ At least two implementations of \fI\%terminfo\fP diverged from those of other System V Unices after SVr1, adding extension capabilities to the string table that (in the binary format) -collide with subsequent System V and XSI Curses extensions. +collide with subsequent System V and X/Open Curses extensions. .SH AUTHORS Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on \fIpcurses\fP by Pavel Curtis. diff --git a/man/toe.1m b/man/toe.1m index ab8e7340..c4eba848 100644 --- a/man/toe.1m +++ b/man/toe.1m @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: toe.1m,v 1.66 2024/03/16 15:35:01 tom Exp $ -.TH @TOE@ 1M 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" +.\" $Id: toe.1m,v 1.68 2024/04/20 18:59:26 tom Exp $ +.TH @TOE@ 1M 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -85,10 +85,13 @@ lists entries from all terminal database directories that \fIterminfo\fP would search, instead of only the first that it finds. .IP -If the \fB\-s\fP option is also given, -\fB\%@TOE@\fP adds a column to the report, -showing (like \fB\%conflict\fP(1)) which entries belong to a given -terminal database. +If +.B \-s +is also given, +\fB\%@TOE@\fP +additionally reports, +like \fI\%conflict\fP(1), +which entries correspond to a given terminal database. An \*(``*\*('' marks entries that differ, and \*(``+\*('' marks equivalent entries. .IP diff --git a/man/tput.1 b/man/tput.1 index 5da9dd60..eba07339 100644 --- a/man/tput.1 +++ b/man/tput.1 @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: tput.1,v 1.111 2024/04/13 22:09:53 tom Exp $ -.TH @TPUT@ 1 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" +.\" $Id: tput.1,v 1.113 2024/04/20 19:58:50 tom Exp $ +.TH @TPUT@ 1 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -129,8 +129,13 @@ we term them \*(``pseudo-capabilities\*(''. .I cap-code indicates a capability from the terminal database. .IP -If the capability is of string type and takes parameters, -the arguments following the capability will be used as its parameters. +If +.I cap-code +is of string type and takes parameters, +\fB\%@TPUT@\fP interprets arguments following +.I cap-code +as the parameters, +up to the (fixed) quantity the capability requires. .IP Most parameters are numeric. Only a few terminal capabilities require string parameters; diff --git a/man/tset.1 b/man/tset.1 index 14bcb16e..d64f9850 100644 --- a/man/tset.1 +++ b/man/tset.1 @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: tset.1,v 1.81 2024/03/16 15:35:01 tom Exp $ -.TH @TSET@ 1 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" +.\" $Id: tset.1,v 1.83 2024/04/20 19:09:08 tom Exp $ +.TH @TSET@ 1 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -396,18 +396,20 @@ the operating system, the \fILINES\fP and \fICOLUMNS\fP environment variables or the terminal description. .PP -Obtaining the window size from the terminal description is common to -both implementations, but considered obsolescent. +Obtaining the window size from a terminal's type description is common +to both implementations, +but considered obsolescent. Its only practical use is for hardware terminals. -Generally speaking, a window size would be unset only if there were -some problem obtaining the value from the operating system -(and \fBsetupterm\fP would still fail). -For that reason, -the \fILINES\fP and \fI\%COLUMNS\fP environment variables -may be useful for working around window-size problems. -Those have the drawback that if the window is resized, -those variables must be recomputed and reassigned. -To do this more easily, use the \fBresize\fP(1) program. +Generally, +the window size will remain uninitialized only if there were a problem +obtaining the value from the operating system +(and \fB\%setupterm\fP would still fail). +The \fILINES\fP and \fI\%COLUMNS\fP environment variables +may thus be useful for working around window-size problems, +but have the drawback that if the window is resized, +their values must be recomputed and reassigned. +The \fI\%resize\fP(1) program distributed with +\fI\%xterm\fP(1) assists this activity. .SH HISTORY A \fB\%reset\fP command written by Kurt Shoens appeared in 1BSD (March 1978). diff --git a/ncurses/base/resizeterm.c b/ncurses/base/resizeterm.c index b25cf908..1a2ddb36 100644 --- a/ncurses/base/resizeterm.c +++ b/ncurses/base/resizeterm.c @@ -1,5 +1,5 @@ /**************************************************************************** - * Copyright 2020,2021 Thomas E. Dickey * + * Copyright 2020-2021,2024 Thomas E. Dickey * * Copyright 1998-2015,2016 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -46,7 +46,7 @@ #define CUR SP_TERMTYPE #endif -MODULE_ID("$Id: resizeterm.c,v 1.52 2021/10/23 17:12:33 tom Exp $") +MODULE_ID("$Id: resizeterm.c,v 1.53 2024/04/20 21:54:14 tom Exp $") /* * If we're trying to be reentrant, do not want any local statics. @@ -409,8 +409,8 @@ NCURSES_SP_NAME(resize_term) (NCURSES_SP_DCLx int ToLines, int ToCols) #ifdef USE_TERM_DRIVER CallDriver_2(SP_PARM, td_setsize, ToLines, ToCols); #else - lines = (NCURSES_SIZE_T) ToLines; - columns = (NCURSES_SIZE_T) ToCols; + lines = (NCURSES_INT2) ToLines; + columns = (NCURSES_INT2) ToCols; #endif SP_PARM->_lines_avail = (NCURSES_SIZE_T) (ToLines - was_stolen); diff --git a/ncurses/tinfo/lib_setup.c b/ncurses/tinfo/lib_setup.c index f1e6c1a2..99097f00 100644 --- a/ncurses/tinfo/lib_setup.c +++ b/ncurses/tinfo/lib_setup.c @@ -49,7 +49,7 @@ #include #endif -MODULE_ID("$Id: lib_setup.c,v 1.239 2024/04/14 17:03:40 tom Exp $") +MODULE_ID("$Id: lib_setup.c,v 1.240 2024/04/20 17:04:05 tom Exp $") /**************************************************************************** * @@ -490,7 +490,7 @@ _nc_get_screensize(SCREEN *sp, bool useEnv = _nc_prescreen.use_env; bool useTioctl = _nc_prescreen.use_tioctl; - T((T_CALLED("_nc_get_screensize (%p)"), sp)); + T((T_CALLED("_nc_get_screensize (%p)"), (void *) sp)); #ifdef EXP_WIN32_DRIVER /* If we are here, then Windows console is used in terminfo mode. We need to figure out the size using the console API diff --git a/ncurses/tinfo/write_entry.c b/ncurses/tinfo/write_entry.c index f05b4079..8ccca9ec 100644 --- a/ncurses/tinfo/write_entry.c +++ b/ncurses/tinfo/write_entry.c @@ -1,5 +1,5 @@ /**************************************************************************** - * Copyright 2018-2022,2023 Thomas E. Dickey * + * Copyright 2018-2023,2024 Thomas E. Dickey * * Copyright 1998-2016,2017 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -42,7 +42,7 @@ #include -MODULE_ID("$Id: write_entry.c,v 1.131 2023/09/16 16:28:36 tom Exp $") +MODULE_ID("$Id: write_entry.c,v 1.132 2024/04/20 17:58:51 tom Exp $") #if 1 #define TRACE_OUT(p) DEBUG(2, p) @@ -384,7 +384,7 @@ _nc_write_entry(TERMTYPE2 *const tp) sizeof(buffer) - 1); data.size = name_size + 1; - total_size += data.size; + total_size += (int) data.size; total_parts++; _nc_db_put(capdb, &key, &data); @@ -400,7 +400,7 @@ _nc_write_entry(TERMTYPE2 *const tp) key.data = ptr; key.size = strlen(ptr); - total_size += data.size; + total_size += (int) data.size; total_parts++; _nc_db_put(capdb, &key, &data); } diff --git a/package/debian-mingw/changelog b/package/debian-mingw/changelog index 088ed45c..929b0a97 100644 --- a/package/debian-mingw/changelog +++ b/package/debian-mingw/changelog @@ -1,8 +1,8 @@ -ncurses6 (6.4+20240414) unstable; urgency=low +ncurses6 (6.4+20240420) unstable; urgency=low * latest weekly patch - -- Thomas E. Dickey Sun, 14 Apr 2024 04:48:20 -0400 + -- Thomas E. Dickey Sat, 20 Apr 2024 06:17:21 -0400 ncurses6 (5.9+20131005) unstable; urgency=low diff --git a/package/debian-mingw64/changelog b/package/debian-mingw64/changelog index 088ed45c..929b0a97 100644 --- a/package/debian-mingw64/changelog +++ b/package/debian-mingw64/changelog @@ -1,8 +1,8 @@ -ncurses6 (6.4+20240414) unstable; urgency=low +ncurses6 (6.4+20240420) unstable; urgency=low * latest weekly patch - -- Thomas E. Dickey Sun, 14 Apr 2024 04:48:20 -0400 + -- Thomas E. Dickey Sat, 20 Apr 2024 06:17:21 -0400 ncurses6 (5.9+20131005) unstable; urgency=low diff --git a/package/debian/changelog b/package/debian/changelog index 3c405301..a32ccc5b 100644 --- a/package/debian/changelog +++ b/package/debian/changelog @@ -1,8 +1,8 @@ -ncurses6 (6.4+20240414) unstable; urgency=low +ncurses6 (6.4+20240420) unstable; urgency=low * latest weekly patch - -- Thomas E. Dickey Sun, 14 Apr 2024 04:48:20 -0400 + -- Thomas E. Dickey Sat, 20 Apr 2024 06:17:21 -0400 ncurses6 (5.9+20120608) unstable; urgency=low diff --git a/package/mingw-ncurses.nsi b/package/mingw-ncurses.nsi index eb57e1dc..9125446d 100644 --- a/package/mingw-ncurses.nsi +++ b/package/mingw-ncurses.nsi @@ -1,4 +1,4 @@ -; $Id: mingw-ncurses.nsi,v 1.642 2024/04/14 08:48:20 tom Exp $ +; $Id: mingw-ncurses.nsi,v 1.643 2024/04/20 10:17:21 tom Exp $ ; TODO add examples ; TODO bump ABI to 6 @@ -10,7 +10,7 @@ !define VERSION_MAJOR "6" !define VERSION_MINOR "4" !define VERSION_YYYY "2024" -!define VERSION_MMDD "0414" +!define VERSION_MMDD "0420" !define VERSION_PATCH ${VERSION_YYYY}${VERSION_MMDD} !define MY_ABI "5" diff --git a/package/mingw-ncurses.spec b/package/mingw-ncurses.spec index 31ce5996..b9ab089a 100644 --- a/package/mingw-ncurses.spec +++ b/package/mingw-ncurses.spec @@ -3,7 +3,7 @@ Summary: shared libraries for terminal handling Name: mingw32-ncurses6 Version: 6.4 -Release: 20240414 +Release: 20240420 License: X11 Group: Development/Libraries URL: https://invisible-island.net/ncurses/ diff --git a/package/ncurses.spec b/package/ncurses.spec index c02876c9..f72b2ad1 100644 --- a/package/ncurses.spec +++ b/package/ncurses.spec @@ -1,7 +1,7 @@ Summary: shared libraries for terminal handling Name: ncurses6 Version: 6.4 -Release: 20240414 +Release: 20240420 License: X11 Group: Development/Libraries URL: https://invisible-island.net/ncurses/ diff --git a/package/ncursest.spec b/package/ncursest.spec index 9903f058..9116cb80 100644 --- a/package/ncursest.spec +++ b/package/ncursest.spec @@ -1,7 +1,7 @@ Summary: Curses library with POSIX thread support. Name: ncursest6 Version: 6.4 -Release: 20240414 +Release: 20240420 License: X11 Group: Development/Libraries Source: ncurses-%{version}-%{release}.tgz diff --git a/progs/tput.c b/progs/tput.c index 46fcafbe..f9321b60 100644 --- a/progs/tput.c +++ b/progs/tput.c @@ -47,7 +47,7 @@ #include #include -MODULE_ID("$Id: tput.c,v 1.103 2024/03/02 13:22:26 tom Exp $") +MODULE_ID("$Id: tput.c,v 1.104 2024/04/20 22:20:51 tom Exp $") #define PUTS(s) fputs(s, stdout) @@ -178,7 +178,13 @@ tput_cmd(int fd, TTY * settings, int argc, char **argv, int *used) } #if HAVE_SIZECHANGE - set_window_size(fd, &lines, &columns); + { + NCURSES_INT2 my_rows = lines; + NCURSES_INT2 my_cols = columns; + set_window_size(fd, &my_rows, &my_cols); + lines = my_rows; + columns = my_cols; + } #else (void) fd; #endif diff --git a/progs/tset.c b/progs/tset.c index 8bc502a3..69f4aba8 100644 --- a/progs/tset.c +++ b/progs/tset.c @@ -98,7 +98,7 @@ char *ttyname(int fd); #endif -MODULE_ID("$Id: tset.c,v 1.134 2024/04/13 18:59:53 tom Exp $") +MODULE_ID("$Id: tset.c,v 1.135 2024/04/20 22:20:41 tom Exp $") #ifndef environ extern char **environ; @@ -869,7 +869,11 @@ main(int argc, char **argv) if (!noset) { #if HAVE_SIZECHANGE if (opt_w) { - set_window_size(my_fd, &lines, &columns); + NCURSES_INT2 my_rows = lines; + NCURSES_INT2 my_cols = columns; + set_window_size(my_fd, &my_rows, &my_cols); + lines = my_rows; + columns = my_cols; } #endif if (opt_c) {

adacursesw6\-config 1 2023-12-16 ncurses 6.4 User commands

adacursesw6\-config 1 2024-04-20 ncurses 6.4 User commands

curs_add_wch 3x 2024-04-13 ncurses 6.4 Library calls

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

curs_add_wchstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_add_wchstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_addch 3x 2024-04-13 ncurses 6.4 Library calls

curs_addch 3x 2024-04-20 ncurses 6.4 Library calls

curs_addchstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_addchstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_addstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_addstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_addwstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_addwstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_attr 3x 2024-03-16 ncurses 6.4 Library calls

curs_attr 3x 2024-04-20 ncurses 6.4 Library calls

curs_beep 3x 2024-03-16 ncurses 6.4 Library calls

curs_beep 3x 2024-04-20 ncurses 6.4 Library calls

curs_bkgd 3x 2024-03-23 ncurses 6.4 Library calls

curs_bkgd 3x 2024-04-20 ncurses 6.4 Library calls

curs_bkgrnd 3x 2024-03-23 ncurses 6.4 Library calls

curs_bkgrnd 3x 2024-04-20 ncurses 6.4 Library calls

curs_border 3x 2024-03-16 ncurses 6.4 Library calls

curs_border 3x 2024-04-20 ncurses 6.4 Library calls

curs_border_set 3x 2024-03-16 ncurses 6.4 Library calls

curs_border_set 3x 2024-04-20 ncurses 6.4 Library calls

curs_clear 3x 2024-03-16 ncurses 6.4 Library calls

curs_clear 3x 2024-04-20 ncurses 6.4 Library calls

curs_color 3x 2024-03-16 ncurses 6.4 Library calls

curs_color 3x 2024-04-20 ncurses 6.4 Library calls

curs_delch 3x 2024-03-16 ncurses 6.4 Library calls

curs_delch 3x 2024-04-20 ncurses 6.4 Library calls

curs_deleteln 3x 2024-03-16 ncurses 6.4 Library calls

curs_deleteln 3x 2024-04-20 ncurses 6.4 Library calls

curs_get_wch 3x 2024-04-13 ncurses 6.4 Library calls

curs_get_wch 3x 2024-04-20 ncurses 6.4 Library calls

curs_get_wstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_get_wstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_getcchar 3x 2024-04-13 ncurses 6.4 Library calls

curs_getcchar 3x 2024-04-20 ncurses 6.4 Library calls

curs_getch 3x 2024-04-13 ncurses 6.4 Library calls

curs_getch 3x 2024-04-20 ncurses 6.4 Library calls

curs_getstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_getstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_getyx 3x 2024-03-16 ncurses 6.4 Library calls

curs_getyx 3x 2024-04-20 ncurses 6.4 Library calls

curs_in_wch 3x 2024-04-13 ncurses 6.4 Library calls

curs_in_wch 3x 2024-04-20 ncurses 6.4 Library calls

curs_in_wchstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_in_wchstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_inch 3x 2024-04-13 ncurses 6.4 Library calls

curs_inch 3x 2024-04-20 ncurses 6.4 Library calls

curs_inchstr 3x 2024-03-16 ncurses 6.4 Library calls

curs_inchstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_initscr 3x 2024-04-13 ncurses 6.4 Library calls

curs_initscr 3x 2024-04-20 ncurses 6.4 Library calls

curs_ins_wch 3x 2024-03-16 ncurses 6.4 Library calls

curs_ins_wch 3x 2024-04-20 ncurses 6.4 Library calls

curs_ins_wstr 3x 2024-04-13 ncurses 6.4 Library calls

curs_ins_wstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_insch 3x 2024-03-16 ncurses 6.4 Library calls

curs_insch 3x 2024-04-20 ncurses 6.4 Library calls

curs_insstr 3x 2024-03-16 ncurses 6.4 Library calls

curs_insstr 3x 2024-04-20 ncurses 6.4 Library calls

curs_instr 3x 2024-04-13 ncurses 6.4 Library calls

curs_instr 3x 2024-04-20 ncurses 6.4 Library calls