ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / curs_inopts.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
4   * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
5   *                                                                          *
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:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
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.                               *
24   *                                                                          *
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       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: curs_inopts.3x,v 1.29 2020/02/02 23:34:34 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
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">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_inopts 3x</H1>
43 <PRE>
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>
45
46
47
48
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>,
51        <STRONG>nodelay</STRONG>, <STRONG>notimeout</STRONG>, <STRONG>raw</STRONG>, <STRONG>noraw</STRONG>, <STRONG>noqiflush</STRONG>, <STRONG>qiflush</STRONG>, <STRONG>timeout</STRONG>, <STRONG>wtimeout</STRONG>,
52        <STRONG>typeahead</STRONG> - <STRONG>curses</STRONG> input options
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>int</STRONG> <STRONG>cbreak(void);</STRONG>
59        <STRONG>int</STRONG> <STRONG>nocbreak(void);</STRONG>
60        <STRONG>int</STRONG> <STRONG>echo(void);</STRONG>
61        <STRONG>int</STRONG> <STRONG>noecho(void);</STRONG>
62        <STRONG>int</STRONG> <STRONG>halfdelay(int</STRONG> <STRONG>tenths);</STRONG>
63        <STRONG>int</STRONG> <STRONG>intrflush(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG>
64        <STRONG>int</STRONG> <STRONG>keypad(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG>
65        <STRONG>int</STRONG> <STRONG>meta(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG>
66        <STRONG>int</STRONG> <STRONG>nodelay(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG>
67        <STRONG>int</STRONG> <STRONG>raw(void);</STRONG>
68        <STRONG>int</STRONG> <STRONG>noraw(void);</STRONG>
69        <STRONG>void</STRONG> <STRONG>noqiflush(void);</STRONG>
70        <STRONG>void</STRONG> <STRONG>qiflush(void);</STRONG>
71        <STRONG>int</STRONG> <STRONG>notimeout(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG>
72        <STRONG>void</STRONG> <STRONG>timeout(int</STRONG> <STRONG>delay);</STRONG>
73        <STRONG>void</STRONG> <STRONG>wtimeout(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>delay);</STRONG>
74        <STRONG>int</STRONG> <STRONG>typeahead(int</STRONG> <STRONG>fd);</STRONG>
75
76
77 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
78        The <STRONG>ncurses</STRONG> library provides several functions which let an application
79        change the way input from the terminal is handled.   Some  are  global,
80        applying to all windows.  Others apply only to a specific window.  Win-
81        dow-specific settings are not automatically applied to new  or  derived
82        windows.   An  application must apply these to each window, if the same
83        behavior is needed.
84
85
86 </PRE><H3><a name="h3-cbreak">cbreak</a></H3><PRE>
87        Normally, the tty driver buffers typed characters until  a  newline  or
88        carriage  return  is typed.  The <STRONG>cbreak</STRONG> routine disables line buffering
89        and erase/kill character-processing (interrupt and flow control charac-
90        ters  are  unaffected), making characters typed by the user immediately
91        available to the program.  The <STRONG>nocbreak</STRONG> routine returns the terminal to
92        normal (cooked) mode.
93
94        Initially the terminal may or may not be in <STRONG>cbreak</STRONG> mode, as the mode is
95        inherited; therefore, a program should call <STRONG>cbreak</STRONG> or <STRONG>nocbreak</STRONG>  explic-
96        itly.   Most  interactive  programs  using  <STRONG>curses</STRONG> set the <STRONG>cbreak</STRONG> mode.
97        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
98        of how these routines interact with <STRONG>echo</STRONG> and <STRONG>noecho</STRONG>.]
99
100
101 </PRE><H3><a name="h3-echo_noecho">echo/noecho</a></H3><PRE>
102        The  <STRONG>echo</STRONG>  and  <STRONG>noecho</STRONG> routines control whether characters typed by the
103        user are echoed by <STRONG><A HREF="curs_getch.3x.html">getch(3x)</A></STRONG> as they are typed.   Echoing  by  the  tty
104        driver  is  always  disabled,  but  initially <STRONG>getch</STRONG> is in echo mode, so
105        characters typed are echoed.  Authors of most interactive programs pre-
106        fer  to do their own echoing in a controlled area of the screen, or not
107        to echo at all, so  they  disable  echoing  by  calling  <STRONG>noecho</STRONG>.   [See
108        <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>  for  a  discussion  of how these routines interact with
109        <STRONG>cbreak</STRONG> and <STRONG>nocbreak</STRONG>.]
110
111
112 </PRE><H3><a name="h3-halfdelay">halfdelay</a></H3><PRE>
113        The <STRONG>halfdelay</STRONG> routine is used for half-delay mode, which is similar  to
114        <STRONG>cbreak</STRONG> mode in that characters typed by the user are immediately avail-
115        able to the program.  However, after blocking for <EM>tenths</EM> tenths of sec-
116        onds,  <STRONG>ERR</STRONG>  is returned if nothing has been typed.  The value of <EM>tenths</EM>
117        must be a number between 1 and 255.  Use <STRONG>nocbreak</STRONG> to  leave  half-delay
118        mode.
119
120
121 </PRE><H3><a name="h3-intrflush">intrflush</a></H3><PRE>
122        If  the  <STRONG>intrflush</STRONG> option is enabled (<EM>bf</EM> is <STRONG>TRUE</STRONG>), and an interrupt key
123        is pressed on the keyboard (interrupt, break, quit), all output in  the
124        tty  driver queue will be flushed, giving the effect of faster response
125        to the interrupt, but causing <STRONG>curses</STRONG> to have the wrong idea of what  is
126        on  the screen.  Disabling the option (<EM>bf</EM> is <STRONG>FALSE</STRONG>) prevents the flush.
127        The default for the option is inherited from the tty  driver  settings.
128        The window argument is ignored.
129
130
131 </PRE><H3><a name="h3-keypad">keypad</a></H3><PRE>
132        The  <STRONG>keypad</STRONG>  option  enables the keypad of the user's terminal.  If en-
133        abled (<EM>bf</EM> is <STRONG>TRUE</STRONG>), the user can press a function key (such as an arrow
134        key)  and  <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG>  returns a single value representing the function
135        key, as in <STRONG>KEY_LEFT</STRONG>.  If disabled (<EM>bf</EM> is <STRONG>FALSE</STRONG>), <STRONG>curses</STRONG> does not  treat
136        function keys specially and the program has to interpret the escape se-
137        quences itself.  If the keypad in the terminal can be turned  on  (made
138        to  transmit)  and  off  (made to work locally), turning on this option
139        causes the terminal keypad to be turned on when <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG>  is  called.
140        The default value for keypad is <STRONG>FALSE</STRONG>.
141
142
143 </PRE><H3><a name="h3-meta">meta</a></H3><PRE>
144        Initially,  whether the terminal returns 7 or 8 significant bits on in-
145        put depends on the control mode of the tty driver [see <STRONG>termios(3)</STRONG>].  To
146        force  8  bits  to be returned, invoke <STRONG>meta</STRONG>(<EM>win</EM>, <STRONG>TRUE</STRONG>); this is equiva-
147        lent, under POSIX, to setting the CS8 flag on the terminal.  To force 7
148        bits to be returned, invoke <STRONG>meta</STRONG>(<EM>win</EM>, <STRONG>FALSE</STRONG>); this is equivalent, under
149        POSIX, to setting the CS7 flag on the terminal.  The  window  argument,
150        <EM>win</EM>, is always ignored.  If the terminfo capabilities <STRONG>smm</STRONG> (meta_on) and
151        <STRONG>rmm</STRONG> (meta_off) are defined for the terminal, <STRONG>smm</STRONG> is sent to the  termi-
152        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>,
153        <STRONG>FALSE</STRONG>) is called.
154
155
156 </PRE><H3><a name="h3-nodelay">nodelay</a></H3><PRE>
157        The <STRONG>nodelay</STRONG> option causes <STRONG>getch</STRONG> to be a non-blocking call.  If no input
158        is  ready,  <STRONG>getch</STRONG>  returns <STRONG>ERR</STRONG>.  If disabled (<EM>bf</EM> is <STRONG>FALSE</STRONG>), <STRONG>getch</STRONG> waits
159        until a key is pressed.
160
161        While interpreting an input escape sequence, <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG>  sets  a  timer
162        while  waiting  for  the  next  character.   If <STRONG>notimeout(</STRONG><EM>win</EM>, <STRONG>TRUE</STRONG>) is
163        called, then <STRONG>wgetch</STRONG> does not set a timer.  The purpose of  the  timeout
164        is  to differentiate between sequences received from a function key and
165        those typed by a user.
166
167
168 </PRE><H3><a name="h3-raw_noraw">raw/noraw</a></H3><PRE>
169        The <STRONG>raw</STRONG> and <STRONG>noraw</STRONG> routines place the terminal into or out of raw  mode.
170        Raw  mode is similar to <STRONG>cbreak</STRONG> mode, in that characters typed are imme-
171        diately passed through to the user program.  The differences  are  that
172        in  raw mode, the interrupt, quit, suspend, and flow control characters
173        are all passed through uninterpreted, instead of generating  a  signal.
174        The  behavior  of the BREAK key depends on other bits in the tty driver
175        that are not set by <STRONG>curses</STRONG>.
176
177
178 </PRE><H3><a name="h3-noqiflush">noqiflush</a></H3><PRE>
179        When the <STRONG>noqiflush</STRONG> routine is used, normal flush of  input  and  output
180        queues  associated  with the <STRONG>INTR</STRONG>, <STRONG>QUIT</STRONG> and <STRONG>SUSP</STRONG> characters will not be
181        done [see <STRONG>termios(3)</STRONG>].  When <STRONG>qiflush</STRONG> is  called,  the  queues  will  be
182        flushed  when  these control characters are read.  You may want to call
183        <STRONG>noqiflush</STRONG> in a signal handler if you want output to continue as  though
184        the interrupt had not occurred, after the handler exits.
185
186
187 </PRE><H3><a name="h3-timeout_wtimeout">timeout/wtimeout</a></H3><PRE>
188        The <STRONG>timeout</STRONG> and <STRONG>wtimeout</STRONG> routines set blocking or non-blocking read for
189        a given window.  If <EM>delay</EM> is negative, blocking  read  is  used  (i.e.,
190        waits  indefinitely  for  input).   If <EM>delay</EM> is zero, then non-blocking
191        read is used (i.e., read returns <STRONG>ERR</STRONG> if no input is waiting).  If <EM>delay</EM>
192        is  positive,  then read blocks for <EM>delay</EM> milliseconds, and returns <STRONG>ERR</STRONG>
193        if there is still no input.  Hence, these  routines  provide  the  same
194        functionality  as <STRONG>nodelay</STRONG>, plus the additional capability of being able
195        to block for only <EM>delay</EM> milliseconds (where <EM>delay</EM> is positive).
196
197
198 </PRE><H3><a name="h3-typeahead">typeahead</a></H3><PRE>
199        The <STRONG>curses</STRONG> library does "line-breakout optimization" by looking for ty-
200        peahead periodically while updating the screen.  If input is found, and
201        it is coming from a tty, the current  update  is  postponed  until  <STRONG>re-</STRONG>
202        <STRONG><A HREF="refresh.3x.html">fresh(3x)</A></STRONG>  or <STRONG>doupdate</STRONG> is called again.  This allows faster response to
203        commands typed in advance.  Normally, the input FILE pointer passed  to
204        <STRONG>newterm</STRONG>, or <STRONG>stdin</STRONG> in the case that <STRONG>initscr</STRONG> was used, will be used to do
205        this typeahead checking.  The <STRONG>typeahead</STRONG> routine specifies that the file
206        descriptor  <EM>fd</EM>  is to be used to check for typeahead instead.  If <EM>fd</EM> is
207        -1, then no typeahead checking is done.
208
209
210 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
211        All routines that return an integer return  <STRONG>ERR</STRONG>  upon  failure  and  <STRONG>OK</STRONG>
212        (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>") upon successful
213        completion, unless otherwise noted in the  preceding  routine  descrip-
214        tions.
215
216        X/Open  does  not define any error conditions.  In this implementation,
217        functions with a window parameter will return an error if it  is  null.
218        Any function will also return an error if the terminal was not initial-
219        ized.  Also,
220
221               <STRONG>halfdelay</STRONG>
222                    returns an error if its  parameter  is  outside  the  range
223                    1..255.
224
225
226 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
227        These functions are described in the XSI Curses standard, Issue 4.
228
229        The ncurses library obeys the XPG4 standard and the historical practice
230        of the AT&amp;T curses implementations, in that the  echo  bit  is  cleared
231        when  curses  initializes the terminal state.  BSD curses differed from
232        this slightly; it left the echo bit on at initialization, but  the  BSD
233        <STRONG>raw</STRONG>  call  turned  it  off as a side-effect.  For best portability, set
234        echo or noecho explicitly just after initialization, even if your  pro-
235        gram remains in cooked mode.
236
237        When <STRONG>keypad</STRONG> is first enabled, ncurses loads the key-definitions for the
238        current terminal description.  If the terminal description includes ex-
239        tended string capabilities, e.g., from using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>, then
240        ncurses also defines keys for the capabilities whose names  begin  with
241        "k".  The corresponding keycodes are generated and (depending on previ-
242        ous loads of terminal descriptions) may differ from one execution of  a
243        program to the next.  The generated keycodes are recognized by the <STRONG>key-</STRONG>
244        <STRONG>name</STRONG> function (which will then return a name beginning with "k"  denot-
245        ing  the terminfo capability name rather than "K", used for curses key-
246        names).  On the other hand, an application can use <STRONG>define_key</STRONG> to estab-
247        lish a specific keycode for a given string.  This makes it possible for
248        an application to check for  an  extended  capability's  presence  with
249        <STRONG>tigetstr</STRONG>, and reassign the keycode to match its own needs.
250
251        Low-level applications can use <STRONG>tigetstr</STRONG> to obtain the definition of any
252        particular string capability.  Higher-level applications which use  the
253        curses  <STRONG>wgetch</STRONG>  and  similar functions to return keycodes rely upon the
254        order in which the strings are loaded.  If more than one key definition
255        has  the  same  string  value, then <STRONG>wgetch</STRONG> can return only one keycode.
256        Most curses implementations (including ncurses) load key definitions in
257        the  order  defined  by the array of string capability names.  The last
258        key to be loaded determines the keycode which  will  be  returned.   In
259        ncurses,  you  may  also  have extended capabilities interpreted as key
260        definitions.  These are loaded after the predefined keys, and if a  ca-
261        pability's value is the same as a previously-loaded key definition, the
262        later definition is the one used.
263
264
265 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
266        Note that <STRONG>echo</STRONG>, <STRONG>noecho</STRONG>, <STRONG>halfdelay</STRONG>, <STRONG>intrflush</STRONG>, <STRONG>meta</STRONG>, <STRONG>nodelay</STRONG>, <STRONG>notimeout</STRONG>,
267        <STRONG>noqiflush</STRONG>, <STRONG>qiflush</STRONG>, <STRONG>timeout</STRONG>, and <STRONG>wtimeout</STRONG> may be macros.
268
269        The  <STRONG>noraw</STRONG>  and  <STRONG>nocbreak</STRONG> calls follow historical practice in that they
270        attempt to restore to normal ("cooked") mode from raw and cbreak  modes
271        respectively.   Mixing raw/noraw and cbreak/nocbreak calls leads to tty
272        driver control states that are hard to predict or understand; it is not
273        recommended.
274
275
276 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
277        <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>
278        <STRONG><A HREF="define_key.3x.html">fine_key(3x)</A></STRONG>, <STRONG>termios(3)</STRONG>
279
280
281
282                                                                <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
283 </PRE>
284 <div class="nav">
285 <ul>
286 <li><a href="#h2-NAME">NAME</a></li>
287 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
288 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
289 <ul>
290 <li><a href="#h3-cbreak">cbreak</a></li>
291 <li><a href="#h3-echo_noecho">echo/noecho</a></li>
292 <li><a href="#h3-halfdelay">halfdelay</a></li>
293 <li><a href="#h3-intrflush">intrflush</a></li>
294 <li><a href="#h3-keypad">keypad</a></li>
295 <li><a href="#h3-meta">meta</a></li>
296 <li><a href="#h3-nodelay">nodelay</a></li>
297 <li><a href="#h3-raw_noraw">raw/noraw</a></li>
298 <li><a href="#h3-noqiflush">noqiflush</a></li>
299 <li><a href="#h3-timeout_wtimeout">timeout/wtimeout</a></li>
300 <li><a href="#h3-typeahead">typeahead</a></li>
301 </ul>
302 </li>
303 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
304 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
305 <li><a href="#h2-NOTES">NOTES</a></li>
306 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
307 </ul>
308 </div>
309 </BODY>
310 </HTML>