X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getch.3x.html;h=d19c4b87454eea094ac47dad7dec1e085756245e;hp=1a3b37648e83410da5e98e129759239fab7b9485;hb=3eda6f30a84d53844d2ebceadb457e2e7e9cfbf3;hpb=6208c89f98f1cf9fe0980bd8e791846ce007a13d diff --git a/doc/html/man/curs_getch.3x.html b/doc/html/man/curs_getch.3x.html index 1a3b3764..d19c4b87 100644 --- a/doc/html/man/curs_getch.3x.html +++ b/doc/html/man/curs_getch.3x.html @@ -1,7 +1,7 @@ @@ -102,11 +102,19 @@

Keypad mode

        If  keypad is TRUE, and a function key is pressed, the to-
        ken for that function key is returned instead of  the  raw
-       characters.   Possible function keys are defined in <curs-
-       es.h> as macros with values outside  the  range  of  8-bit
-       characters  whose names begin with KEY_.  Thus, a variable
-       intended to hold the return value of a function  key  must
-       be of short size or larger.
+       characters:
+
+       o   The  predefined function keys are listed in <curses.h>
+           as macros with values outside the range of 8-bit char-
+           acters.  Their names begin with KEY_.
+
+       o   Other  (user-defined)  function  keys which may be de-
+           fined using define_key(3x) have no names, but also are
+           expected  to  have  values  outside the range of 8-bit
+           characters.
+
+       Thus, a variable intended to hold the return  value  of  a
+       function key must be of short size or larger.
 
        When a character that could be the beginning of a function
        key is received (which, on modern terminals, means an  es-
@@ -117,6 +125,14 @@
        experience a delay between the time a user presses the es-
        cape key and the escape is returned to the program.
 
+       In ncurses, the timer normally expires after the value  in
+       ESCDELAY  (see curs_variables(3x)).  If notimeout is TRUE,
+       the timer does not expire; it  is  an  infinite  (or  very
+       large) value.  Because function keys usually begin with an
+       escape character, the terminal may appear to hang  in  no-
+       timeout  mode  after pressing the escape key until another
+       key is pressed.
+

Ungetting characters

        The ungetch routine places ch back onto the input queue to
@@ -163,6 +179,7 @@
             KEY_SR          Scroll 1 line backward (reverse)
             KEY_NPAGE       Next page
             KEY_PPAGE       Previous page
+
             KEY_STAB        Set tab
             KEY_CTAB        Clear tab
             KEY_CATAB       Clear all tabs
@@ -179,7 +196,6 @@
             KEY_BTAB        Back tab key
             KEY_BEG         Beg(inning) key
             KEY_CANCEL      Cancel key
-
             KEY_CLOSE       Close key
             KEY_COMMAND     Cmd (command) key
             KEY_COPY        Copy key
@@ -229,6 +245,7 @@
             KEY_SREDO       Shifted redo key
             KEY_SREPLACE    Shifted replace key
             KEY_SRIGHT      Shifted right arrow
+
             KEY_SRSUME      Shifted resume key
             KEY_SSAVE       Shifted save key
             KEY_SSUSPEND    Shifted suspend key
@@ -249,13 +266,13 @@
        real key:
 
        o   KEY_RESIZE is returned when the  SIGWINCH  signal  has
-           been  detected  (see  curs_initscr(3x) and resizeterm(3x)).
+           been  detected  (see  initscr(3x) and resizeterm(3x)).
            This code is returned whether or not keypad  has  been
            enabled.
 
        o   KEY_MOUSE    is   returned   for   mouse-events   (see
            curs_mouse(3x)).  This code relies upon whether or not
-           keypad(3x) has been enabled, because (e.g., with xterm
+           keypad(3x) has been enabled, because (e.g., with xterm
            mouse prototocol) ncurses must read escape  sequences,
            just like a function key.
 
@@ -278,7 +295,7 @@

RETURN VALUE

        All  routines  return  the integer ERR upon failure and an
-       integer value other than ERR (OK in the case of ungetch())
+       integer value other than ERR (OK in the case  of  ungetch)
        upon successful completion.
 
           ungetch
@@ -286,7 +303,9 @@
 
           wgetch
                returns  ERR  if the window pointer is null, or if
-               its timeout expires without having any data.
+               its timeout expires without having any data, or if
+               the  execution  was interrupted by a signal (errno
+               will be set to EINTR).
 
        Functions with a "mv" prefix first perform a cursor  move-
        ment  using  wmove, and return an error if the position is
@@ -373,9 +392,7 @@
        Programmers concerned about portability should be prepared
        for  either  of two cases: (a) signal receipt does not in-
        terrupt getch; (b) signal  receipt  interrupts  getch  and
-       causes  it  to  return ERR with errno set to EINTR.  Under
-       the ncurses implementation, handled signals  never  inter-
-       rupt getch.
+       causes it to return ERR with errno set to EINTR.
 
        The  has_key  function is unique to ncurses.  We recommend
        that any code using it be conditionalized  on  the  NCURS-
@@ -384,8 +401,8 @@

SEE ALSO

        curses(3x),       curs_inopts(3x),       curs_outopts(3x),
-       curs_mouse(3x),   curs_move(3x),   curs_refresh(3x),   re-
-       sizeterm(3x).
+       curs_mouse(3x),      curs_move(3x),      curs_refresh(3x),
+       curs_variables(3x), resizeterm(3x).
 
        Comparable  functions in the wide-character (ncursesw) li-
        brary are described in curs_get_wch(3x).