X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getch.3x.html;h=80d68f2ac78bc7ce447b2d203d645988f6a4b63f;hp=18eb8618ab99c8e725c5ec4b2e117a7bb3321da1;hb=83e9a85c4205c920cc9992bfc96f6546cd4fff22;hpb=3a935d9991cdf43ebfa952073c9b555f73a3e011 diff --git a/doc/html/man/curs_getch.3x.html b/doc/html/man/curs_getch.3x.html index 18eb8618..80d68f2a 100644 --- a/doc/html/man/curs_getch.3x.html +++ b/doc/html/man/curs_getch.3x.html @@ -1,8 +1,8 @@ - + @@ -76,14 +76,24 @@ 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- - 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 oth- - er KEY_ define, the user is alerted with a beep call. - Otherwise the character is simply output to the screen. + If echo is enabled, and the window is not a pad, then the + character will also be echoed into the designated window + according to the following rules: + + o If the character is the current erase character, 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. + + o If the character value is any other KEY_ define, the + user is alerted with a beep call. + + o If the character is a carriage-return, and if nl is + enabled, it is translated to a line-feed after echo- + ing. + + o 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 @@ -93,7 +103,7 @@ 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 + 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. @@ -116,8 +126,8 @@ that not all of these are necessarily supported on any particular terminal. - Name Key name + ------------------------------------------------- KEY_BREAK Break key KEY_DOWN The four arrow keys ... KEY_UP @@ -168,6 +178,7 @@ KEY_MESSAGE Message key KEY_MOUSE Mouse event read KEY_MOVE Move key + KEY_NEXT Next object key KEY_OPEN Open key KEY_OPTIONS Options key @@ -178,7 +189,6 @@ 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 @@ -238,14 +248,12 @@ integer value other than ERR (OK in the case of ungetch()) upon successful completion. - ungetch - returns an error if there is no more room in - the FIFO. + ungetch + returns ERR if there is no more room in the FIFO. - wgetch - returns an error if the window pointer is - null, or if its timeout expires without having - any data. + 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 @@ -268,6 +276,22 @@ 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 @@ -303,7 +327,7 @@ 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- + 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. @@ -321,10 +345,11 @@

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-
+       Comparable functions in the wide-character (ncursesw)  li-
        brary are described in curs_get_wch(3x).