]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_getch.3x.html
ncurses 6.5 - patch 20240601
[ncurses.git] / doc / html / man / curs_getch.3x.html
index f723897948a8f554dd338f5167a4fc348476bfad..3bc1777c2654d22207f93cb4ea24c3b7cae607c6 100644 (file)
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_getch.3x,v 1.93 2024/05/25 20:57:17 tom Exp @
+  * @Id: curs_getch.3x,v 1.95 2024/06/01 22:29:08 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">
-<TITLE>curs_getch 3x 2024-05-25 ncurses 6.5 Library calls</TITLE>
+<TITLE>curs_getch 3x 2024-06-01 ncurses 6.5 Library calls</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_getch 3x 2024-05-25 ncurses 6.5 Library calls</H1>
+<H1 class="no-header">curs_getch 3x 2024-06-01 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>
 
        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
+       <EM>curses</EM> application may experience a  delay  after  the  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>.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+       <STRONG>getch</STRONG>, <STRONG>mvgetch</STRONG>, and <STRONG>mvwgetch</STRONG> may be implemented as macros.
+
        <EM>curses</EM> discourages assignment of the ESC key to a discrete function  by
        the programmer because the library requires a delay while it awaits the
        potential remainder of a terminal escape sequence.
        Historically, the list of key code macros above was influenced  by  the
        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
+       computer  keyboards are based on 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>
        (Delete), and <STRONG>KEY_F(</STRONG><EM>n</EM><STRONG>)</STRONG> for 1 &lt;= <EM>n</EM> &lt;= 12.
 
-       <STRONG>getch</STRONG>, <STRONG>mvgetch</STRONG>, and <STRONG>mvwgetch</STRONG> may be implemented as macros.
-
 
 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
        In <EM>ncurses</EM>, when a window's "no time-out" mode is <EM>not</EM> set, the <STRONG>ESCDELAY</STRONG>
        <EM>curses</EM>  implementations,  it  varied depending on whether the operating
        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>.
+       timeout  or  non-blocking  mode  had  been  set.   A  portable   <EM>curses</EM>
+       application  prepares  for  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>.
 
        <STRONG>KEY_MOUSE</STRONG> is mentioned in X/Open Curses, along with a few related <EM>term-</EM>
        <EM>info</EM> capabilities, but no higher-level functions use the feature.   The
 
 
 
-ncurses 6.5                       2024-05-25                    <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
+ncurses 6.5                       2024-06-01                    <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>