]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_getch.3x.html
projects / ncurses.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ncurses 6.5 - patch 20240525
[ncurses.git] / doc / html / man / curs_getch.3x.html
diff --git a/doc/html/man/curs_getch.3x.html b/doc/html/man/curs_getch.3x.html
index 2c9e31c2251a3de9b4a97d745fb6110b1e1e0747..f723897948a8f554dd338f5167a4fc348476bfad 100644 (file)
--- a/doc/html/man/curs_getch.3x.html
+++ b/doc/html/man/curs_getch.3x.html
@@ -28,19 +28,19 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_getch.3x,v 1.85 2024/04/13 22:18:51 tom Exp @
+  * @Id: curs_getch.3x,v 1.93 2024/05/25 20:57:17 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_getch 3x 2024-04-13 ncurses 6.4 Library calls</TITLE>
+<TITLE>curs_getch 3x 2024-05-25 ncurses 6.5 Library calls</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 
 </HEAD>
 <BODY>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_getch 3x 2024-04-13 ncurses 6.4 Library calls</H1>
+<H1 class="no-header">curs_getch 3x 2024-05-25 ncurses 6.5 Library calls</H1>
 <PRE>
 <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>                   Library calls                  <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
 
 <PRE>
 <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>                   Library calls                  <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
 
@@ -60,98 +60,100 @@
        <STRONG>int</STRONG> <STRONG>mvgetch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
        <STRONG>int</STRONG> <STRONG>mvwgetch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
 
        <STRONG>int</STRONG> <STRONG>mvgetch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
        <STRONG>int</STRONG> <STRONG>mvwgetch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
 
