X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getch.3x.html;h=1df5dd04f0b12e5ca3879ce56fc97a376b80706f;hb=b9a2bd87a73d976d1c916815e2d370bf1090d1b2;hp=9b3bdc42ace740ac19afab4f0338722043e7e989;hpb=6a530b46563470c2ca73579d1994a0c8e275dd98;p=ncurses.git
diff --git a/doc/html/man/curs_getch.3x.html b/doc/html/man/curs_getch.3x.html
index 9b3bdc42..1df5dd04 100644
--- a/doc/html/man/curs_getch.3x.html
+++ b/doc/html/man/curs_getch.3x.html
@@ -27,7 +27,7 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_getch.3x,v 1.42 2015/07/21 08:44:04 tom Exp @
+ * @Id: curs_getch.3x,v 1.43 2015/09/19 22:25:05 tom Exp @
-->
@@ -247,32 +247,37 @@
real key:
o KEY_RESIZE is returned when the SIGWINCH signal has
- been detected (see curs_initscr(3x) and resizeterm(3x)).
+ been detected (see curs_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)).
+ curs_mouse(3x)). This code relies upon whether or not
+ keypad(3x) has been enabled, because (e.g., with xterm
+ mouse prototocol) ncurses must read escape sequences,
+ just like a function key.
- The has_key routine takes a key-code value from the above
- list, and returns TRUE or FALSE according to whether the
+ The has_key routine takes a key-code value from the above
+ list, and returns TRUE or FALSE according to whether the
current terminal type recognizes a key with that value.
The library also supports these extensions:
define_key
- defines a key-code for a given string (see de-
+ defines a key-code for a given string (see de-
fine_key(3x)).
key_defined
- checks if there is a key-code defined for a given
+ checks if there is a key-code defined for a given
string (see key_defined(3x)).
- All routines return the integer ERR upon failure and an
+ All routines return the integer ERR upon failure and an
integer value other than ERR (OK in the case of ungetch())
upon successful completion.
@@ -280,94 +285,102 @@
returns ERR if there is no more room in the FIFO.
wgetch
- returns ERR if the window pointer is null, or if
+ returns ERR if the window pointer is null, or if
its timeout expires without having any data.
- Functions with a "mv" prefix first perform a cursor move-
- ment using wmove, and return an error if the position is
+ Functions with a "mv" prefix first perform a cursor move-
+ ment using wmove, and return an error if the position is
outside the window, or if the window pointer is null.
Use of the escape key by a programmer for a single charac-
- ter function is discouraged, as it will cause a delay of
+ ter function is discouraged, as it will cause a delay of
up to one second while the keypad code looks for a follow-
ing function-key sequence.
- Some keys may be the same as commonly used control keys,
- e.g., KEY_ENTER versus control/M, KEY_BACKSPACE versus
+ Some keys may be the same as commonly used control keys,
+ e.g., KEY_ENTER versus control/M, KEY_BACKSPACE versus
control/H. Some curses implementations may differ accord-
- ing to whether they treat these control keys specially
- (and ignore the terminfo), or use the terminfo defini-
- tions. Ncurses uses the terminfo definition. If it says
- that KEY_ENTER is control/M, getch will return KEY_ENTER
+ ing to whether they treat these control keys specially
+ (and ignore the terminfo), or use the terminfo defini-
+ tions. Ncurses uses the terminfo definition. If it says
+ that KEY_ENTER is control/M, getch will return KEY_ENTER
when you press control/M.
- Generally, KEY_ENTER denotes the character(s) sent by the
+ Generally, KEY_ENTER denotes the character(s) sent by the
Enter key on the numeric keypad:
o the terminal description lists the most useful keys,
- o the Enter key on the regular keyboard is already han-
+ o the Enter key on the regular keyboard is already han-
dled by the standard ASCII characters for carriage-re-
turn and line-feed,
- o depending on whether nl or nonl was called, pressing
- "Enter" on the regular keyboard may return either a
+ o depending on whether nl or nonl was called, pressing
+ "Enter" on the regular keyboard may return either a
carriage-return or line-feed, and finally
- o "Enter or send" is the standard description for this
+ o "Enter or send" is the standard description for this
key.
- When using getch, wgetch, mvgetch, or mvwgetch, nocbreak
+ When using getch, wgetch, mvgetch, or mvwgetch, nocbreak
mode (nocbreak) and echo mode (echo) should not be used at
- the same time. Depending on the state of the tty driver
- when each character is typed, the program may produce un-
+ the same time. Depending on the state of the tty driver
+ when each character is typed, the program may produce un-
desirable results.
Note that getch, mvgetch, and mvwgetch may be macros.
Historically, the set of keypad macros was largely defined
- by the extremely function-key-rich keyboard of the AT&T
- 7300, aka 3B1, aka Safari 4. Modern personal computers
- usually have only a small subset of these. IBM PC-style
- consoles typically support little more than KEY_UP,
- KEY_DOWN, KEY_LEFT, KEY_RIGHT, KEY_HOME, KEY_END,
+ by the extremely function-key-rich keyboard of the AT&T
+ 7300, aka 3B1, aka Safari 4. Modern personal computers
+ usually have only a small subset of these. IBM PC-style
+ consoles typically support little more than KEY_UP,
+ KEY_DOWN, KEY_LEFT, KEY_RIGHT, KEY_HOME, KEY_END,
KEY_NPAGE, KEY_PPAGE, and function keys 1 through 12. The
Ins key is usually mapped to KEY_IC.
- The *get* functions are described in the XSI Curses stan-
- dard, Issue 4. They read single-byte characters only.
- The standard specifies that they return ERR on failure,
+ The *get* functions are described in the XSI Curses stan-
+ dard, Issue 4. They read single-byte characters only.
+ The standard specifies that they return ERR on failure,
but specifies no error conditions.
- The echo behavior of these functions on input of KEY_ or
- backspace characters was not specified in the SVr4 docu-
+ The echo behavior of these functions on input of KEY_ or
+ backspace characters was not specified in the SVr4 docu-
mentation. This description is adopted from the XSI Curs-
es standard.
- The behavior of getch and friends in the presence of han-
- dled signals is unspecified in the SVr4 and XSI Curses
- documentation. Under historical curses implementations,
- it varied depending on whether the operating system's im-
- plementation of handled signal receipt interrupts a
- read(2) call in progress or not, and also (in some imple-
- mentations) depending on whether an input timeout or non-
+ The behavior of getch and friends in the presence of han-
+ dled signals is unspecified in the SVr4 and XSI Curses
+ documentation. Under historical curses implementations,
+ it varied depending on whether the operating system's im-
+ plementation of handled signal receipt interrupts a
+ read(2) call in progress or not, and also (in some imple-
+ mentations) depending on whether an input timeout or non-
blocking mode has been set.
+ KEY_MOUSE is mentioned in XSI Curses, along with a few re-
+ lated terminfo capabilities, but no higher-level functions
+ use the feature. The implementation in ncurses is an ex-
+ tension.
+
+ KEY_RESIZE is an extension first implemented for ncurses.
+ NetBSD curses later added this extension.
+
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-
+ 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.
- The has_key function is unique to ncurses. We recommend
- that any code using it be conditionalized on the NCURS-
+ The has_key function is unique to ncurses. We recommend
+ that any code using it be conditionalized on the NCURS-
ES_VERSION feature macro.
@@ -377,7 +390,7 @@
curs_mouse(3x), curs_move(3x), curs_refresh(3x), re-
sizeterm(3x).
- Comparable functions in the wide-character (ncursesw) li-
+ Comparable functions in the wide-character (ncursesw) li-
brary are described in curs_get_wch(3x).