X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inopts.3x.html;fp=doc%2Fhtml%2Fman%2Fcurs_inopts.3x.html;h=16f564cd499bdef28dbc7a790f27d09892e4b8aa;hp=79d4feec1e314e39d790111e90bd1e39316850e4;hb=084e3b44fc1c904d5ab941da55f47a237cb15766;hpb=89d66edde5b9525fff1f4343470231344d1ff2c6 diff --git a/doc/html/man/curs_inopts.3x.html b/doc/html/man/curs_inopts.3x.html index 79d4feec..16f564cd 100644 --- a/doc/html/man/curs_inopts.3x.html +++ b/doc/html/man/curs_inopts.3x.html @@ -28,19 +28,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_inopts.3x,v 1.56 2023/10/21 10:28:36 tom Exp @ + * @Id: curs_inopts.3x,v 1.58 2023/11/25 14:30:50 tom Exp @ -->
-curs_inopts(3x) Library calls curs_inopts(3x) @@ -246,6 +246,17 @@ returns an error if its parameter is outside the range 1..255. +
+ Note that echo, noecho, halfdelay, intrflush, meta, nl, nonl, nodelay, + notimeout, noqiflush, qiflush, timeout, and wtimeout may be macros. + + The noraw and nocbreak calls follow historical practice in that they + attempt to restore to normal ("cooked") mode from raw and cbreak modes + respectively. Mixing raw/noraw and cbreak/nocbreak calls leads to tty + driver control states that are hard to predict or understand; it is not + recommended. + +
This implementation provides four functions which may be used to detect if the corresponding flags were set or reset: @@ -265,78 +276,67 @@ -1 if the curses library was not initialized. - These routines are specific to ncurses. They were not supported on + These routines are specific to ncurses. They were not supported on Version 7, BSD or System V implementations. It is recommended that any code depending on ncurses extensions be conditioned using NCURSES_VERSION.
- Except as noted in the section on extensions, these functions are + Except as noted in the section on extensions, these functions are described in the XSI Curses standard, Issue 4. The ncurses library obeys the XPG4 standard and the historical practice - of the AT&T curses implementations, in that the echo bit is cleared - when curses initializes the terminal state. BSD curses differed from - this slightly; it left the echo bit on at initialization, but the BSD - raw call turned it off as a side-effect. For best portability, set - echo or noecho explicitly just after initialization, even if your + of the AT&T curses implementations, in that the echo bit is cleared + when curses initializes the terminal state. BSD curses differed from + this slightly; it left the echo bit on at initialization, but the BSD + raw call turned it off as a side-effect. For best portability, set + echo or noecho explicitly just after initialization, even if your program remains in cooked mode. - The XSI Curses standard is ambiguous on the question of whether raw - should disable the CRLF translations controlled by nl and nonl. BSD - curses did turn off these translations; AT&T curses (at least as late - as SVr1) did not. We chose to do so, on the theory that a programmer - requesting raw input wants a clean (ideally 8-bit clean) connection + The XSI Curses standard is ambiguous on the question of whether raw + should disable the CRLF translations controlled by nl and nonl. BSD + curses did turn off these translations; AT&T curses (at least as late + as SVr1) did not. We chose to do so, on the theory that a programmer + requesting raw input wants a clean (ideally 8-bit clean) connection that the operating system will not alter. When keypad is first enabled, ncurses loads the key-definitions for the - current terminal description. If the terminal description includes - extended string capabilities, e.g., from using the -x option of tic, - then ncurses also defines keys for the capabilities whose names begin - with "k". The corresponding keycodes are generated and (depending on - previous loads of terminal descriptions) may differ from one execution + current terminal description. If the terminal description includes + extended string capabilities, e.g., from using the -x option of tic, + then ncurses also defines keys for the capabilities whose names begin + with "k". The corresponding keycodes are generated and (depending on + previous loads of terminal descriptions) may differ from one execution of a program to the next. The generated keycodes are recognized by the - keyname function (which will then return a name beginning with "k" - denoting the terminfo capability name rather than "K", used for curses - key-names). On the other hand, an application can use define_key to - establish a specific keycode for a given string. This makes it - possible for an application to check for an extended capability's - presence with tigetstr, and reassign the keycode to match its own + keyname function (which will then return a name beginning with "k" + denoting the terminfo capability name rather than "K", used for curses + key-names). On the other hand, an application can use define_key to + establish a specific keycode for a given string. This makes it + possible for an application to check for an extended capability's + presence with tigetstr, and reassign the keycode to match its own needs. Low-level applications can use tigetstr to obtain the definition of any - particular string capability. Higher-level applications which use the - curses wgetch and similar functions to return keycodes rely upon the + particular string capability. Higher-level applications which use the + curses wgetch and similar functions to return keycodes rely upon the order in which the strings are loaded. If more than one key definition - has the same string value, then wgetch can return only one keycode. + has the same string value, then wgetch can return only one keycode. Most curses implementations (including ncurses) load key definitions in - the order defined by the array of string capability names. The last - key to be loaded determines the keycode which will be returned. In - ncurses, you may also have extended capabilities interpreted as key - definitions. These are loaded after the predefined keys, and if a - capability's value is the same as a previously-loaded key definition, + the order defined by the array of string capability names. The last + key to be loaded determines the keycode which will be returned. In + ncurses, you may also have extended capabilities interpreted as key + definitions. These are loaded after the predefined keys, and if a + capability's value is the same as a previously-loaded key definition, the later definition is the one used. -
- Note that echo, noecho, halfdelay, intrflush, meta, nl, nonl, nodelay, - notimeout, noqiflush, qiflush, timeout, and wtimeout may be macros. - - The noraw and nocbreak calls follow historical practice in that they - attempt to restore to normal ("cooked") mode from raw and cbreak modes - respectively. Mixing raw/noraw and cbreak/nocbreak calls leads to tty - driver control states that are hard to predict or understand; it is not - recommended. - -
curses(3x), curs_getch(3x), curs_initscr(3x), curs_util(3x), define_key(3x), termios(3) -ncurses 6.4 2023-10-21 curs_inopts(3x) +ncurses 6.4 2023-11-25 curs_inopts(3x)