1termios.h(0P) POSIX Programmer's Manual termios.h(0P)
2
6 This manual page is part of the POSIX Programmer's Manual. The Linux
7 implementation of this interface may differ (consult the corresponding
8 Linux manual page for details of Linux behavior), or the interface may
9 not be implemented on Linux.
10
12 termios.h — define values for termios
13
15 #include <termios.h>
16
18 The <termios.h> header shall contain the definitions used by the termi‐
19 nal I/O interfaces (see Chapter 11, General Terminal Interface for the
20 structures and names defined).
21 The termios Structure
23 The <termios.h> header shall define the following data types through
24 typedef:
25 cc_t Used for terminal special characters.
27 speed_t Used for terminal baud rates.
29 tcflag_t Used for terminal modes.
31 The above types shall be all unsigned integer types.
33 The implementation shall support one or more programming environments
35 in which the widths of cc_t, speed_t, and tcflag_t are no greater than
36 the width of type long. The names of these programming environments
37 can be obtained using the confstr() function or the getconf utility.
38 The <termios.h> header shall define the termios structure, which shall
40 include at least the following members:
41 tcflag_t c_iflag Input modes.
44 tcflag_t c_oflag Output modes.
45 tcflag_t c_cflag Control modes.
46 tcflag_t c_lflag Local modes.
47 cc_t c_cc[NCCS] Control characters.
48 The <termios.h> header shall define the following symbolic constant:
50 NCCS Size of the array c_cc for control characters.
52 The <termios.h> header shall define the following symbolic constants
54 for use as subscripts for the array c_cc:
55 ┌────────────────────────────────────┬──────────────────┐
57 │ Subscript Usage │ │
58 │Canonical Mode Non-Canonical Mode │ Description │
59 ├───────────────┬────────────────────┼──────────────────┤
60 │VEOF │ │ EOF character. │
61 │VEOL │ │ EOL character. │
62 │VERASE │ │ ERASE character. │
63 │VINTR │ VINTR │ INTR character. │
64 │VKILL │ │ KILL character. │
65 │ │ VMIN │ MIN value. │
66 │VQUIT │ VQUIT │ QUIT character. │
67 │VSTART │ VSTART │ START character. │
68 │VSTOP │ VSTOP │ STOP character. │
69 │VSUSP │ VSUSP │ SUSP character. │
70 │ │ VTIME │ TIME value. │
71 └───────────────┴────────────────────┴──────────────────┘
72 The subscript values shall be suitable for use in #if preprocessing
73 directives and shall be distinct, except that the VMIN and VTIME sub‐
74 scripts may have the same values as the VEOF and VEOL subscripts,
75 respectively.
76 Input Modes
78 The <termios.h> header shall define the following symbolic constants
79 for use as flags in the c_iflag field. The c_iflag field describes the
80 basic terminal input control.
81 BRKINT Signal interrupt on break.
83 ICRNL Map CR to NL on input.
85 IGNBRK Ignore break condition.
87 IGNCR Ignore CR.
89 IGNPAR Ignore characters with parity errors.
91 INLCR Map NL to CR on input.
93 INPCK Enable input parity check.
95 ISTRIP Strip character.
97 IXANY Enable any character to restart output.
99 IXOFF Enable start/stop input control.
101 IXON Enable start/stop output control.
103 PARMRK Mark parity errors.
105 Output Modes
107 The <termios.h> header shall define the following symbolic constants
108 for use as flags in the c_oflag field. The c_oflag field specifies the
109 system treatment of output.
110 OPOST Post-process output.
112 ONLCR Map NL to CR-NL on output.
114 OCRNL Map CR to NL on output.
116 ONOCR No CR output at column 0.
118 ONLRET NL performs CR function.
120 OFDEL Fill is DEL.
122 OFILL Use fill characters for delay.
124 NLDLY Select newline delays:
126 NL0 Newline type 0.
128 NL1 Newline type 1.
130 CRDLY Select carriage-return delays:
132 CR0 Carriage-return delay type 0.
134 CR1 Carriage-return delay type 1.
136 CR2 Carriage-return delay type 2.
138 CR3 Carriage-return delay type 3.
140 TABDLY Select horizontal-tab delays:
142 TAB0 Horizontal-tab delay type 0.
144 TAB1 Horizontal-tab delay type 1.
146 TAB2 Horizontal-tab delay type 2.
148 TAB3 Expand tabs to spaces.
150 BSDLY Select backspace delays:
152 BS0 Backspace-delay type 0.
154 BS1 Backspace-delay type 1.
156 VTDLY Select vertical-tab delays:
158 VT0 Vertical-tab delay type 0.
160 VT1 Vertical-tab delay type 1.
162 FFDLY Select form-feed delays:
164 FF0 Form-feed delay type 0.
166 FF1 Form-feed delay type 1.
168 Baud Rate Selection
170 The <termios.h> header shall define the following symbolic constants
171 for use as values of objects of type speed_t.
172 The input and output baud rates are stored in the termios structure.
174 These are the valid values for objects of type speed_t. Not all baud
175 rates need be supported by the underlying hardware.
176 B0 Hang up
178 B50 50 baud
180 B75 75 baud
182 B110 110 baud
184 B134 134.5 baud
186 B150 150 baud
188 B200 200 baud
190 B300 300 baud
192 B600 600 baud
194 B1200 1200 baud
196 B1800 1800 baud
198 B2400 2400 baud
200 B4800 4800 baud
202 B9600 9600 baud
204 B19200 19200 baud
206 B38400 38400 baud
208 Control Modes
210 The <termios.h> header shall define the following symbolic constants
211 for use as flags in the c_cflag field. The c_cflag field describes the
212 hardware control of the terminal; not all values specified are required
213 to be supported by the underlying hardware.
214 CSIZE Character size:
216 CS5 5 bits
218 CS6 6 bits
220 CS7 7 bits
222 CS8 8 bits
224 CSTOPB Send two stop bits, else one.
226 CREAD Enable receiver.
228 PARENB Parity enable.
230 PARODD Odd parity, else even.
232 HUPCL Hang up on last close.
234 CLOCAL Ignore modem status lines.
236 The implementation shall support the functionality associated with the
238 symbols CS7, CS8, CSTOPB, PARODD, and PARENB.
239 Local Modes
241 The <termios.h> header shall define the following symbolic constants
242 for use as flags in the c_lflag field. The c_lflag field of the argu‐
243 ment structure is used to control various terminal functions.
244 ECHO Enable echo.
246 ECHOE Echo erase character as error-correcting backspace.
248 ECHOK Echo KILL.
250 ECHONL Echo NL.
252 ICANON Canonical input (erase and kill processing).
254 IEXTEN Enable extended input character processing.
256 ISIG Enable signals.
258 NOFLSH Disable flush after interrupt or quit.
260 TOSTOP Send SIGTTOU for background output.
262 Attribute Selection
264 The <termios.h> header shall define the following symbolic constants
265 for use with tcsetattr():
266 TCSANOW Change attributes immediately.
268 TCSADRAIN Change attributes when output has drained.
270 TCSAFLUSH Change attributes when output has drained; also flush pend‐
272 ing input.
273 Line Control
275 The <termios.h> header shall define the following symbolic constants
276 for use with tcflush():
277 TCIFLUSH Flush pending input.
279 TCIOFLUSH Flush both pending input and untransmitted output.
281 TCOFLUSH Flush untransmitted output.
283 The <termios.h> header shall define the following symbolic constants
285 for use with tcflow():
286 TCIOFF Transmit a STOP character, intended to suspend input data.
288 TCION Transmit a START character, intended to restart input data.
290 TCOOFF Suspend output.
292 TCOON Restart output.
294 The <termios.h> header shall define the pid_t type as described in
296 <sys/types.h>.
297 The following shall be declared as functions and may also be defined as
299 macros. Function prototypes shall be provided.
300 speed_t cfgetispeed(const struct termios *);
303 speed_t cfgetospeed(const struct termios *);
304 int cfsetispeed(struct termios *, speed_t);
305 int cfsetospeed(struct termios *, speed_t);
306 int tcdrain(int);
307 int tcflow(int, int);
308 int tcflush(int, int);
309 int tcgetattr(int, struct termios *);
310 pid_t tcgetsid(int);
311 int tcsendbreak(int, int);
312 int tcsetattr(int, int, const struct termios *);
313 The following sections are informative.
315
317 The following names are reserved for XSI-conformant systems to use as
318 an extension to the above; therefore strictly conforming applications
319 shall not use them:
320 CBAUD EXTB VDSUSP
322 DEFECHO FLUSHO VLNEXT
323 ECHOCTL LOBLK VREPRINT
324 ECHOKE PENDIN VSTATUS
325 ECHOPRT SWTCH VWERASE
326 EXTA VDISCARD
327
329 None.
330
332 None.
333
335 <sys_types.h>
336 The System Interfaces volume of POSIX.1‐2017, cfgetispeed(), cfge‐
338 tospeed(), cfsetispeed(), cfsetospeed(), confstr(), tcdrain(),
339 tcflow(), tcflush(), tcgetattr(), tcgetsid(), tcsendbreak(), tcse‐
340 tattr()
341 The Shell and Utilities volume of POSIX.1‐2017, Chapter 11, General
343 Terminal Interface, getconf
344
346 Portions of this text are reprinted and reproduced in electronic form
347 from IEEE Std 1003.1-2017, Standard for Information Technology -- Por‐
348 table Operating System Interface (POSIX), The Open Group Base Specifi‐
349 cations Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of
350 Electrical and Electronics Engineers, Inc and The Open Group. In the
351 event of any discrepancy between this version and the original IEEE and
352 The Open Group Standard, the original IEEE and The Open Group Standard
353 is the referee document. The original Standard can be obtained online
354 at http://www.opengroup.org/unix/online.html .
355 Any typographical or formatting errors that appear in this page are
357 most likely to have been introduced during the conversion of the source
358 files to man page format. To report such errors, see https://www.ker‐
359 nel.org/doc/man-pages/reporting_bugs.html .
360IEEE/The Open Group 2017 termios.h(0P)