2 ****************************************************************************
3 * Copyright 2018-2019,2020 Thomas E. Dickey *
4 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: curs_inopts.3x,v 1.33 2020/12/05 19:38:18 Benno.Schulenberg Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_inopts 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">curs_inopts 3x</H1>
44 <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>cbreak</STRONG>, <STRONG>nocbreak</STRONG>, <STRONG>echo</STRONG>, <STRONG>noecho</STRONG>, <STRONG>halfdelay</STRONG>, <STRONG>intrflush</STRONG>, <STRONG>keypad</STRONG>, <STRONG>meta</STRONG>, <STRONG>nl</STRONG>,
51 <STRONG>nonl</STRONG>, <STRONG>nodelay</STRONG>, <STRONG>notimeout</STRONG>, <STRONG>raw</STRONG>, <STRONG>noraw</STRONG>, <STRONG>qiflush</STRONG>, <STRONG>noqiflush</STRONG>, <STRONG>timeout</STRONG>,
52 <STRONG>wtimeout</STRONG>, <STRONG>typeahead</STRONG> - <STRONG>curses</STRONG> input options
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
58 <STRONG>int</STRONG> <STRONG>cbreak(void);</STRONG>
59 <STRONG>int</STRONG> <STRONG>nocbreak(void);</STRONG>
61 <STRONG>int</STRONG> <STRONG>echo(void);</STRONG>
62 <STRONG>int</STRONG> <STRONG>noecho(void);</STRONG>
64 <STRONG>int</STRONG> <STRONG>intrflush(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
65 <STRONG>int</STRONG> <STRONG>keypad(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
66 <STRONG>int</STRONG> <STRONG>meta(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
67 <STRONG>int</STRONG> <STRONG>nodelay(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
68 <STRONG>int</STRONG> <STRONG>notimeout(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
70 <STRONG>int</STRONG> <STRONG>nl(void);</STRONG>
71 <STRONG>int</STRONG> <STRONG>nonl(void);</STRONG>
73 <STRONG>int</STRONG> <STRONG>raw(void);</STRONG>
74 <STRONG>int</STRONG> <STRONG>noraw(void);</STRONG>
76 <STRONG>void</STRONG> <STRONG>qiflush(void);</STRONG>
77 <STRONG>void</STRONG> <STRONG>noqiflush(void);</STRONG>
79 <STRONG>int</STRONG> <STRONG>halfdelay(int</STRONG> <EM>tenths</EM><STRONG>);</STRONG>
80 <STRONG>void</STRONG> <STRONG>timeout(int</STRONG> <EM>delay</EM><STRONG>);</STRONG>
81 <STRONG>void</STRONG> <STRONG>wtimeout(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>delay</EM><STRONG>);</STRONG>
83 <STRONG>int</STRONG> <STRONG>typeahead(int</STRONG> <EM>fd</EM><STRONG>);</STRONG>
86 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
87 The <STRONG>ncurses</STRONG> library provides several functions which let an application
88 change the way input from the terminal is handled. Some are global,
89 applying to all windows. Others apply only to a specific window. Win-
90 dow-specific settings are not automatically applied to new or derived
91 windows. An application must apply these to each window, if the same
95 </PRE><H3><a name="h3-cbreak_nocbreak">cbreak/nocbreak</a></H3><PRE>
96 Normally, the tty driver buffers typed characters until a newline or
97 carriage return is typed. The <STRONG>cbreak</STRONG> routine disables line buffering
98 and erase/kill character-processing (interrupt and flow control charac-
99 ters are unaffected), making characters typed by the user immediately
100 available to the program. The <STRONG>nocbreak</STRONG> routine returns the terminal to
101 normal (cooked) mode.
103 Initially the terminal may or may not be in <STRONG>cbreak</STRONG> mode, as the mode is
104 inherited; therefore, a program should call <STRONG>cbreak</STRONG> or <STRONG>nocbreak</STRONG> explic-
105 itly. Most interactive programs using <STRONG>curses</STRONG> set the <STRONG>cbreak</STRONG> mode.
106 Note that <STRONG>cbreak</STRONG> overrides <STRONG>raw</STRONG>. [See <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> for a discussion
107 of how these routines interact with <STRONG>echo</STRONG> and <STRONG>noecho</STRONG>.]
110 </PRE><H3><a name="h3-echo_noecho">echo/noecho</a></H3><PRE>
111 The <STRONG>echo</STRONG> and <STRONG>noecho</STRONG> routines control whether characters typed by the
112 user are echoed by <STRONG><A HREF="curs_getch.3x.html">getch(3x)</A></STRONG> as they are typed. Echoing by the tty
113 driver is always disabled, but initially <STRONG>getch</STRONG> is in echo mode, so
114 characters typed are echoed. Authors of most interactive programs pre-
115 fer to do their own echoing in a controlled area of the screen, or not
116 to echo at all, so they disable echoing by calling <STRONG>noecho</STRONG>. [See
117 <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> for a discussion of how these routines interact with
118 <STRONG>cbreak</STRONG> and <STRONG>nocbreak</STRONG>.]
121 </PRE><H3><a name="h3-halfdelay">halfdelay</a></H3><PRE>
122 The <STRONG>halfdelay</STRONG> routine is used for half-delay mode, which is similar to
123 <STRONG>cbreak</STRONG> mode in that characters typed by the user are immediately avail-
124 able to the program. However, after blocking for <EM>tenths</EM> tenths of sec-
125 onds, <STRONG>ERR</STRONG> is returned if nothing has been typed. The value of <EM>tenths</EM>
126 must be a number between 1 and 255. Use <STRONG>nocbreak</STRONG> to leave half-delay
130 </PRE><H3><a name="h3-intrflush">intrflush</a></H3><PRE>
131 If the <STRONG>intrflush</STRONG> option is enabled (<EM>bf</EM> is <STRONG>TRUE</STRONG>), and an interrupt key
132 is pressed on the keyboard (interrupt, break, quit), all output in the
133 tty driver queue will be flushed, giving the effect of faster response
134 to the interrupt, but causing <STRONG>curses</STRONG> to have the wrong idea of what is
135 on the screen. Disabling the option (<EM>bf</EM> is <STRONG>FALSE</STRONG>) prevents the flush.
136 The default for the option is inherited from the tty driver settings.
137 The window argument is ignored.
140 </PRE><H3><a name="h3-keypad">keypad</a></H3><PRE>
141 The <STRONG>keypad</STRONG> option enables the keypad of the user's terminal. If en-
142 abled (<EM>bf</EM> is <STRONG>TRUE</STRONG>), the user can press a function key (such as an arrow
143 key) and <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG> returns a single value representing the function
144 key, as in <STRONG>KEY_LEFT</STRONG>. If disabled (<EM>bf</EM> is <STRONG>FALSE</STRONG>), <STRONG>curses</STRONG> does not treat
145 function keys specially and the program has to interpret the escape se-
146 quences itself. If the keypad in the terminal can be turned on (made
147 to transmit) and off (made to work locally), turning on this option
148 causes the terminal keypad to be turned on when <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG> is called.
149 The default value for keypad is <STRONG>FALSE</STRONG>.
152 </PRE><H3><a name="h3-meta">meta</a></H3><PRE>
153 Initially, whether the terminal returns 7 or 8 significant bits on in-
154 put depends on the control mode of the tty driver [see <STRONG>termios(3)</STRONG>]. To
155 force 8 bits to be returned, invoke <STRONG>meta</STRONG>(<EM>win</EM>, <STRONG>TRUE</STRONG>); this is equiva-
156 lent, under POSIX, to setting the CS8 flag on the terminal. To force 7
157 bits to be returned, invoke <STRONG>meta</STRONG>(<EM>win</EM>, <STRONG>FALSE</STRONG>); this is equivalent, under
158 POSIX, to setting the CS7 flag on the terminal. The window argument,
159 <EM>win</EM>, is always ignored. If the terminfo capabilities <STRONG>smm</STRONG> (meta_on) and
160 <STRONG>rmm</STRONG> (meta_off) are defined for the terminal, <STRONG>smm</STRONG> is sent to the termi-
161 nal when <STRONG>meta</STRONG>(<EM>win</EM>, <STRONG>TRUE</STRONG>) is called and <STRONG>rmm</STRONG> is sent when <STRONG>meta</STRONG>(<EM>win</EM>,
162 <STRONG>FALSE</STRONG>) is called.
165 </PRE><H3><a name="h3-nl_nonl">nl/nonl</a></H3><PRE>
166 The <STRONG>nl</STRONG> and <STRONG>nonl</STRONG> routines control whether the underlying display device
167 translates the return key into newline on input.
170 </PRE><H3><a name="h3-nodelay">nodelay</a></H3><PRE>
171 The <STRONG>nodelay</STRONG> option causes <STRONG>getch</STRONG> to be a non-blocking call. If no input
172 is ready, <STRONG>getch</STRONG> returns <STRONG>ERR</STRONG>. If disabled (<EM>bf</EM> is <STRONG>FALSE</STRONG>), <STRONG>getch</STRONG> waits
173 until a key is pressed.
176 </PRE><H3><a name="h3-notimeout">notimeout</a></H3><PRE>
177 When interpreting an escape sequence, <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG> sets a timer while
178 waiting for the next character. If <STRONG>notimeout(</STRONG><EM>win</EM>, <STRONG>TRUE</STRONG>) is called,
179 then <STRONG>wgetch</STRONG> does not set a timer. The purpose of the timeout is to
180 differentiate between sequences received from a function key and those
184 </PRE><H3><a name="h3-raw_noraw">raw/noraw</a></H3><PRE>
185 The <STRONG>raw</STRONG> and <STRONG>noraw</STRONG> routines place the terminal into or out of raw mode.
186 Raw mode is similar to <STRONG>cbreak</STRONG> mode, in that characters typed are imme-
187 diately passed through to the user program. The differences are that
188 in raw mode, the interrupt, quit, suspend, and flow control characters
189 are all passed through uninterpreted, instead of generating a signal.
190 The behavior of the BREAK key depends on other bits in the tty driver
191 that are not set by <STRONG>curses</STRONG>.
194 </PRE><H3><a name="h3-qiflush_noqiflush">qiflush/noqiflush</a></H3><PRE>
195 When the <STRONG>noqiflush</STRONG> routine is used, normal flush of input and output
196 queues associated with the <STRONG>INTR</STRONG>, <STRONG>QUIT</STRONG> and <STRONG>SUSP</STRONG> characters will not be
197 done [see <STRONG>termios(3)</STRONG>]. When <STRONG>qiflush</STRONG> is called, the queues will be
198 flushed when these control characters are read. You may want to call
199 <STRONG>noqiflush</STRONG> in a signal handler if you want output to continue as though
200 the interrupt had not occurred, after the handler exits.
203 </PRE><H3><a name="h3-timeout_wtimeout">timeout/wtimeout</a></H3><PRE>
204 The <STRONG>timeout</STRONG> and <STRONG>wtimeout</STRONG> routines set blocking or non-blocking read for
205 a given window. If <EM>delay</EM> is negative, blocking read is used (i.e.,
206 waits indefinitely for input). If <EM>delay</EM> is zero, then non-blocking
207 read is used (i.e., read returns <STRONG>ERR</STRONG> if no input is waiting). If <EM>delay</EM>
208 is positive, then read blocks for <EM>delay</EM> milliseconds, and returns <STRONG>ERR</STRONG>
209 if there is still no input. Hence, these routines provide the same
210 functionality as <STRONG>nodelay</STRONG>, plus the additional capability of being able
211 to block for only <EM>delay</EM> milliseconds (where <EM>delay</EM> is positive).
214 </PRE><H3><a name="h3-typeahead">typeahead</a></H3><PRE>
215 The <STRONG>curses</STRONG> library does "line-breakout optimization" by looking for ty-
216 peahead periodically while updating the screen. If input is found, and
217 it is coming from a tty, the current update is postponed until <STRONG>re-</STRONG>
218 <STRONG><A HREF="refresh.3x.html">fresh(3x)</A></STRONG> or <STRONG>doupdate</STRONG> is called again. This allows faster response to
219 commands typed in advance. Normally, the input FILE pointer passed to
220 <STRONG>newterm</STRONG>, or <STRONG>stdin</STRONG> in the case that <STRONG>initscr</STRONG> was used, will be used to do
221 this typeahead checking. The <STRONG>typeahead</STRONG> routine specifies that the file
222 descriptor <EM>fd</EM> is to be used to check for typeahead instead. If <EM>fd</EM> is
223 -1, then no typeahead checking is done.
226 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
227 All routines that return an integer return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
228 (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>") upon successful
229 completion, unless otherwise noted in the preceding routine descrip-
232 X/Open does not define any error conditions. In this implementation,
233 functions with a window parameter will return an error if it is null.
234 Any function will also return an error if the terminal was not initial-
237 <STRONG>halfdelay</STRONG>
238 returns an error if its parameter is outside the range
242 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
243 These functions are described in the XSI Curses standard, Issue 4.
245 The ncurses library obeys the XPG4 standard and the historical practice
246 of the AT&T curses implementations, in that the echo bit is cleared
247 when curses initializes the terminal state. BSD curses differed from
248 this slightly; it left the echo bit on at initialization, but the BSD
249 <STRONG>raw</STRONG> call turned it off as a side-effect. For best portability, set
250 <STRONG>echo</STRONG> or <STRONG>noecho</STRONG> explicitly just after initialization, even if your pro-
251 gram remains in cooked mode.
253 The XSI Curses standard is ambiguous on the question of whether <STRONG>raw</STRONG>
254 should disable the CRLF translations controlled by <STRONG>nl</STRONG> and <STRONG>nonl</STRONG>. BSD
255 curses did turn off these translations; AT&T curses (at least as late
256 as SVr1) did not. We chose to do so, on the theory that a programmer
257 requesting raw input wants a clean (ideally 8-bit clean) connection
258 that the operating system will not alter.
260 When <STRONG>keypad</STRONG> is first enabled, ncurses loads the key-definitions for the
261 current terminal description. If the terminal description includes ex-
262 tended string capabilities, e.g., from using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>, then
263 ncurses also defines keys for the capabilities whose names begin with
264 "k". The corresponding keycodes are generated and (depending on previ-
265 ous loads of terminal descriptions) may differ from one execution of a
266 program to the next. The generated keycodes are recognized by the <STRONG>key-</STRONG>
267 <STRONG>name</STRONG> function (which will then return a name beginning with "k" denot-
268 ing the terminfo capability name rather than "K", used for curses key-
269 names). On the other hand, an application can use <STRONG>define_key</STRONG> to estab-
270 lish a specific keycode for a given string. This makes it possible for
271 an application to check for an extended capability's presence with
272 <STRONG>tigetstr</STRONG>, and reassign the keycode to match its own needs.
274 Low-level applications can use <STRONG>tigetstr</STRONG> to obtain the definition of any
275 particular string capability. Higher-level applications which use the
276 curses <STRONG>wgetch</STRONG> and similar functions to return keycodes rely upon the
277 order in which the strings are loaded. If more than one key definition
278 has the same string value, then <STRONG>wgetch</STRONG> can return only one keycode.
279 Most curses implementations (including ncurses) load key definitions in
280 the order defined by the array of string capability names. The last
281 key to be loaded determines the keycode which will be returned. In
282 ncurses, you may also have extended capabilities interpreted as key
283 definitions. These are loaded after the predefined keys, and if a ca-
284 pability's value is the same as a previously-loaded key definition, the
285 later definition is the one used.
288 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
289 Note that <STRONG>echo</STRONG>, <STRONG>noecho</STRONG>, <STRONG>halfdelay</STRONG>, <STRONG>intrflush</STRONG>, <STRONG>meta</STRONG>, <STRONG>nl</STRONG>, <STRONG>nonl</STRONG>, <STRONG>nodelay</STRONG>,
290 <STRONG>notimeout</STRONG>, <STRONG>noqiflush</STRONG>, <STRONG>qiflush</STRONG>, <STRONG>timeout</STRONG>, and <STRONG>wtimeout</STRONG> may be macros.
292 The <STRONG>noraw</STRONG> and <STRONG>nocbreak</STRONG> calls follow historical practice in that they
293 attempt to restore to normal ("cooked") mode from raw and cbreak modes
294 respectively. Mixing raw/noraw and cbreak/nocbreak calls leads to tty
295 driver control states that are hard to predict or understand; it is not
299 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
300 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG>de-</STRONG>
301 <STRONG><A HREF="define_key.3x.html">fine_key(3x)</A></STRONG>, <STRONG>termios(3)</STRONG>
305 <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
309 <li><a href="#h2-NAME">NAME</a></li>
310 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
311 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
313 <li><a href="#h3-cbreak_nocbreak">cbreak/nocbreak</a></li>
314 <li><a href="#h3-echo_noecho">echo/noecho</a></li>
315 <li><a href="#h3-halfdelay">halfdelay</a></li>
316 <li><a href="#h3-intrflush">intrflush</a></li>
317 <li><a href="#h3-keypad">keypad</a></li>
318 <li><a href="#h3-meta">meta</a></li>
319 <li><a href="#h3-nl_nonl">nl/nonl</a></li>
320 <li><a href="#h3-nodelay">nodelay</a></li>
321 <li><a href="#h3-notimeout">notimeout</a></li>
322 <li><a href="#h3-raw_noraw">raw/noraw</a></li>
323 <li><a href="#h3-qiflush_noqiflush">qiflush/noqiflush</a></li>
324 <li><a href="#h3-timeout_wtimeout">timeout/wtimeout</a></li>
325 <li><a href="#h3-typeahead">typeahead</a></li>
328 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
329 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
330 <li><a href="#h2-NOTES">NOTES</a></li>
331 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
projects / ncurses.git / blob