-       <STRONG>int</STRONG> <STRONG>ungetch(int</STRONG> <EM>ch</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>ungetch(int</STRONG> <EM>c</EM><STRONG>);</STRONG>
 
        <EM>/*</EM> <EM>extension</EM> <EM>*/</EM>
 
        <EM>/*</EM> <EM>extension</EM> <EM>*/</EM>
-       <STRONG>int</STRONG> <STRONG>has_key(int</STRONG> <EM>ch</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>has_key(int</STRONG> <EM>c</EM><STRONG>);</STRONG>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
 
 </PRE><H3><a name="h3-Reading-Characters">Reading Characters</a></H3><PRE>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
 
 </PRE><H3><a name="h3-Reading-Characters">Reading Characters</a></H3><PRE>
-       <STRONG>wgetch</STRONG> gathers a key stroke from the terminal keyboard associated  with
-       a  <EM>curses</EM>  window  <EM>win</EM>.   <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>  describes  the  variants of this
+       <STRONG>wgetch</STRONG> gathers a key event from the terminal keyboard associated with a
+       <EM>curses</EM>   window  <EM>win</EM>.   <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>  describes  the  variants  of  this
        function.
 
        When input is pending, <STRONG>wgetch</STRONG> returns an integer  identifying  the  key
        function.
 
        When input is pending, <STRONG>wgetch</STRONG> returns an integer  identifying  the  key
-       stroke;  for  alphanumeric and punctuation keys, this value corresponds
-       to the character encoding used by the terminal.  Use of the control key
-       as  a modifier often results in a distinct code.  The behavior of other
-       keys depends on whether <EM>win</EM> is in keypad mode; see  subsection  "Keypad
-       Mode" below.
-
-       If  no input is pending, then if the no-delay flag is set in the window
-       (see <STRONG><A HREF="nodelay.3x.html">nodelay(3x)</A></STRONG>), the function returns <STRONG>ERR</STRONG>;  otherwise,  <EM>curses</EM>  waits
-       until  the  terminal  has  input.   If <STRONG><A HREF="curs_inopts.3x.html">cbreak(3x)</A></STRONG> has been called, this
-       happens after one character is read.  If <STRONG><A HREF="curs_inopts.3x.html">nocbreak(3x)</A></STRONG> has been  called,
-       it  occurs  when  the  next newline is read.  If <STRONG><A HREF="curs_inopts.3x.html">halfdelay(3x)</A></STRONG> has been
-       called, <EM>curses</EM> waits until a character is typed or the specified  delay
+       event; for alphanumeric and punctuation keys, this value corresponds to
+       the character encoding used by the terminal.  Use of the control key as
+       a  modifier,  by  holding  it down while pressing and releasing another
+       key, often results in a distinct code.   The  behavior  of  other  keys
+       depends  on whether <EM>win</EM> is in keypad mode; see subsection "Keypad Mode"
+       below.
+
+       If no input is pending, then if the no-delay flag is set in the  window
+       (see  <STRONG><A HREF="nodelay.3x.html">nodelay(3x)</A></STRONG>),  the  function returns <STRONG>ERR</STRONG>; otherwise, <EM>curses</EM> waits
+       until the terminal has input.  If  <STRONG><A HREF="curs_inopts.3x.html">cbreak(3x)</A></STRONG>  has  been  called,  this
+       happens  after one character is read.  If <STRONG><A HREF="curs_inopts.3x.html">nocbreak(3x)</A></STRONG> has been called,
+       it occurs when the next newline is read.   If  <STRONG><A HREF="curs_inopts.3x.html">halfdelay(3x)</A></STRONG>  has  been
+       called,  <EM>curses</EM>  waits  until input is available or the specified delay
        elapses.
 
        If <STRONG><A HREF="curs_inopts.3x.html">echo(3x)</A></STRONG> has been called, and the window is not a pad, <EM>curses</EM> writes
        elapses.
 
        If <STRONG><A HREF="curs_inopts.3x.html">echo(3x)</A></STRONG> has been called, and the window is not a pad, <EM>curses</EM> writes
-       the returned character <EM>ch</EM> to the window (at the  cursor  position)  per
-       the following rules.
+       the returned character <EM>c</EM> to the window (at the cursor position) per the
+       following rules.
 
 
-       <STRONG>o</STRONG>   If  <EM>ch</EM>  matches  the  terminal's  erase character, the cursor moves
-           leftward one  position  and  the  new  position  is  erased  as  if
-           <STRONG><A HREF="curs_move.3x.html">wmove(3x)</A></STRONG>  and  then  <STRONG><A HREF="curs_delch.3x.html">wdelch(3x)</A></STRONG>  were  called.   When the window's
-           keypad mode is enabled (see below), <STRONG>KEY_LEFT</STRONG> and <STRONG>KEY_BACKSPACE</STRONG>  are
+       <STRONG>o</STRONG>   If <EM>c</EM> matches the  terminal's  erase  character,  the  cursor  moves
+           leftward  one  position  and  the  new  position  is  erased  as if
+           <STRONG><A HREF="curs_move.3x.html">wmove(3x)</A></STRONG> and then  <STRONG><A HREF="curs_delch.3x.html">wdelch(3x)</A></STRONG>  were  called.   When  the  window's
+           keypad  mode is enabled (see below), <STRONG>KEY_LEFT</STRONG> and <STRONG>KEY_BACKSPACE</STRONG> are
            handled the same way.
 
            handled the same way.
 
-       <STRONG>o</STRONG>   <EM>curses</EM> writes any other <EM>ch</EM> to the window, as with <STRONG><A HREF="curs_addch.3x.html">wechochar(3x)</A></STRONG>.
+       <STRONG>o</STRONG>   <EM>curses</EM> writes any other <EM>c</EM> to the window, as with <STRONG><A HREF="curs_addch.3x.html">wechochar(3x)</A></STRONG>.
 
 
-       <STRONG>o</STRONG>   If  the  window  has  been moved or modified since the last call to
-           <STRONG><A HREF="curs_refresh.3x.html">wrefresh(3x)</A></STRONG>, <EM>curses</EM> calls <STRONG>wrefresh</STRONG>.
+       <STRONG>o</STRONG>   If the window <EM>win</EM> has been moved or modified since the last call to
+           <STRONG><A HREF="curs_refresh.3x.html">wrefresh(3x)</A></STRONG>, <EM>curses</EM> calls <STRONG>wrefresh</STRONG> on it.
 
 
-       If <EM>ch</EM> is a carriage return and <STRONG><A HREF="curs_inopts.3x.html">nl(3x)</A></STRONG> has been called,  <STRONG>wgetch</STRONG>  returns
-       the character code for newline (line feed) instead.
+       If  <EM>c</EM>  is  a carriage return and <STRONG><A HREF="curs_inopts.3x.html">nl(3x)</A></STRONG> has been called, <STRONG>wgetch</STRONG> returns
+       the character code for line feed instead.
 
 
 </PRE><H3><a name="h3-Keypad-Mode">Keypad Mode</a></H3><PRE>
 
 
 </PRE><H3><a name="h3-Keypad-Mode">Keypad Mode</a></H3><PRE>
-       To  <EM>curses</EM>, key strokes not from the alphabetic section of the keyboard
+       To <EM>curses</EM>, key strokes not from the alphabetic section of the  keyboard
        (those    corresponding    to    the    ECMA-6    character    set--see
        (those    corresponding    to    the    ECMA-6    character    set--see
-       <STRONG>ascii(7)</STRONG>--optionally  modified by either the control or shift keys) are
+       <STRONG>ascii(7)</STRONG>--optionally modified by either the control or shift keys)  are
        treated as <EM>function</EM> keys.  (In <EM>curses</EM>, the term "function key" includes
        treated as <EM>function</EM> keys.  (In <EM>curses</EM>, the term "function key" includes
-       but  is  not  limited to keycaps engraved with "F1", "PF1", and so on.)
-       If the  window  is  in  keypad  mode,  these  produce  a  numeric  code
-       corresponding  to the <STRONG>KEY_</STRONG> symbols listed in subsection "Predefined Key
-       Codes" below; otherwise, they transmit a sequence  of  codes  typically
-       starting  with  the  escape character, and which must be collected with
+       but is not limited to keycaps engraved with "F1", "PF1",  and  so  on.)
+       If  the  window  is  in  keypad  mode,  these  produce  a  numeric code
+       corresponding to the <STRONG>KEY_</STRONG> symbols listed in subsection "Predefined  Key
+       Codes"  below;  otherwise,  they transmit a sequence of codes typically
+       starting with the escape character, and which must  be  collected  with
        multiple <STRONG>wgetch</STRONG> calls.
 
        multiple <STRONG>wgetch</STRONG> calls.
 
-       <STRONG>o</STRONG>   The <EM>curses.h</EM> header file declares  many  <EM>predefined</EM>  <EM>function</EM>  <EM>keys</EM>
-           whose  names  begin with <STRONG>KEY_</STRONG>; these object-like macros have values
+       <STRONG>o</STRONG>   The  <EM>curses.h</EM>  header  file  declares many <EM>predefined</EM> <EM>function</EM> <EM>keys</EM>
+           whose names begin with <STRONG>KEY_</STRONG>; these object-like macros  have  values
            outside the range of eight-bit character codes.
 
            outside the range of eight-bit character codes.
 
-       <STRONG>o</STRONG>   In  <EM>ncurses</EM>,  <EM>user-defined</EM>  <EM>function</EM>  <EM>keys</EM>  are   configured   with
-           <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>;  they  have no names, but are also expected to have
+       <STRONG>o</STRONG>   In   <EM>ncurses</EM>,   <EM>user-defined</EM>  <EM>function</EM>  <EM>keys</EM>  are  configured  with
+           <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>; they have no names, but are also expected  to  have
            values outside the range of eight-bit codes.
 
            values outside the range of eight-bit codes.
 
-       A variable intended to hold a function key code must thus  be  of  type
+       A  variable  intended  to hold a function key code must thus be of type
        <EM>short</EM> or larger.
 
        <EM>short</EM> or larger.
 
-       Most  terminals  one  encounters follow the ECMA-48 standard insofar as
-       their function keys  produce  character  sequences  prefixed  with  the
-       escape  character  ESC.   This  fact  implies  that  <EM>curses</EM> cannot know
-       whether the terminal has sent an ESC key stroke or the beginning  of  a
-       function  key's  character  sequence without waiting to see if, and how
-       soon, further input arrives.   When  <EM>curses</EM>  reads  such  an  ambiguous
-       character,  it sets a timer.  If the remainder of the sequence does not
-       arrive within the designated time, <STRONG>wgetch</STRONG> returns the prefix character;
-       otherwise, it returns the function key code corresponding to the unique
-       sequence defined by the terminal.  Consequently, a  user  of  a  <EM>curses</EM>
-       application  may  experience  a  delay  after pressing ESC while <EM>curses</EM>
-       disambiguates the input; see section "EXTENSIONS" below.  If the window
-       is  in "no time-out" mode, the timer does not expire; it is an infinite
-       (or very  large)  value.   See  <STRONG><A HREF="notimeout.3x.html">notimeout(3x)</A></STRONG>.   Because  function  key
-       sequences  usually  begin  with  an  escape character, the terminal may
-       appear to hang in no time-out mode after  the  user  has  pressed  ESC.
-       Generally, further typing "awakens" <EM>curses</EM>.
+       Most terminals one encounters follow the ECMA-48  standard  insofar  as
+       their  function  keys  produce  character  sequences  prefixed with the
+       escape character ESC.  This fact implies that <EM>curses</EM> cannot distinguish
+       a  user's  press  of  the  escape  key (assuming it sends ESC) from the
+       beginning of a function key's character sequence without waiting to see
+       if,  and  how  soon,  further input arrives.  When <EM>curses</EM> reads such an
+       ambiguous character, it sets a timer.  If the remainder of the sequence
+       does  not  arrive within the designated time, <STRONG>wgetch</STRONG> returns the prefix
+       character; otherwise, it returns the function key code corresponding to
+       the unique sequence defined by the terminal.  Consequently, a user of a
+       <EM>curses</EM> application may experience a delay  after  they  escape  key  is
+       pressed  while <EM>curses</EM> disambiguates the input; see section "EXTENSIONS"
+       below.  If the window is in "no time-out"  mode,  the  timer  does  not
+       expire;  it  is  an infinite (or very large) value.  See <STRONG><A HREF="notimeout.3x.html">notimeout(3x)</A></STRONG>.
+       Because function key sequences usually begin with ESC, the terminal may
+       appear  to  hang  in no time-out mode after the user presses the escape
+       key.  Generally, further typing "awakens" <EM>curses</EM>.
 
 
 </PRE><H3><a name="h3-Ungetting-Characters">Ungetting Characters</a></H3><PRE>
 
 
 </PRE><H3><a name="h3-Ungetting-Characters">Ungetting Characters</a></H3><PRE>
-       <STRONG>ungetch</STRONG>  places <EM>ch</EM> into the input queue to be returned by the next call
-       to <STRONG>wgetch</STRONG>.  A single input queue serves all windows.
+       <STRONG>ungetch</STRONG> places <EM>c</EM> into the input queue to be returned by the  next  call
+       to <STRONG>wgetch</STRONG>.  A single input queue serves all windows associated with the
+       terminal.
 
 
 </PRE><H3><a name="h3-Predefined-Key-Codes">Predefined Key Codes</a></H3><PRE>
 
 
 </PRE><H3><a name="h3-Predefined-Key-Codes">Predefined Key Codes</a></H3><PRE>
@@ -164,7 +166,7 @@
            terminal.
 
        <STRONG>o</STRONG>   The  naming  convention  may  seem  obscure,  with  some   apparent
            terminal.
 
        <STRONG>o</STRONG>   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  <EM>terminfo</EM>  capability  names  for  the   keys,   and   were
            standardized  before  the  IBM  PC/AT  keyboard  layout  achieved a
            dominant position in industry.
            to  the  <EM>terminfo</EM>  capability  names  for  the   keys,   and   were
            standardized  before  the  IBM  PC/AT  keyboard  layout  achieved a
            dominant position in industry.
@@ -178,9 +180,9 @@
               <STRONG>KEY_RIGHT</STRONG>
               <STRONG>KEY_HOME</STRONG>        Home key (upward+left arrow)
               <STRONG>KEY_BACKSPACE</STRONG>   Backspace
               <STRONG>KEY_RIGHT</STRONG>
               <STRONG>KEY_HOME</STRONG>        Home key (upward+left arrow)
               <STRONG>KEY_BACKSPACE</STRONG>   Backspace
+
               <STRONG>KEY_F0</STRONG>          Function keys; space for 64 keys is reserved
               <STRONG>KEY_F(</STRONG><EM>n</EM><STRONG>)</STRONG>        Function key <EM>n</EM> where 0 &lt;= <EM>n</EM> &lt;= 63
               <STRONG>KEY_F0</STRONG>          Function keys; space for 64 keys is reserved
               <STRONG>KEY_F(</STRONG><EM>n</EM><STRONG>)</STRONG>        Function key <EM>n</EM> where 0 &lt;= <EM>n</EM> &lt;= 63
-
               <STRONG>KEY_DL</STRONG>          Delete line
               <STRONG>KEY_IL</STRONG>          Insert line
               <STRONG>KEY_DC</STRONG>          Delete character
               <STRONG>KEY_DL</STRONG>          Delete line
               <STRONG>KEY_IL</STRONG>          Insert line
               <STRONG>KEY_DC</STRONG>          Delete character
@@ -244,9 +246,9 @@
               <STRONG>KEY_SCREATE</STRONG>     Shifted create key
               <STRONG>KEY_SDC</STRONG>         Shifted delete character key
               <STRONG>KEY_SDL</STRONG>         Shifted delete line key
               <STRONG>KEY_SCREATE</STRONG>     Shifted create key
               <STRONG>KEY_SDC</STRONG>         Shifted delete character key
               <STRONG>KEY_SDL</STRONG>         Shifted delete line key
+
               <STRONG>KEY_SEND</STRONG>        Shifted end key
               <STRONG>KEY_SEOL</STRONG>        Shifted clear line key
               <STRONG>KEY_SEND</STRONG>        Shifted end key
               <STRONG>KEY_SEOL</STRONG>        Shifted clear line key
-
               <STRONG>KEY_SEXIT</STRONG>       Shifted exit key
               <STRONG>KEY_SFIND</STRONG>       Shifted find key
               <STRONG>KEY_SHELP</STRONG>       Shifted help key
               <STRONG>KEY_SEXIT</STRONG>       Shifted exit key
               <STRONG>KEY_SFIND</STRONG>       Shifted find key
               <STRONG>KEY_SHELP</STRONG>       Shifted help key
@@ -267,7 +269,7 @@
               <STRONG>KEY_SSUSPEND</STRONG>    Shifted suspend key
               <STRONG>KEY_SUNDO</STRONG>       Shifted undo key
 
               <STRONG>KEY_SSUSPEND</STRONG>    Shifted suspend key
               <STRONG>KEY_SUNDO</STRONG>       Shifted undo key
 
-       The keypad is arranged as follows.
+       Many keyboards feature a nine-key directional pad.
 
                                    +-----+------+-------+
                                    | A1  |  up  |  A3   |
 
                                    +-----+------+-------+
                                    | A1  |  up  |  A3   |
@@ -276,41 +278,43 @@
                                    +-----+------+-------+
                                    | C1  | down |  C3   |
                                    +-----+------+-------+
                                    +-----+------+-------+
                                    | C1  | down |  C3   |
                                    +-----+------+-------+
-       Two of these symbols do <EM>not</EM> correspond to a real key.
+       Two of the symbols in the list above do <EM>not</EM> correspond  to  a  physical
+       key.
 
 
-       <STRONG>o</STRONG>   <STRONG>wgetch</STRONG> returns <STRONG>KEY_RESIZE</STRONG> (even if  the  window's  keypad  mode  is
-           disabled) when <EM>ncurses</EM> detects the <STRONG>SIGWINCH</STRONG> signal; see <STRONG><A HREF="curs_initscr.3x.html">initscr(3x)</A></STRONG>
+       <STRONG>o</STRONG>   <STRONG>wgetch</STRONG>  returns  <STRONG>KEY_RESIZE</STRONG>,  even  if  the window's keypad mode is
+           disabled, when <EM>ncurses</EM> handles a <STRONG>SIGWINCH</STRONG> signal;  see  <STRONG><A HREF="curs_initscr.3x.html">initscr(3x)</A></STRONG>
            and <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>.
 
            and <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>.
 
-       <STRONG>o</STRONG>   <STRONG>wgetch</STRONG> returns <STRONG>KEY_MOUSE</STRONG> to indicate that a mouse event is  pending
-           collection;  see  <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>.   Receipt of this code requires a
-           window's keypad mode to be  enabled,  because  to  interpret  mouse
-           input (as with with <STRONG>xterm(1)</STRONG>'s mouse prototocol), <EM>ncurses</EM> must read
+       <STRONG>o</STRONG>   <STRONG>wgetch</STRONG>  returns <STRONG>KEY_MOUSE</STRONG> to indicate that a mouse event is pending
+           collection; see <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>.  Receipt of this  code  requires  a
+           window's  keypad  mode  to  be  enabled, because to interpret mouse
+           input (as with with <STRONG>xterm(1)</STRONG>'s mouse protocol), <EM>ncurses</EM>  must  read
            an escape sequence, as with a function key.
 
 
 </PRE><H3><a name="h3-Testing-Key-Codes">Testing Key Codes</a></H3><PRE>
            an escape sequence, as with a function key.
 
 
 </PRE><H3><a name="h3-Testing-Key-Codes">Testing Key Codes</a></H3><PRE>
-       In <EM>ncurses</EM>, <STRONG>has_key</STRONG> takes a key code value from  the  above  list,  and
-       returns  a  Boolean  value indicating the terminal's recognition of it.
-       See also <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG> and <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>.
+       In  <EM>ncurses</EM>,  <STRONG>has_key</STRONG>  returns  a  Boolean value indicating whether the
+       terminal type recognizes its parameter as a key code value.   See  also
+       <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG> and <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>.
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       <STRONG>wgetch</STRONG> returns <STRONG>ERR</STRONG> if
+       Except  for  <STRONG>has_key</STRONG>,  these  functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on
+       failure.
 
 
-       <STRONG>o</STRONG>   the <EM>WINDOW</EM> pointer is <STRONG>NULL</STRONG>, or
+       Functions taking a <EM>WINDOW</EM> pointer argument fail if the pointer is <STRONG>NULL</STRONG>.
+
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
+
+       <STRONG>wgetch</STRONG> also fails if
 
        <STRONG>o</STRONG>   its timeout expires without any data arriving, or
 
 
        <STRONG>o</STRONG>   its timeout expires without any data arriving, or
 
-       <STRONG>o</STRONG>   execution was interrupted by a signal, in which case <STRONG>errno</STRONG>  is  set
+       <STRONG>o</STRONG>   execution  was  interrupted by a signal, in which case <STRONG>errno</STRONG> is set
            to <STRONG>EINTR</STRONG>.
 
            to <STRONG>EINTR</STRONG>.
 
-       Functions  with  a  "mv"  prefix  first  perform  cursor movement using
-       <STRONG><A HREF="curs_move.3x.html">wmove(3x)</A></STRONG> and fail if the position is outside the window, or (for "mvw"
-       functions) if the <EM>win</EM> parameter is a null pointer.
-
-       <STRONG>ungetch</STRONG>  returns  <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> if there is no more room in the
-       input queue.
+       <STRONG>ungetch</STRONG> fails if there is no more room in the input queue.
 
        <STRONG>has_key</STRONG> returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
 
 
        <STRONG>has_key</STRONG> returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
 
@@ -322,19 +326,19 @@
 
        Some key strokes are indistinguishable  from  control  characters;  for
        example,  <STRONG>KEY_ENTER</STRONG> may be the same as <STRONG>^M</STRONG>, and <STRONG>KEY_BACKSPACE</STRONG> may be the
 
        Some key strokes are indistinguishable  from  control  characters;  for
        example,  <STRONG>KEY_ENTER</STRONG> may be the same as <STRONG>^M</STRONG>, and <STRONG>KEY_BACKSPACE</STRONG> may be the
-       same as <STRONG>^H</STRONG> or <STRONG>^?</STRONG>.  Consult the terminal's <EM>terminfo</EM> entry  to  determine
-       whether this is the case; see <STRONG><A HREF="infocmp.1m.html">infocmp(1)</A></STRONG>.  Some <EM>curses</EM> implementations,
-       including <EM>ncurses</EM>, honor the <EM>terminfo</EM>  key  definitions;  others  treat
-       such control characters specially.
+       same as <STRONG>^H</STRONG> or <STRONG>^?</STRONG>.  Consult the <EM>terminfo</EM> entry for the terminal type  to
+       determine  whether  this  is  the  case;  see  <STRONG><A HREF="infocmp.1m.html">infocmp(1)</A></STRONG>.  Some <EM>curses</EM>
+       implementations, including <EM>ncurses</EM>, honor the <EM>terminfo</EM> key definitions;
+       others treat such control characters specially.
 
        <EM>curses</EM>  distinguishes  the  Enter  keys  in  the alphabetic and numeric
        keypad sections of a keyboard because (most) terminals  do.   <STRONG>KEY_ENTER</STRONG>
 
        <EM>curses</EM>  distinguishes  the  Enter  keys  in  the alphabetic and numeric
        keypad sections of a keyboard because (most) terminals  do.   <STRONG>KEY_ENTER</STRONG>
-       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,
+       is reliably recognized only if the window's keypad mode is enabled.
 
 
-       <STRONG>o</STRONG>   The  <EM>terminfo</EM>  <STRONG>key_enter</STRONG>  (<STRONG>kent</STRONG>) capability describes the character
-           (sequence) sent by the terminal's keypad Enter key.
+       <STRONG>o</STRONG>   The <EM>terminfo</EM> <STRONG>key_enter</STRONG> (<STRONG>kent</STRONG>) capability  describes  the  character
+           (sequence)  sent  by  the  Enter  key  of  a terminal's numeric (or
+           similar) keypad.
 
        <STRONG>o</STRONG>   "Enter or send" is X/Open Curses's description of this key.
 
 
        <STRONG>o</STRONG>   "Enter or send" is X/Open Curses's description of this key.
 
@@ -353,9 +357,9 @@
        well-defined.
 
        Historically, the list of key code macros above was influenced  by  the
        well-defined.
 
        Historically, the list of key code macros above was influenced  by  the
-       function-key-rich  keyboard  of  the AT&amp;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
+       keyboard  of  the AT&amp;T 7300 (also known variously as the "3B1", "Safari
+       4", and "UNIX PC"), a 1985 machine  rich  in  function  keys.   Today's
+       computer  keyboards  are  based  that of the IBM PC/AT and tend to have
        fewer.  A <EM>curses</EM> application can expect such a keyboard to transmit key
        codes   <STRONG>KEY_UP</STRONG>,   <STRONG>KEY_DOWN</STRONG>,  <STRONG>KEY_LEFT</STRONG>,  <STRONG>KEY_RIGHT</STRONG>,  <STRONG>KEY_HOME</STRONG>,  <STRONG>KEY_END</STRONG>,
        <STRONG>KEY_PPAGE</STRONG> (Page Up), <STRONG>KEY_NPAGE</STRONG> (Page  Down),  <STRONG>KEY_IC</STRONG>  (Insert),  <STRONG>KEY_DC</STRONG>
        fewer.  A <EM>curses</EM> application can expect such a keyboard to transmit key
        codes   <STRONG>KEY_UP</STRONG>,   <STRONG>KEY_DOWN</STRONG>,  <STRONG>KEY_LEFT</STRONG>,  <STRONG>KEY_RIGHT</STRONG>,  <STRONG>KEY_HOME</STRONG>,  <STRONG>KEY_END</STRONG>,
        <STRONG>KEY_PPAGE</STRONG> (Page Up), <STRONG>KEY_NPAGE</STRONG> (Page  Down),  <STRONG>KEY_IC</STRONG>  (Insert),  <STRONG>KEY_DC</STRONG>
@@ -370,16 +374,16 @@
        function  key character sequence from a series of key strokes beginning
        with ESC typed by the user; see <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
 
        function  key character sequence from a series of key strokes beginning
        with ESC typed by the user; see <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
 
-       <STRONG>has_key</STRONG> was designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and is not found in SVr4  <EM>curses</EM>,
-       4.4BSD <EM>curses</EM>, or any other previous curses implementation.
+       <STRONG>has_key</STRONG> was designed for <EM>ncurses</EM>, and is  not  found  in  SVr4  <EM>curses</EM>,
+       4.4BSD <EM>curses</EM>, or any other previous <EM>curses</EM> implementation.
 
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
        Applications employing <EM>ncurses</EM> extensions should condition their use on
        the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro.
 
 
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
        Applications employing <EM>ncurses</EM> extensions should condition their use on
        the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro.
 
-       X/Open Curses, Issue 4, describes <STRONG>getch</STRONG>, <STRONG>wgetch</STRONG>, <STRONG>mvgetch</STRONG>, <STRONG>mvwgetch</STRONG>, and
-       <STRONG>ungetch</STRONG>.  It specifies no error conditions for them.
+       Except as noted in section "EXTENSIONS" above, X/Open Curses,  Issue  4
+       describes these functions.  It specifies no error conditions for them.
 
        <STRONG>wgetch</STRONG> reads only single-byte characters.
 
 
        <STRONG>wgetch</STRONG> reads only single-byte characters.
 
@@ -390,9 +394,9 @@
        The   behavior  of  <STRONG>wgetch</STRONG>  in  the  presence  of  signal  handlers  is
        unspecified in the SVr4 documentation and X/Open Curses.  In historical
        <EM>curses</EM>  implementations,  it  varied depending on whether the operating
        The   behavior  of  <STRONG>wgetch</STRONG>  in  the  presence  of  signal  handlers  is
        unspecified in the SVr4 documentation and X/Open Curses.  In historical
        <EM>curses</EM>  implementations,  it  varied depending on whether the operating
-       system's dispatch of a signal to a handler interrupts a <STRONG>read(2)</STRONG> call in
-       progress  or  not,  and also (in some implementations) whether an input
-       timeout or non-blocking mode has been set.  Programmers concerned about
+       system's dispatch of a signal to a handler interrupted a  <STRONG>read(2)</STRONG>  call
+       in  progress,  and  also  (in  some  implementations)  whether an input
+       timeout or non-blocking mode had been set.  Programmers concerned about
        portability  should  be  prepared  for  either of two cases: (a) signal
        receipt does not interrupt <STRONG>wgetch</STRONG>; or  (b)  signal  receipt  interrupts
        <STRONG>wgetch</STRONG> and causes it to return <STRONG>ERR</STRONG> with <STRONG>errno</STRONG> set to <STRONG>EINTR</STRONG>.
        portability  should  be  prepared  for  either of two cases: (a) signal
        receipt does not interrupt <STRONG>wgetch</STRONG>; or  (b)  signal  receipt  interrupts
        <STRONG>wgetch</STRONG> and causes it to return <STRONG>ERR</STRONG> with <STRONG>errno</STRONG> set to <STRONG>EINTR</STRONG>.
@@ -407,6 +411,12 @@
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+       ECMA-6  "7-bit  coded  Character  Set" &lt;https://ecma-international.org/
+       publications-and-standards/standards/ecma-6/&gt;
+
+       ECMA-48  "Control  Functions  for  Coded  Character   Sets"   &lt;https://
+       ecma-international.org/publications-and-standards/standards/ecma-48/&gt;
+
        <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>  describes comparable functions of the <EM>ncurses</EM> library
        in its wide-character configuration (<EM>ncursesw</EM>).
 
        <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>  describes comparable functions of the <EM>ncurses</EM> library
        in its wide-character configuration (<EM>ncursesw</EM>).
 
@@ -414,15 +424,9 @@
        <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>,  <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>,
        <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>, <STRONG>ascii(7)</STRONG>
 
        <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>,  <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>,
        <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>, <STRONG>ascii(7)</STRONG>
 
-       ECMA-6 "7-bit  coded  Character  Set"  &lt;https://ecma-international.org/
-       publications-and-standards/standards/ecma-6/&gt;
-
-       ECMA-48   "Control   Functions  for  Coded  Character  Sets"  &lt;https://
-       ecma-international.org/publications-and-standards/standards/ecma-48/&gt;
-
 
 
 
 
-ncurses 6.4                       2024-04-13                    <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
+ncurses 6.5                       2024-05-25                    <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>
 </PRE>
 <div class="nav">
 <ul>
ncurses, with patches starting at ncurses-5.6; new users should use https://github.com/ThomasDickey/ncurses-snapshots/