X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getch.3x.html;h=297f2b1613f9a1eed83605c2fabd24b1d5816368;hp=9b7b9d9cc2a64c51ac020951357858066683a324;hb=e6f4ffe150c7d919792f29a70b4f031cfab5ef06;hpb=a8987e73ec254703634802b4f7ee30d3a485524d
diff --git a/doc/html/man/curs_getch.3x.html b/doc/html/man/curs_getch.3x.html
index 9b7b9d9c..297f2b16 100644
--- a/doc/html/man/curs_getch.3x.html
+++ b/doc/html/man/curs_getch.3x.html
@@ -1,8 +1,8 @@
-
+
@@ -41,14 +41,14 @@
-curs_getch(3x) curs_getch(3x)
+curs_getch(3x) curs_getch(3x)
NAME
- getch, wgetch, mvgetch, mvwgetch, ungetch, has_key - get
+ getch, wgetch, mvgetch, mvwgetch, ungetch, has_key - get
(or push back) characters from curses terminal keyboard
@@ -70,57 +70,55 @@
character from the window. In no-delay mode, if no input
is waiting, the value ERR is returned. In delay mode, the
program waits until the system passes text through to the
- program. Depending on the setting of cbreak, this is
- after one character (cbreak mode), or after the first new-
+ program. Depending on the setting of cbreak, this is af-
+ ter one character (cbreak mode), or after the first new-
line (nocbreak mode). In half-delay mode, the program
waits until a character is typed or the specified timeout
has been reached.
Unless noecho has been set, then the character will also
be echoed into the designated window according to the fol-
- lowing rules: If the character is the current erase char-
+ lowing rules: if the character is the current erase char-
acter, left arrow, or backspace, the cursor is moved one
space to the left and that screen position is erased as if
- delch had been called. If the character value is any
- other KEY_ define, the user is alerted with a beep call.
+ delch had been called. If the character value is any oth-
+ er KEY_ define, the user is alerted with a beep call.
Otherwise the character is simply output to the screen.
If the window is not a pad, and it has been moved or modi-
fied since the last call to wrefresh, wrefresh will be
called before another character is read.
- If keypad is TRUE, and a function key is pressed, the
- token for that function key is returned instead of the raw
- characters. Possible function keys are defined in
- <curses.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.
+ 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.
When a character that could be the beginning of a function
- key is received (which, on modern terminals, means an
- escape character), curses sets a timer. If the remainder
- of the sequence does not come in within the designated
- time, the character is passed through; otherwise, the
- function key value is returned. For this reason, many
- terminals experience a delay between the time a user
- presses the escape key and the escape is returned to the
- program.
+ key is received (which, on modern terminals, means an es-
+ cape character), curses sets a timer. If the remainder of
+ the sequence does not come in within the designated time,
+ the character is passed through; otherwise, the function
+ key value is returned. For this reason, many terminals
+ experience a delay between the time a user presses the es-
+ cape key and the escape is returned to the program.
The ungetch routine places ch back onto the input queue to
be returned by the next call to wgetch. There is just one
input queue for all windows.
-
Function Keys
- The following function keys, defined in <curses.h>, might
- be returned by getch if keypad has been enabled. Note
- that not all of these are necessarily supported on any
+ The following function keys, defined in <curses.h>, might
+ be returned by getch if keypad has been enabled. Note
+ that not all of these are necessarily supported on any
particular terminal.
- Name Key name
- KEY_BREAK Break key
+ Name Key name
+ KEY_BREAK Break key
KEY_DOWN The four arrow keys ...
KEY_UP
KEY_LEFT
@@ -178,9 +176,9 @@
KEY_REFERENCE Ref(erence) key
KEY_REFRESH Refresh key
KEY_REPLACE Replace key
-
KEY_RESIZE Screen resized
KEY_RESTART Restart key
+
KEY_RESUME Resume key
KEY_SAVE Save key
KEY_SBEG Shifted beginning key
@@ -217,6 +215,7 @@
Keypad is arranged like this:
+
+-----+------+-------+
| A1 | up | A3 |
+-----+------+-------+
@@ -227,17 +226,29 @@
The has_key routine takes a key value from the above list,
and returns TRUE or FALSE according to whether the current
terminal type recognizes a key with that value. Note that
- a few values do not correspond to a real key, e.g.,
- KEY_RESIZE and KEY_MOUSE.
-
+ a few values do not correspond to a real key, e.g.,
+ KEY_RESIZE and KEY_MOUSE. See resizeterm(3x) for more de-
+ tails about KEY_RESIZE, and curs_mouse(3x) for a discus-
+ sion of KEY_MOUSE.
RETURN VALUE
- 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.
+ ungetch
+ returns ERR if there is no more room in the FIFO.
+
+ wgetch
+ 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
+ outside the window, or if the window pointer is null.
+
NOTES
@@ -247,19 +258,35 @@
ing function-key sequence.
Note that some keys may be the same as commonly used con-
- trol keys, e.g., KEY_ENTER versus control/M, KEY_BACKSPACE
+ trol keys, e.g., KEY_ENTER versus control/M, KEY_BACKSPACE
versus control/H. Some curses implementations may differ
according to whether they treat these control keys spe-
cially (and ignore the terminfo), or use the terminfo def-
initions. Ncurses uses the terminfo definition. If it
- says that KEY_ENTER is control/M, getch will return
- KEY_ENTER when you press control/M.
+ 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
+ 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-
+ 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
+ carriage-return or line-feed, and finally
+
+ o "Enter or send" is the standard description for this
+ key.
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
- undesirable results.
+ when each character is typed, the program may produce un-
+ desirable results.
Note that getch, mvgetch, and mvwgetch may be macros.
@@ -282,38 +309,42 @@
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
- Curses standard.
+ 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
- implementation of handled signal receipt interrupts a
+ 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.
Programmers concerned about portability should be prepared
- for either of two cases: (a) signal receipt does not
- interrupt getch; (b) signal receipt interrupts getch and
+ 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
- NCURSES_VERSION feature macro.
+ that any code using it be conditionalized on the NCURS-
+ ES_VERSION feature macro.
SEE ALSO
- curses(3x), curs_inopts(3x), curs_mouse(3x),
- curs_move(3x), curs_refresh(3x). resizeterm(3x).
+ curses(3x), curs_inopts(3x), curs_outopts(3x),
+ curs_mouse(3x), curs_move(3x), curs_refresh(3x), re-
+ sizeterm(3x).
+
+ Comparable functions in the wide-character (ncursesw) li-
+ brary are described in curs_get_wch(3x).
- curs_getch(3x)
+ curs_getch(3x)