X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fcurs_inopts.3x.html;h=a7ab87a522db130085e56c0c3391ab86ee3de5fa;hb=7af63696972b12659832a1c3413d9ace9641c8f6;hp=d2d5b6b03f250e1dfd0cc6763301108f021c7ded;hpb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;p=ncurses.git diff --git a/doc/html/man/curs_inopts.3x.html b/doc/html/man/curs_inopts.3x.html index d2d5b6b0..a7ab87a5 100644 --- a/doc/html/man/curs_inopts.3x.html +++ b/doc/html/man/curs_inopts.3x.html @@ -1,6 +1,6 @@ @@ -38,24 +38,21 @@
-curs_inopts(3x) curs_inopts(3x) --
+
cbreak, nocbreak, echo, noecho, halfdelay, intrflush, keypad, meta, nodelay, notimeout, raw, noraw, noqiflush, qiflush, timeout, wtimeout, typeahead - curses input options --
+
#include <curses.h> int cbreak(void); @@ -77,8 +74,17 @@ int typeahead(int fd); --
+
+ The ncurses library provides several functions which let + an application change the way input from the terminal is + handled. Some are global, applying to all windows. Oth- + ers apply only to a specific window. Window-specific set- + tings are not automatically applied to new or derived win- + dows. An application must apply these to each window, if + the same behavior is needed. + + +
Normally, the tty driver buffers typed characters until a newline or carriage return is typed. The cbreak routine disables line buffering and erase/kill character-process- @@ -94,6 +100,8 @@ rides raw. [See curs_getch(3x) for a discussion of how these routines interact with echo and noecho.] + +
The echo and noecho routines control whether characters typed by the user are echoed by getch as they are typed. Echoing by the tty driver is always disabled, but initial- @@ -104,24 +112,30 @@ [See curs_getch(3x) for a discussion of how these routines interact with cbreak and nocbreak.] + +
The halfdelay routine is used for half-delay mode, which is similar to cbreak mode in that characters typed by the user are immediately available to the program. However, after blocking for tenths tenths of seconds, ERR is re- - turned if nothing has been typed. The value of tenths + turned if nothing has been typed. The value of tenths must be a number between 1 and 255. Use nocbreak to leave half-delay mode. - If the intrflush option is enabled, (bf is TRUE), when an + +
+ If the intrflush option is enabled (bf is TRUE), and an interrupt key is pressed on the keyboard (interrupt, - break, quit) all output in the tty driver queue will be + break, quit), all output in the tty driver queue will be flushed, giving the effect of faster response to the in- terrupt, but causing curses to have the wrong idea of what - is on the screen. Disabling (bf is FALSE), the option - prevents the flush. The default for the option is inher- - ited from the tty driver settings. The window argument is - ignored. + is on the screen. Disabling the option (bf is FALSE) pre- + vents the flush. The default for the option is inherited + from the tty driver settings. The window argument is ig- + nored. + +
The keypad option enables the keypad of the user's termi- nal. If enabled (bf is TRUE), the user can press a func- tion key (such as an arrow key) and wgetch returns a sin- @@ -132,8 +146,10 @@ turned on (made to transmit) and off (made to work local- ly), turning on this option causes the terminal keypad to be turned on when wgetch is called. The default value for - keypad is false. + keypad is FALSE. + +
Initially, whether the terminal returns 7 or 8 significant bits on input depends on the control mode of the tty driv- er [see termio(7)]. To force 8 bits to be returned, in- @@ -147,6 +163,8 @@ meta(win, TRUE) is called and rmm is sent when meta(win, FALSE) is called. + +
The nodelay option causes getch to be a non-blocking call. If no input is ready, getch returns ERR. If disabled (bf is FALSE), getch waits until a key is pressed. @@ -158,6 +176,8 @@ tween sequences received from a function key and those typed by a user. + +
The raw and noraw routines place the terminal into or out of raw mode. Raw mode is similar to cbreak mode, in that characters typed are immediately passed through to the us- @@ -167,6 +187,8 @@ signal. The behavior of the BREAK key depends on other bits in the tty driver that are not set by curses. + +
When the noqiflush routine is used, normal flush of input and output queues associated with the INTR, QUIT and SUSP characters will not be done [see termio(7)]. When qiflush @@ -175,6 +197,8 @@ a signal handler if you want output to continue as though the interrupt had not occurred, after the handler exits. + +
The timeout and wtimeout routines set blocking or non- blocking read for a given window. If delay is negative, blocking read is used (i.e., waits indefinitely for in- @@ -186,6 +210,8 @@ additional capability of being able to block for only de- lay milliseconds (where delay is positive). + +
The curses library does "line-breakout optimization" by looking for typeahead periodically while updating the screen. If input is found, and it is coming from a tty, @@ -199,8 +225,7 @@ typeahead checking is done. --
+
All routines that return an integer return ERR upon fail- ure and OK (SVr4 specifies only "an integer value other than ERR") upon successful completion, unless otherwise @@ -216,8 +241,7 @@ the range 1..255. --
+
These functions are described in the XSI Curses standard, Issue 4. @@ -264,8 +288,7 @@ used. --
+
Note that echo, noecho, halfdelay, intrflush, meta, node- lay, notimeout, noqiflush, qiflush, timeout, and wtimeout may be macros. @@ -278,8 +301,7 @@ recommended. --
+
curses(3x), curs_getch(3x), curs_initscr(3x), curs_util(3x), define_key(3x), termio(7) @@ -291,7 +313,21 @@