| blob | 7b2f4f058e9316ededd18e70d9de072e249cda9d |
1 '\" te
2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 .\" http://www.opengroup.org/bookstore/.
5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 .\" This notice shall appear on any product containing this material.
7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
10 .TH TERMIOS.H 3HEAD "Sep 10, 2004"
11 .SH NAME
12 termios.h, termios \- define values for termios
13 .SH SYNOPSIS
14 .LP
15 .nf
16 #include <\fBtermios.h\fR>
17 .fi
19 .SH DESCRIPTION
20 .sp
21 .LP
22 The <\fBtermios.h\fR> header contains the definitions used by the terminal I/O
23 interfaces. See \fBtermios\fR(3C) and \fBtermio\fR(7I) for an overview of the
24 terminal interface.
25 .SS "The termios Structure"
26 .sp
27 .LP
28 The following data types are defined through \fBtypedef\fR:
29 .sp
30 .ne 2
31 .na
32 \fB\fBcc_t\fR\fR
33 .ad
34 .RS 12n
35 used for terminal special characters
36 .RE
38 .sp
39 .ne 2
40 .na
41 \fB\fBspeed_t\fR\fR
42 .ad
43 .RS 12n
44 used for terminal baud rates
45 .RE
47 .sp
48 .ne 2
49 .na
50 \fB\fBtcflag_t\fR\fR
51 .ad
52 .RS 12n
53 used for terminal modes
54 .RE
56 .sp
57 .LP
58 The above types are all unsigned integer types.
59 .sp
60 .LP
61 The implementation supports one or more programming environments in which the
62 widths of \fBcc_t\fR, \fBspeed_t\fR, and \fBtcflag_t\fR are no greater than the
63 width of type \fBlong\fR. The names of these programming environments can be
64 obtained using the \fBconfstr\fR(3C) function or the \fBgetconf\fR(1) utility.
65 .sp
66 .LP
67 The \fBtermios\fR structure is defined and includes the following members:
68 .sp
69 .in +2
70 .nf
71 tcflag_t c_iflag /* input modes */
72 tcflag_t c_oflag /* output modes */
73 tcflag_t c_cflag /* control modes */
74 tcflag_t c_lflag /* local modes */
75 cc_t c_cc[NCCS] /* control characters */
76 .fi
77 .in -2
79 .sp
80 .LP
81 A definition is provided for:
82 .sp
83 .ne 2
84 .na
85 \fB\fBNCCS\fR\fR
86 .ad
87 .RS 8n
88 size of the array \fBc_cc\fR for control characters
89 .RE
91 .sp
92 .LP
93 The following subscript names for the array \fBc_cc\fR are defined:
94 .sp
96 .sp
97 .TS
98 c c c
99 l l l .
100 Subscript UsageCanonical Mode Subscript UsageNon-Canonical Mode Description
101 _
102 \fBVEOF\fR EOF character
103 \fBVEOL\fR EOL character
104 \fBVERASE\fR ERASE character
105 \fBVINTR\fR \fBVINTR\fR INTR character
106 \fBVKILL\fR KILL character
107 \fBVMIN\fR MIN value
108 \fBVQUIT\fR \fBVQUIT\fR QUIT character
109 \fBVSTART\fR \fBVSTART\fR START character
110 \fBVSTOP\fR \fBVSTOP\fR STOP character
111 \fBVSUSP\fR \fBVSUSP\fR SUSP character
112 \fBVTIME\fR TIME value
113 .TE
115 .sp
116 .LP
117 The subscript values are unique, except that the \fBVMIN\fR and \fBVTIME\fR
118 subscripts can have the same values as the \fBVEOF\fR and \fBVEOL\fR
119 subscripts, respectively.
120 .sp
121 .LP
122 The header file provides the flags described below.
123 .SS "Input Modes"
124 .sp
125 .LP
126 The \fBc_iflag\fR field describes the basic terminal input control:
127 .sp
128 .ne 2
129 .na
130 \fB\fBBRKINT\fR\fR
131 .ad
132 .RS 10n
133 Signal interrupt on break.
134 .RE
136 .sp
137 .ne 2
138 .na
139 \fB\fBICRNL\fR\fR
140 .ad
141 .RS 10n
142 Map CR to NL on input.
143 .RE
145 .sp
146 .ne 2
147 .na
148 \fB\fBIGNBRK\fR\fR
149 .ad
150 .RS 10n
151 Ignore break condition.
152 .RE
154 .sp
155 .ne 2
156 .na
157 \fB\fBIGNCR\fR\fR
158 .ad
159 .RS 10n
160 Ignore CR.
161 .RE
163 .sp
164 .ne 2
165 .na
166 \fB\fBIGNPAR\fR\fR
167 .ad
168 .RS 10n
169 Ignore characters with parity errors.
170 .RE
172 .sp
173 .ne 2
174 .na
175 \fB\fBINLCR\fR\fR
176 .ad
177 .RS 10n
178 Map NL to CR on input.
179 .RE
181 .sp
182 .ne 2
183 .na
184 \fB\fBINPCK\fR\fR
185 .ad
186 .RS 10n
187 Enable input parity check.
188 .RE
190 .sp
191 .ne 2
192 .na
193 \fB\fBISTRIP\fR\fR
194 .ad
195 .RS 10n
196 Strip character.
197 .RE
199 .sp
200 .ne 2
201 .na
202 \fB\fBIXANY\fR\fR
203 .ad
204 .RS 10n
205 Enable any character to restart output.
206 .RE
208 .sp
209 .ne 2
210 .na
211 \fB\fBIXOFF\fR\fR
212 .ad
213 .RS 10n
214 Enable start/stop input control.
215 .RE
217 .sp
218 .ne 2
219 .na
220 \fB\fBIXON\fR\fR
221 .ad
222 .RS 10n
223 Enable start/stop output control.
224 .RE
226 .sp
227 .ne 2
228 .na
229 \fB\fBPARMRK\fR\fR
230 .ad
231 .RS 10n
232 Mark parity errors.
233 .RE
235 .SS "Output Modes"
236 .sp
237 .LP
238 The \fBc_oflag\fR field specifies the system treatment of output:
239 .sp
240 .ne 2
241 .na
242 \fB\fBOPOST\fR\fR
243 .ad
244 .RS 10n
245 Post-process output.
246 .RE
248 .sp
249 .ne 2
250 .na
251 \fB\fBONLCR\fR\fR
252 .ad
253 .RS 10n
254 Map NL to CR-NL on output.
255 .RE
257 .sp
258 .ne 2
259 .na
260 \fB\fBOCRNL\fR\fR
261 .ad
262 .RS 10n
263 Map CR to NL on output.
264 .RE
266 .sp
267 .ne 2
268 .na
269 \fB\fBONOCR\fR\fR
270 .ad
271 .RS 10n
272 No CR output at column 0.
273 .RE
275 .sp
276 .ne 2
277 .na
278 \fB\fBONLRET\fR\fR
279 .ad
280 .RS 10n
281 NL performs CR function.
282 .RE
284 .sp
285 .ne 2
286 .na
287 \fB\fBOFILL\fR\fR
288 .ad
289 .RS 10n
290 Use fill characters for delay.
291 .RE
293 .sp
294 .ne 2
295 .na
296 \fB\fBNLDLY\fR\fR
297 .ad
298 .RS 10n
299 Select newline delays:
300 .sp
301 .ne 2
302 .na
303 \fB\fBNL0\fR\fR
304 .ad
305 .RS 7n
306 newline type 0
307 .RE
309 .sp
310 .ne 2
311 .na
312 \fB\fBNL1\fR\fR
313 .ad
314 .RS 7n
315 newline type 1
316 .RE
318 .RE
320 .sp
321 .ne 2
322 .na
323 \fB\fBCRDLY\fR\fR
324 .ad
325 .RS 10n
326 Select carriage-return delays:
327 .sp
328 .ne 2
329 .na
330 \fB\fBCR0\fR\fR
331 .ad
332 .RS 7n
333 carriage-return delay type 0
334 .RE
336 .sp
337 .ne 2
338 .na
339 \fB\fBCR1\fR\fR
340 .ad
341 .RS 7n
342 carriage-return delay type 1
343 .RE
345 .sp
346 .ne 2
347 .na
348 \fB\fBCR2\fR\fR
349 .ad
350 .RS 7n
351 carriage-return delay type 2
352 .RE
354 .sp
355 .ne 2
356 .na
357 \fB\fBCR3\fR\fR
358 .ad
359 .RS 7n
360 carriage-return delay type 3
361 .RE
363 .RE
365 .sp
366 .ne 2
367 .na
368 \fB\fBTABDLY\fR\fR
369 .ad
370 .RS 10n
371 Select horizontal-tab delays:
372 .sp
373 .ne 2
374 .na
375 \fB\fBTAB0\fR\fR
376 .ad
377 .RS 8n
378 horizontal-tab delay type 0
379 .RE
381 .sp
382 .ne 2
383 .na
384 \fB\fBTAB1\fR\fR
385 .ad
386 .RS 8n
387 horizontal-tab delay type 1
388 .RE
390 .sp
391 .ne 2
392 .na
393 \fB\fBTAB2\fR\fR
394 .ad
395 .RS 8n
396 horizontal-tab delay type 2
397 .RE
399 .sp
400 .ne 2
401 .na
402 \fB\fBTAB3\fR\fR
403 .ad
404 .RS 8n
405 expand tabs to spaces
406 .RE
408 .RE
410 .sp
411 .ne 2
412 .na
413 \fB\fBBSDLY\fR\fR
414 .ad
415 .RS 10n
416 Select backspace delays:
417 .sp
418 .ne 2
419 .na
420 \fB\fBBS0\fR\fR
421 .ad
422 .RS 7n
423 backspace-delay type 0
424 .RE
426 .sp
427 .ne 2
428 .na
429 \fB\fBBS1\fR\fR
430 .ad
431 .RS 7n
432 backspace-delay type 1
433 .RE
435 .RE
437 .sp
438 .ne 2
439 .na
440 \fB\fBVTDLY\fR\fR
441 .ad
442 .RS 10n
443 Select vertical-tab delays:
444 .sp
445 .ne 2
446 .na
447 \fB\fBVT0\fR\fR
448 .ad
449 .RS 7n
450 vertical-tab delay type 0
451 .RE
453 .sp
454 .ne 2
455 .na
456 \fB\fBVT1\fR\fR
457 .ad
458 .RS 7n
459 vertical-tab delay type 1
460 .RE
462 .RE
464 .sp
465 .ne 2
466 .na
467 \fB\fBFFDLY\fR\fR
468 .ad
469 .RS 10n
470 Select form-feed delays:
471 .sp
472 .ne 2
473 .na
474 \fB\fBFF0\fR\fR
475 .ad
476 .RS 7n
477 form-feed delay type 0
478 .RE
480 .sp
481 .ne 2
482 .na
483 \fB\fBFF1\fR\fR
484 .ad
485 .RS 7n
486 form-feed delay type 1
487 .RE
489 .RE
491 .SS "Baud Rate Selection"
492 .sp
493 .LP
494 The input and output baud rates are stored in the \fBtermios\fR structure.
495 These are the valid values for objects of type \fBspeed_ t\fR. The following
496 values are defined, but not all baud rates need be supported by the underlying
497 hardware.
498 .sp
499 .ne 2
500 .na
501 \fB\fBB0\fR\fR
502 .ad
503 .RS 10n
504 Hang up
505 .RE
507 .sp
508 .ne 2
509 .na
510 \fB\fBB50\fR\fR
511 .ad
512 .RS 10n
513 50 baud
514 .RE
516 .sp
517 .ne 2
518 .na
519 \fB\fBB75\fR\fR
520 .ad
521 .RS 10n
522 75 baud
523 .RE
525 .sp
526 .ne 2
527 .na
528 \fB\fBB110\fR\fR
529 .ad
530 .RS 10n
531 110 baud
532 .RE
534 .sp
535 .ne 2
536 .na
537 \fB\fBB134\fR\fR
538 .ad
539 .RS 10n
540 134.5 baud
541 .RE
543 .sp
544 .ne 2
545 .na
546 \fB\fBB150\fR\fR
547 .ad
548 .RS 10n
549 150 baud
550 .RE
552 .sp
553 .ne 2
554 .na
555 \fB\fBB200\fR\fR
556 .ad
557 .RS 10n
558 200 baud
559 .RE
561 .sp
562 .ne 2
563 .na
564 \fB\fBB300\fR\fR
565 .ad
566 .RS 10n
567 300 baud
568 .RE
570 .sp
571 .ne 2
572 .na
573 \fB\fBB600\fR\fR
574 .ad
575 .RS 10n
576 600 baud
577 .RE
579 .sp
580 .ne 2
581 .na
582 \fB\fBB1200\fR\fR
583 .ad
584 .RS 10n
585 1 200 baud
586 .RE
588 .sp
589 .ne 2
590 .na
591 \fB\fBB1800\fR\fR
592 .ad
593 .RS 10n
594 1 800 baud
595 .RE
597 .sp
598 .ne 2
599 .na
600 \fB\fBB2400\fR\fR
601 .ad
602 .RS 10n
603 2 400 baud
604 .RE
606 .sp
607 .ne 2
608 .na
609 \fB\fBB4800\fR\fR
610 .ad
611 .RS 10n
612 4 800 baud
613 .RE
615 .sp
616 .ne 2
617 .na
618 \fB\fBB9600\fR\fR
619 .ad
620 .RS 10n
621 9 600 baud
622 .RE
624 .sp
625 .ne 2
626 .na
627 \fB\fBB19200\fR\fR
628 .ad
629 .RS 10n
630 19 200 baud
631 .RE
633 .sp
634 .ne 2
635 .na
636 \fB\fBB38400\fR\fR
637 .ad
638 .RS 10n
639 38 400 baud
640 .RE
642 .SS "Control Modes"
643 .sp
644 .LP
645 The \fBc_cflag\fR field describes the hardware control of the terminal; not all
646 values specified are required to be supported by the underlying hardware:
647 .sp
648 .ne 2
649 .na
650 \fB\fBCSIZE\fR\fR
651 .ad
652 .RS 10n
653 Character size:
654 .sp
655 .ne 2
656 .na
657 \fB\fBCS5\fR\fR
658 .ad
659 .RS 7n
660 5 bits
661 .RE
663 .sp
664 .ne 2
665 .na
666 \fB\fBCS6\fR\fR
667 .ad
668 .RS 7n
669 6 bits
670 .RE
672 .sp
673 .ne 2
674 .na
675 \fB\fBCS7\fR\fR
676 .ad
677 .RS 7n
678 7 bits
679 .RE
681 .sp
682 .ne 2
683 .na
684 \fB\fBCS8\fR\fR
685 .ad
686 .RS 7n
687 8 bits
688 .RE
690 .RE
692 .sp
693 .ne 2
694 .na
695 \fB\fBCSTOPB\fR\fR
696 .ad
697 .RS 10n
698 Send two stop bits, else one.
699 .RE
701 .sp
702 .ne 2
703 .na
704 \fB\fBCREAD\fR\fR
705 .ad
706 .RS 10n
707 Enable receiver.
708 .RE
710 .sp
711 .ne 2
712 .na
713 \fB\fBPARENB\fR\fR
714 .ad
715 .RS 10n
716 Parity enable.
717 .RE
719 .sp
720 .ne 2
721 .na
722 \fB\fBPARODD\fR\fR
723 .ad
724 .RS 10n
725 Odd parity, else even.
726 .RE
728 .sp
729 .ne 2
730 .na
731 \fB\fBHUPCL\fR\fR
732 .ad
733 .RS 10n
734 Hang up on last close.
735 .RE
737 .sp
738 .ne 2
739 .na
740 \fB\fBCLOCAL\fR\fR
741 .ad
742 .RS 10n
743 Ignore modem status lines.
744 .RE
746 .sp
747 .LP
748 The implementation supports the functionality associated with the symbols
749 \fBCS7\fR, \fBCS8\fR, \fBCSTOPB\fR, \fBPARODD\fR, and \fBPARENB\fR.
750 .SS "Local Modes"
751 .sp
752 .LP
753 The \fBc_lflag\fR field of the argument structure is used to control various
754 terminal functions:
755 .sp
756 .ne 2
757 .na
758 \fB\fBECHO\fR\fR
759 .ad
760 .RS 10n
761 Enable echo.
762 .RE
764 .sp
765 .ne 2
766 .na
767 \fB\fBECHOE\fR\fR
768 .ad
769 .RS 10n
770 Echo erase character as error-correcting backspace.
771 .RE
773 .sp
774 .ne 2
775 .na
776 \fB\fBECHOK\fR\fR
777 .ad
778 .RS 10n
779 Echo KILL.
780 .RE
782 .sp
783 .ne 2
784 .na
785 \fB\fBECHONL\fR\fR
786 .ad
787 .RS 10n
788 Echo NL.
789 .RE
791 .sp
792 .ne 2
793 .na
794 \fB\fBICANON\fR\fR
795 .ad
796 .RS 10n
797 Canonical input (erase and kill processing).
798 .RE
800 .sp
801 .ne 2
802 .na
803 \fB\fBIEXTEN\fR\fR
804 .ad
805 .RS 10n
806 Enable extended input character processing.
807 .RE
809 .sp
810 .ne 2
811 .na
812 \fB\fBISIG\fR\fR
813 .ad
814 .RS 10n
815 Enable signals.
816 .RE
818 .sp
819 .ne 2
820 .na
821 \fB\fBNOFLSH\fR\fR
822 .ad
823 .RS 10n
824 Disable flush after interrupt or quit.
825 .RE
827 .sp
828 .ne 2
829 .na
830 \fB\fBTOSTOP\fR\fR
831 .ad
832 .RS 10n
833 Send \fBSIGTTOU\fR for background output.
834 .RE
836 .SS "Attribute Selection"
837 .sp
838 .LP
839 The following symbolic constants for use with \fBtcsetattr()\fR are defined:
840 .sp
841 .ne 2
842 .na
843 \fB\fBTCSANOW\fR\fR
844 .ad
845 .RS 13n
846 Change attributes immediately.
847 .RE
849 .sp
850 .ne 2
851 .na
852 \fB\fBTCSADRAIN\fR\fR
853 .ad
854 .RS 13n
855 Change attributes when output has drained.
856 .RE
858 .sp
859 .ne 2
860 .na
861 \fB\fBTCSAFLUSH\fR\fR
862 .ad
863 .RS 13n
864 Change attributes when output has drained; also flush pending input.
865 .RE
867 .SS "Line Control"
868 .sp
869 .LP
870 The following symbolic constants for use with \fBtcflush()\fR are defined:
871 .sp
872 .ne 2
873 .na
874 \fB\fBTCIFLUSH\fR\fR
875 .ad
876 .RS 13n
877 Flush pending input.
878 .RE
880 .sp
881 .ne 2
882 .na
883 \fB\fBTCIOFLUSH\fR\fR
884 .ad
885 .RS 13n
886 Flush both pending input and untransmitted output.
887 .RE
889 .sp
890 .ne 2
891 .na
892 \fB\fBTCOFLUSH\fR\fR
893 .ad
894 .RS 13n
895 Flush untransmitted output.
896 .RE
898 .sp
899 .LP
900 The following symbolic constants for use with \fBtcflow()\fR are defined:
901 .sp
902 .ne 2
903 .na
904 \fB\fBTCIOFF\fR\fR
905 .ad
906 .RS 10n
907 Transmit a \fBSTOP\fR character, intended to suspend input data.
908 .RE
910 .sp
911 .ne 2
912 .na
913 \fB\fBTCION\fR\fR
914 .ad
915 .RS 10n
916 Transmit a \fBSTART\fR character, intended to restart input data.
917 .RE
919 .sp
920 .ne 2
921 .na
922 \fB\fBTCOOFF\fR\fR
923 .ad
924 .RS 10n
925 Suspend output.
926 .RE
928 .sp
929 .ne 2
930 .na
931 \fB\fBTCOON\fR\fR
932 .ad
933 .RS 10n
934 Restart output.
935 .RE
937 .SH ATTRIBUTES
938 .sp
939 .LP
940 See \fBattributes\fR(5) for descriptions of the following attributes:
941 .sp
943 .sp
944 .TS
945 box;
946 c | c
947 l | l .
948 ATTRIBUTE TYPE ATTRIBUTE VALUE
949 _
950 Interface Stability Standard
951 .TE
953 .SH SEE ALSO
954 .sp
955 .LP
956 \fBgetconf\fR(1), \fBcfgetispeed\fR(3C), \fBcfsetispeed\fR(3C),
957 \fBconfstr\fR(3C), \fBtcdrain\fR(3C), \fBtcflow\fR(3C), \fBtcflush\fR(3C),
958 \fBtcgetattr\fR(3C), \fBtcgetsid\fR(3C), \fBtcsendbreak\fR(3C),
959 \fBtcsetattr\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)