| blob | 16e0fdf043397df150b3f7e1df2ea8a1716d5a11 |
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document. The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright 1989 AT&T
44 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
45 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
46 .\" Copyright (c) 2014, Joyent, Inc. All Rights Reserved
47 .\"
48 .TH STTY 1 "Oct 25, 2017"
49 .SH NAME
50 stty \- set the options for a terminal
51 .SH SYNOPSIS
52 .LP
53 .nf
54 \fB/usr/bin/stty\fR [\fB-a\fR | \fB-g\fR]
55 .fi
57 .LP
58 .nf
59 \fB/usr/bin/stty\fR [\fImodes\fR]
60 .fi
62 .SH DESCRIPTION
63 .LP
64 The \fBstty\fR utility sets certain terminal I/O options for the device that is
65 the current standard input. Without arguments, \fBstty\fR reports the settings
66 of certain options.
67 .sp
68 .LP
69 In this report, if a character is preceded by a caret (\fB^\fR), then the value
70 of that option is the corresponding control character (for example, \fB^h\fR is
71 CTRL-h. In this case, recall that CTRL-h is the same as the BACKSPACE key). The
72 sequence \fB^@\fR means that an option has a null value.
73 .sp
74 .LP
75 See \fBtermio\fR(7I) for detailed information about the modes listed from
76 \fBControl\fR \fBModes\fR through \fBLocal Modes\fR. For detailed information
77 about the modes listed under \fBHardware\fR \fBFlow\fR \fBControl\fR
78 \fBModes\fR and \fBClock Modes\fR, see \fBtermiox\fR(7I).
79 .sp
80 .LP
81 Operands described in the \fBCombination Modes\fR section are implemented using
82 options in the earlier sections. Notice that many combinations of options make
83 no sense, but no sanity checking is performed. Hardware flow control and clock
84 modes options might not be supported by all hardware interfaces.
85 .SH OPTIONS
86 .LP
87 The following options are supported:
88 .sp
89 .ne 2
90 .na
91 \fB\fB-a\fR\fR
92 .ad
93 .RS 6n
94 Writes to standard output all of the option settings for the terminal.
95 .RE
97 .sp
98 .ne 2
99 .na
100 \fB\fB-g\fR\fR
101 .ad
102 .RS 6n
103 Reports current settings in a form that can be used as an argument to another
104 \fBstty\fR command. Emits termios-type output if the underlying driver supports
105 it. Otherwise, it emits termio-type output.
106 .RE
108 .SH OPERANDS
109 .LP
110 The following \fImode\fR operands are supported:
111 .SS "Control Modes"
112 .ne 2
113 .na
114 \fB\fBparenb\fR(\fB-parenb\fR)\fR
115 .ad
116 .RS 24n
117 Enable (disable) parity generation and detection.
118 .RE
120 .sp
121 .ne 2
122 .na
123 \fB\fBparext\fR(\fB-parext\fR)\fR
124 .ad
125 .RS 24n
126 Enable (disable) extended parity generation and detection for mark and space
127 parity.
128 .RE
130 .sp
131 .ne 2
132 .na
133 \fB\fBparodd\fR(\fB-parodd\fR)\fR
134 .ad
135 .RS 24n
136 Select odd (even) parity, or mark (space) parity if \fBparext\fR is enabled.
137 .RE
139 .sp
140 .ne 2
141 .na
142 \fB\fBcs5\fR \fBcs6\fR \fBcs7\fR \fBcs8\fR\fR
143 .ad
144 .RS 24n
145 Select character size (see \fBtermio\fR(7I)).
146 .RE
148 .sp
149 .ne 2
150 .na
151 \fB\fB0\fR\fR
152 .ad
153 .RS 24n
154 Hang up line immediately.
155 .RE
157 .sp
158 .ne 2
159 .na
160 \fB\fBhupcl\fR (\fB-hupcl\fR)\fR
161 .ad
162 .RS 24n
163 Hang up (do not hang up) connection on last close.
164 .RE
166 .sp
167 .ne 2
168 .na
169 \fB\fBhup\fR (\fB-hup\fR)\fR
170 .ad
171 .RS 24n
172 Same as \fBhupcl\fR(\fB-hupcl\fR).
173 .RE
175 .sp
176 .ne 2
177 .na
178 \fB\fBcstopb\fR (\fB-cstopb\fR)\fR
179 .ad
180 .RS 24n
181 Use two (one) stop bits per character.
182 .RE
184 .sp
185 .ne 2
186 .na
187 \fB\fBcread\fR (\fB-cread\fR)\fR
188 .ad
189 .RS 24n
190 Enable (disable) the receiver.
191 .RE
193 .sp
194 .ne 2
195 .na
196 \fB\fBcrtscts\fR (\fB-crtscts\fR)\fR
197 .ad
198 .RS 24n
199 Enable output hardware flow control. Raise the \fBRTS\fR (Request to Send)
200 modem control line. Suspends output until the CTS (Clear to Send) line is
201 raised.
202 .RE
204 .sp
205 .ne 2
206 .na
207 \fB\fBcrtsxoff\fR (\fB-crtsxoff\fR)\fR
208 .ad
209 .RS 24n
210 Enable input hardware flow control. Raise the \fBRTS\fR (Request to Send) modem
211 control line to receive data. Suspends input when RTS is low.
212 .RE
214 .sp
215 .ne 2
216 .na
217 \fB\fBclocal\fR (\fB-clocal\fR)\fR
218 .ad
219 .RS 24n
220 Assume a line without (with) modem control.
221 .RE
223 .sp
224 .ne 2
225 .na
226 \fB\fBdefeucw\fR\fR
227 .ad
228 .RS 24n
229 Set the widths of multibyte characters to the values defined in the current
230 locale specified by \fBLC_CTYPE\fR. Internally, width is expressed in terms of
231 bytes per character, and screen or display columns per character.
232 .RE
234 .sp
235 .ne 2
236 .na
237 \fB110 300 600 1200 1800\fR
238 .ad
239 .br
240 .na
241 \fB2400 4800 9600 19200\fR
242 .ad
243 .br
244 .na
245 \fB38400 357600 76800 115200\fR
246 .ad
247 .br
248 .na
249 \fB153600 230400 307200 460800\fR
250 .ad
251 .sp .6
252 .RS 4n
253 Set terminal baud rate to the number given, if possible. (All speeds are not
254 supported by all hardware interfaces.)
255 .RE
257 .sp
258 .ne 2
259 .na
260 \fBispeed 0 110 300 600 1200\fR
261 .ad
262 .br
263 .na
264 \fB1800 2400 4800 9600 19200\fR
265 .ad
266 .br
267 .na
268 \fB38400 57600 76800 115200\fR
269 .ad
270 .br
271 .na
272 \fB153600 230400 307200 460800\fR
273 .ad
274 .sp .6
275 .RS 4n
276 Set terminal input baud rate to the number given, if possible. (Not all
277 hardware supports split baud rates.) If the input baud rate is set to \fB0\fR,
278 the input baud rate is specified by the value of the output baud rate.
279 .RE
281 .sp
282 .ne 2
283 .na
284 \fBospeed 0 110 300 600 1200\fR
285 .ad
286 .br
287 .na
288 \fB1800 2400 4800 9600 19200\fR
289 .ad
290 .br
291 .na
292 \fB38400 57600 76800 115200\fR
293 .ad
294 .br
295 .na
296 \fB153600 230400 307200 460800\fR
297 .ad
298 .sp .6
299 .RS 4n
300 Set terminal output baud rate to the number given, if possible. (Not all
301 hardware supports split baud rates.) If the output baud rate is set to \fB0\fR,
302 the line is hung up immediately.
303 .RE
305 .SS "Input Modes"
306 .ne 2
307 .na
308 \fB\fBignbrk\fR (\fB-ignbrk\fR)\fR
309 .ad
310 .RS 22n
311 Ignore (do not ignore) break on input.
312 .RE
314 .sp
315 .ne 2
316 .na
317 \fB\fBbrkint\fR (\fB-brkint\fR)\fR
318 .ad
319 .RS 22n
320 Signal (do not signal) INTR on break.
321 .RE
323 .sp
324 .ne 2
325 .na
326 \fB\fBignpar\fR (\fB-ignpar\fR)\fR
327 .ad
328 .RS 22n
329 Ignore (do not ignore) parity errors.
330 .RE
332 .sp
333 .ne 2
334 .na
335 \fB\fBparmrk\fR (\fB-parmrk\fR)\fR
336 .ad
337 .RS 22n
338 Mark (do not mark) parity errors (see \fBtermio\fR(7I)).
339 .RE
341 .sp
342 .ne 2
343 .na
344 \fB\fBinpck\fR (\fB-inpck\fR)\fR
345 .ad
346 .RS 22n
347 Enable (disable) input parity checking.
348 .RE
350 .sp
351 .ne 2
352 .na
353 \fB\fBistrip\fR (\fB-istrip\fR)\fR
354 .ad
355 .RS 22n
356 Strip (do not strip) input characters to seven bits.
357 .RE
359 .sp
360 .ne 2
361 .na
362 \fB\fBinlcr\fR (\fB-inlcr\fR)\fR
363 .ad
364 .RS 22n
365 Map (do not map) NL to CR on input.
366 .RE
368 .sp
369 .ne 2
370 .na
371 \fB\fBigncr\fR (\fB-igncr\fR)\fR
372 .ad
373 .RS 22n
374 Ignore (do not ignore) CR on input.
375 .RE
377 .sp
378 .ne 2
379 .na
380 \fB\fBicrnl\fR (\fB-icrnl\fR)\fR
381 .ad
382 .RS 22n
383 Map (do not map) CR to NL on input.
384 .RE
386 .sp
387 .ne 2
388 .na
389 \fB\fBiuclc\fR (\fB-iuclc\fR)\fR
390 .ad
391 .RS 22n
392 Map (do not map) upper-case alphabetics to lower case on input.
393 .RE
395 .sp
396 .ne 2
397 .na
398 \fB\fBixon\fR (\fB-ixon\fR)\fR
399 .ad
400 .RS 22n
401 Enable (disable) START/STOP output control. Output is stopped by sending STOP
402 control character and started by sending the START control character.
403 .RE
405 .sp
406 .ne 2
407 .na
408 \fB\fBixany\fR (\fB-ixany\fR)\fR
409 .ad
410 .RS 22n
411 Allow any character (only DC1) to restart output.
412 .RE
414 .sp
415 .ne 2
416 .na
417 \fB\fBixoff\fR (\fB-ixoff\fR)\fR
418 .ad
419 .RS 22n
420 Request that the system send (not send) START/STOP characters when the input
421 queue is nearly empty/full.
422 .RE
424 .sp
425 .ne 2
426 .na
427 \fB\fBimaxbel\fR (\fB-imaxbel\fR)\fR
428 .ad
429 .RS 22n
430 Echo (do not echo) \fBBEL\fR when the input line is too long. If \fBimaxbel\fR
431 is set, the \fBASCII BEL\fR character (\fB07 hex\fR) is echoed if the input
432 stream overflows. Further input is not stored, but any input already present
433 is not disturbed. If \fB-imaxbel\fR is set, no \fBBEL\fR character is echoed,
434 and all unread input present in the input queue is discarded if the input
435 stream overflows.
436 .RE
438 .SS "Output Modes"
439 .ne 2
440 .na
441 \fB\fBopost\fR (\fB-opost\fR)\fR
442 .ad
443 .RS 23n
444 Post-process output (do not post-process output; ignore all other output
445 modes).
446 .RE
448 .sp
449 .ne 2
450 .na
451 \fB\fBolcuc\fR (\fB-olcuc\fR)\fR
452 .ad
453 .RS 23n
454 Map (do not map) lower-case alphabetics to upper case on output.
455 .RE
457 .sp
458 .ne 2
459 .na
460 \fB\fBonlcr\fR (\fB-onlcr\fR)\fR
461 .ad
462 .RS 23n
463 Map (do not map) NL to CR-NL on output.
464 .RE
466 .sp
467 .ne 2
468 .na
469 \fB\fBocrnl\fR (\fB-ocrnl\fR)\fR
470 .ad
471 .RS 23n
472 Map (do not map) CR to NL on output.
473 .RE
475 .sp
476 .ne 2
477 .na
478 \fB\fBonocr\fR (\fB-onocr\fR)\fR
479 .ad
480 .RS 23n
481 Do not (do) output CRs at column zero.
482 .RE
484 .sp
485 .ne 2
486 .na
487 \fB\fBonlret\fR (\fB-onlret\fR)\fR
488 .ad
489 .RS 23n
490 On the terminal NL performs (does not perform) the CR function.
491 .RE
493 .sp
494 .ne 2
495 .na
496 \fB\fBofill\fR (\fB-ofill\fR)\fR
497 .ad
498 .RS 23n
499 Use fill characters (use timing) for delays.
500 .RE
502 .sp
503 .ne 2
504 .na
505 \fB\fBofdel\fR (\fB-ofdel\fR)\fR
506 .ad
507 .RS 23n
508 Fill characters are DELs (NULs).
509 .RE
511 .sp
512 .ne 2
513 .na
514 \fB\fBcr0 cr1 cr2 cr3\fR\fR
515 .ad
516 .RS 23n
517 Select style of delay for carriage returns (see \fBtermio\fR(7I)).
518 .RE
520 .sp
521 .ne 2
522 .na
523 \fB\fBnl0 nl1\fR\fR
524 .ad
525 .RS 23n
526 Select style of delay for line-feeds (see \fBtermio\fR(7I)).
527 .RE
529 .sp
530 .ne 2
531 .na
532 \fB\fBtab0 tab1 tab2 tab3\fR\fR
533 .ad
534 .RS 23n
535 Select style of delay for horizontal tabs (see \fBtermio\fR(7I)).
536 .RE
538 .sp
539 .ne 2
540 .na
541 \fB\fBbs0 bs1\fR\fR
542 .ad
543 .RS 23n
544 Select style of delay for backspaces (see \fBtermio\fR(7I)).
545 .RE
547 .sp
548 .ne 2
549 .na
550 \fB\fBff0 ff1\fR\fR
551 .ad
552 .RS 23n
553 Select style of delay for form-feeds (see \fBtermio\fR(7I)).
554 .RE
556 .sp
557 .ne 2
558 .na
559 \fB\fBvt0 vt1\fR\fR
560 .ad
561 .RS 23n
562 Select style of delay for vertical tabs (see \fBtermio\fR(7I)).
563 .RE
565 .SS "Local Modes"
566 .ne 2
567 .na
568 \fB\fBisig\fR(\fB-isig\fR)\fR
569 .ad
570 .RS 22n
571 Enable (disable) the checking of characters against the special control
572 characters INTR, QUIT, SWTCH, and SUSP. For information on \fBSWTCH\fR, see
573 \fBNOTES\fR.
574 .RE
576 .sp
577 .ne 2
578 .na
579 \fB\fBicanon\fR (\fB-icanon\fR)\fR
580 .ad
581 .RS 22n
582 Enable (disable) canonical input (ERASE and KILL processing). Does not set
583 \fBMIN\fR or \fBTIME\fR.
584 .RE
586 .sp
587 .ne 2
588 .na
589 \fB\fBxcase\fR (\fB-xcase\fR)\fR
590 .ad
591 .RS 22n
592 Canonical (unprocessed) upper/lower-case presentation.
593 .RE
595 .sp
596 .ne 2
597 .na
598 \fB\fBecho\fR (\fB-echo\fR)\fR
599 .ad
600 .RS 22n
601 Echo back (do not echo back) every character typed.
602 .RE
604 .sp
605 .ne 2
606 .na
607 \fB\fBechoe\fR (\fB-echoe\fR)\fR
608 .ad
609 .RS 22n
610 Echo (do not echo) ERASE character as a backspace-space-backspace string. This
611 mode erases the ERASEed character on many CRT terminals; however, it does not
612 keep track of column position and, as a result, it might be confusing for
613 escaped characters, tabs, and backspaces.
614 .RE
616 .sp
617 .ne 2
618 .na
619 \fB\fBechok\fR(\fB-echok\fR)\fR
620 .ad
621 .RS 22n
622 Echo (do not echo) NL after KILL character.
623 .RE
625 .sp
626 .ne 2
627 .na
628 \fB\fBlfkc\fR (\fB-lfkc\fR)\fR
629 .ad
630 .RS 22n
631 The same as \fBechok\fR(\fB-echok\fR); obsolete.
632 .RE
634 .sp
635 .ne 2
636 .na
637 \fB\fBechonl\fR (\fB-echonl\fR)\fR
638 .ad
639 .RS 22n
640 Echo (do not echo) NL.
641 .RE
643 .sp
644 .ne 2
645 .na
646 \fB\fBnoflsh\fR (\fB-noflsh\fR)\fR
647 .ad
648 .RS 22n
649 Disable (enable) flush after INTR, QUIT, or SUSP.
650 .RE
652 .sp
653 .ne 2
654 .na
655 \fB\fBstwrap\fR (\fB-stwrap\fR)\fR
656 .ad
657 .RS 22n
658 Disable (enable) truncation of lines longer than \fB79\fR characters on a
659 synchronous line.
660 .RE
662 .sp
663 .ne 2
664 .na
665 \fB\fBtostop\fR (\fB-tostop\fR)\fR
666 .ad
667 .RS 22n
668 Send (do not send) \fBSIGTTOU\fR when background processes write to the
669 terminal.
670 .RE
672 .sp
673 .ne 2
674 .na
675 \fB\fBechoctl\fR \fB(\fR\fB-echoctl\fR\fB)\fR\fR
676 .ad
677 .RS 22n
678 Echo (do not echo) control characters as \fB^\fR\fIchar,\fR delete as \fB^?\fR.
679 .RE
681 .sp
682 .ne 2
683 .na
684 \fB\fBechoprt\fR \fB(\fR\fB-echoprt\fR\fB)\fR\fR
685 .ad
686 .RS 22n
687 Echo (do not echo) erase character as character is ``erased''.
688 .RE
690 .sp
691 .ne 2
692 .na
693 \fB\fBechoke\fR \fB(\fR\fB-echoke\fR\fB)\fR\fR
694 .ad
695 .RS 22n
696 BS-SP-BS erase (do not BS-SP-BS erase) entire line on line kill.
697 .RE
699 .sp
700 .ne 2
701 .na
702 \fB\fBflusho\fR \fB(\fR\fB-flusho\fR\fB)\fR\fR
703 .ad
704 .RS 22n
705 Output is (is not) being flushed.
706 .RE
708 .sp
709 .ne 2
710 .na
711 \fB\fBpendin\fR \fB(\fR\fB-pendin\fR\fB)\fR\fR
712 .ad
713 .RS 22n
714 Retype (do not retype) pending input at next read or input character.
715 .RE
717 .sp
718 .ne 2
719 .na
720 \fB\fBiexten\fR \fB(\fR\fB-iexten\fR\fB)\fR\fR
721 .ad
722 .RS 22n
723 Enable (disable) special control characters not currently controlled by
724 \fBicanon\fR, \fBisig\fR, \fBixon\fR, or \fBixoff\fR: \fBVEOL\fR, \fBVSWTCH\fR,
725 \fBVREPRINT\fR, \fBVDISCARD\fR, \fBVDSUSP\fR, \fBVWERASE\fR, \fBand\fR
726 \fBVLNEXT\fR.
727 .RE
729 .sp
730 .ne 2
731 .na
732 \fB\fBstflush\fR \fB(\fR\fB-stflush\fR)\fR
733 .ad
734 .RS 22n
735 Enable (disable) flush on a synchronous line after every \fBwrite\fR(2).
736 .RE
738 .sp
739 .ne 2
740 .na
741 \fB\fBstappl\fR \fB(\fR\fB-stappl\fR)\fR
742 .ad
743 .RS 22n
744 Use application mode (use line mode) on a synchronous line.
745 .RE
747 .SS "Hardware Flow Control Modes"
748 .ne 2
749 .na
750 \fB\fBrtsxoff\fR (\fB-rtsxoff\fR)\fR
751 .ad
752 .RS 22n
753 Enable (disable) RTS hardware flow control on input.
754 .RE
756 .sp
757 .ne 2
758 .na
759 \fB\fBctsxon\fR (\fB-ctsxon\fR)\fR
760 .ad
761 .RS 22n
762 Enable (disable) CTS hardware flow control on output.
763 .RE
765 .sp
766 .ne 2
767 .na
768 \fB\fBdtrxoff\fR (\fB-dtrxoff\fR)\fR
769 .ad
770 .RS 22n
771 Enable (disable) DTR hardware flow control on input.
772 .RE
774 .sp
775 .ne 2
776 .na
777 \fB\fBcdxon\fR (\fB-cdxon\fR)\fR
778 .ad
779 .RS 22n
780 Enable (disable) CD hardware flow control on output.
781 .RE
783 .sp
784 .ne 2
785 .na
786 \fB\fBisxoff\fR (\fB-isxoff\fR)\fR
787 .ad
788 .RS 22n
789 Enable (disable) isochronous hardware flow control on input.
790 .RE
792 .SS "Clock Modes"
793 .ne 2
794 .na
795 \fB\fBxcibrg\fR\fR
796 .ad
797 .RS 13n
798 Get transmit clock from internal baud rate generator.
799 .RE
801 .sp
802 .ne 2
803 .na
804 \fB\fBxctset\fR\fR
805 .ad
806 .RS 13n
807 Get the transmit clock from transmitter signal element timing (DCE source)
808 lead, CCITT V.24 circuit 114, EIA-232-D pin 15.
809 .RE
811 .sp
812 .ne 2
813 .na
814 \fB\fBxcrset\fR\fR
815 .ad
816 .RS 13n
817 Get transmit clock from receiver signal element timing (DCE source) lead, CCITT
818 V.24 circuit 115, EIA-232-D pin 17.
819 .RE
821 .sp
822 .ne 2
823 .na
824 \fB\fBrcibrg\fR\fR
825 .ad
826 .RS 13n
827 Get receive clock from internal baud rate generator.
828 .RE
830 .sp
831 .ne 2
832 .na
833 \fB\fBrctset\fR\fR
834 .ad
835 .RS 13n
836 Get receive clock from transmitter signal element timing (DCE source) lead,
837 CCITT V.24 circuit 114, EIA-232-D pin 15.
838 .RE
840 .sp
841 .ne 2
842 .na
843 \fB\fBrcrset\fR\fR
844 .ad
845 .RS 13n
846 Get receive clock from receiver signal element timing (DCE source) lead, CCITT
847 V.24 circuit 115, EIA-232-D pin 17.
848 .RE
850 .sp
851 .ne 2
852 .na
853 \fB\fBtsetcoff\fR\fR
854 .ad
855 .RS 13n
856 Transmitter signal element timing clock not provided.
857 .RE
859 .sp
860 .ne 2
861 .na
862 \fB\fBtsetcrbrg\fR\fR
863 .ad
864 .RS 13n
865 Output receive baud rate generator on transmitter signal element timing (DTE
866 source) lead, CCITT V.24 circuit 113, EIA-232-D pin 24.
867 .RE
869 .sp
870 .ne 2
871 .na
872 \fB\fBtsetctbrg\fR\fR
873 .ad
874 .RS 13n
875 Output transmit baud rate generator on transmitter signal element timing (DTE
876 source) lead, CCITT V.24 circuit 113, EIA-232-D pin 24.
877 .RE
879 .sp
880 .ne 2
881 .na
882 \fB\fBtsetctset\fR\fR
883 .ad
884 .RS 13n
885 Output transmitter signal element timing (DCE source) on transmitter signal
886 element timing (DTE source) lead, CCITT V.24 circuit 113, EIA-232-D pin 24.
887 .RE
889 .sp
890 .ne 2
891 .na
892 \fB\fBtsetcrset\fR\fR
893 .ad
894 .RS 13n
895 Output receiver signal element timing (DCE source) on transmitter signal
896 element timing (DTE source) lead, CCITT V.24 circuit 113, EIA-232-D pin 24.
897 .RE
899 .sp
900 .ne 2
901 .na
902 \fB\fBrsetcoff\fR\fR
903 .ad
904 .RS 13n
905 Receiver signal element timing clock not provided.
906 .RE
908 .sp
909 .ne 2
910 .na
911 \fB\fBrsetcrbrg\fR\fR
912 .ad
913 .RS 13n
914 Output receive baud rate generator on receiver signal element timing (DTE
915 source) lead, CCITT V.24 circuit 128, no EIA-232-D pin.
916 .RE
918 .sp
919 .ne 2
920 .na
921 \fB\fBrsetctbrg\fR\fR
922 .ad
923 .RS 13n
924 Output transmit baud rate generator on receiver signal element timing (DTE
925 source) lead, CCITT V.24 circuit 128, no EIA-232-D pin.
926 .RE
928 .sp
929 .ne 2
930 .na
931 \fB\fBrsetctset\fR\fR
932 .ad
933 .RS 13n
934 Output transmitter signal element timing (DCE source) on receiver signal
935 element timing (DTE source) lead, CCITT V.24 circuit 128, no EIA-232-D pin.
936 .RE
938 .sp
939 .ne 2
940 .na
941 \fB\fBrsetcrset\fR\fR
942 .ad
943 .RS 13n
944 Output receiver signal element timing (DCE source) on receiver signal element
945 timing (DTE source) lead, CCITT V.24 circuit 128, no EIA-232-D pin.
946 .RE
948 .SS "Control Assignments"
949 .ne 2
950 .na
951 \fB\fIcontrol-character\fR \fIc\fR\fR
952 .ad
953 .sp .6
954 .RS 4n
955 Set \fIcontrol-character\fR to \fIc\fR, where:
956 .sp
957 .ne 2
958 .na
959 \fB\fIcontrol-character\fR\fR
960 .ad
961 .RS 21n
962 is \fBctab\fR, \fBdiscard\fR, \fBdsusp\fR, \fBeof\fR, \fBeol\fR, \fBeol2\fR,
963 \fBerase\fR, \fBerase2\fR, \fBintr\fR, \fBkill\fR, \fBlnext\fR, \fBquit\fR,
964 \fBreprint\fR, \fBstart\fR, \fBstop\fR, \fBsusp\fR, \fBstatus\fR, \fBswtch\fR,
965 or \fBwerase\fR (\fBctab\fR is used with \fB-stappl\fR, see \fBtermio\fR(7I)).
966 For information on \fBswtch\fR, see NOTES.
967 .RE
969 .sp
970 .ne 2
971 .na
972 \fB\fIc\fR\fR
973 .ad
974 .RS 21n
975 If \fIc\fR is a single character, the control character is set to that
976 character.
977 .sp
978 In the POSIX locale, if \fIc\fR is preceded by a caret (\fB^\fR) indicating an
979 escape from the shell and is one of those listed in the \fI^c\fR column of the
980 following table, then its value used (in the Value column) is the corresponding
981 control character (for example, ``\fB^d\fR'' is a CTRL-d). ``\fB^?\fR'' is
982 interpreted as DEL and ``\fB^\(mi\fR'' is interpreted as undefined.
983 .RE
985 .RE
987 .sp
989 .sp
990 .TS
991 box;
992 c c c c c c
993 l l l l l l .
994 \fB^\fR\fIc\fR \fBValue\fR \fB^\fR\fIc\fR \fBValue\fR \fB^\fR\fIc\fR \fBValue\fR
995 \fBa\fR, A <SOH> \fBl\fR, L <FF> \fBw\fR, W <ETB>
996 \fBb\fR, B <STX> \fBm\fR, M <CR> \fBx\fR, X <CAN>
997 \fBc\fR, C <ETX> \fBn\fR, N <SO> \fBy\fR, Y <EM>
998 \fBd\fR, D <EOT> \fBo\fR, O <SI> \fBz\fR, Z <SUB>
999 \fBe\fR, E <ENQ> \fBp\fR, P <DLE> \fB[\fR <ESC>
1000 \fBf\fR, F <ACK> \fBq\fR, Q <DC1> \fB\e\fR <FS>
1001 \fBg\fR, G <BEL> \fBr\fR, R <DC2> \fB]\fR <GS>
1002 \fBh\fR, H <BS> \fBs\fR, S <DC3> \fB^\fR <RS>
1003 \fBi\fR, I <HT> \fBt\fR, T <DC4> \fB_\fR <US>
1004 \fBj\fR, J <LF> \fBu\fR, U <NAK> \fB?\fR <DEL>
1005 \fBk\fR, K <VT> \fBv\fR, V <SYN>
1006 .TE
1008 .sp
1009 .ne 2
1010 .na
1011 \fB\fBmin\fR \fInumber\fR\fR
1012 .ad
1013 .br
1014 .na
1015 \fB\fBtime\fR \fInumber\fR\fR
1016 .ad
1017 .RS 15n
1018 Set the value of \fBmin\fR or \fBtime\fR to \fInumber\fR. \fBMIN\fR and
1019 \fBTIME\fR are used in Non-Canonical mode input processing (\fB-icanon\fR).
1020 .RE
1022 .sp
1023 .ne 2
1024 .na
1025 \fB\fBline\fR \fIi\fR\fR
1026 .ad
1027 .RS 15n
1028 Set line discipline to \fIi\fR ( \fB0\fR< \fIi\fR <\fB127\fR).
1029 .RE
1031 .SS "Combination Modes"
1032 .ne 2
1033 .na
1034 \fB\fIsaved\fR \fIsettings\fR\fR
1035 .ad
1036 .RS 24n
1037 Set the current terminal characteristics to the saved settings produced by the
1038 \fB-g\fR option.
1039 .RE
1041 .sp
1042 .ne 2
1043 .na
1044 \fB\fBevenp\fR or \fBparity\fR\fR
1045 .ad
1046 .RS 24n
1047 Enable \fBparenb\fR and \fBcs7\fR, or disable \fBparodd\fR.
1048 .RE
1050 .sp
1051 .ne 2
1052 .na
1053 \fB\fBoddp\fR\fR
1054 .ad
1055 .RS 24n
1056 Enable \fBparenb\fR, \fBcs7\fR, and \fBparodd\fR.
1057 .RE
1059 .sp
1060 .ne 2
1061 .na
1062 \fB\fBspacep\fR\fR
1063 .ad
1064 .RS 24n
1065 Enable \fBparenb\fR, \fBcs7\fR, and \fBparext\fR.
1066 .RE
1068 .sp
1069 .ne 2
1070 .na
1071 \fB\fBmarkp\fR\fR
1072 .ad
1073 .RS 24n
1074 Enable \fBparenb\fR, \fBcs7\fR, \fBparodd\fR, and \fBparext\fR.
1075 .RE
1077 .sp
1078 .ne 2
1079 .na
1080 \fB\fB-parity\fR, or \fB-evenp\fR\fR
1081 .ad
1082 .RS 24n
1083 Disable \fBparenb\fR, and set \fBcs8\fR.
1084 .RE
1086 .sp
1087 .ne 2
1088 .na
1089 \fB\fB-oddp\fR\fR
1090 .ad
1091 .RS 24n
1092 Disable \fBparenb\fR and \fBparodd\fR, and set \fBcs8\fR.
1093 .RE
1095 .sp
1096 .ne 2
1097 .na
1098 \fB\fB-spacep\fR\fR
1099 .ad
1100 .RS 24n
1101 Disable \fBparenb\fR and \fBparext\fR, and set \fBcs8\fR.
1102 .RE
1104 .sp
1105 .ne 2
1106 .na
1107 \fB\fB-markp\fR\fR
1108 .ad
1109 .RS 24n
1110 Disable \fBparenb\fR, \fBparodd\fR, and \fBparext\fR, and set \fBcs8\fR.
1111 .RE
1113 .sp
1114 .ne 2
1115 .na
1116 \fB\fBraw\fR (\fB-raw\fR or \fBcooked\fR)\fR
1117 .ad
1118 .RS 24n
1119 Enable (disable) raw input and output. Raw mode is equivalent to setting:
1120 .sp
1121 .in +2
1122 .nf
1123 stty cs8 -icanon min 1 time 0 -isig -xcase \e
1124 -inpck -opost
1125 .fi
1126 .in -2
1128 .RE
1130 .ne 2
1131 .na
1132 \fB\fBnl\fR (\fB-nl\fR)\fR
1133 .ad
1134 .RS 12n
1135 Unset (set) \fBicrnl\fR, \fBonlcr\fR. In addition \fB-nl\fR unsets \fBinlcr\fR,
1136 \fBigncr\fR, \fBocrnl\fR, and \fBonlret\fR.
1137 .RE
1139 .ne 2
1140 .na
1141 \fB\fBnl\fR (\fB-nl\fR)\fR
1142 .ad
1143 .RS 24n
1144 Set (unset) \fBicrnl\fR. In addition, \fB-nl\fR unsets \fBinlcr\fR,
1145 \fBigncr\fR, \fBocrnl\fR, and \fBonlret\fR; \fB-nl\fR sets \fBonlcr\fR, and
1146 \fBnl\fR unsets \fBonlcr\fR.
1147 .RE
1149 .sp
1150 .ne 2
1151 .na
1152 \fB\fBlcase\fR (\fB-lcase\fR)\fR
1153 .ad
1154 .RS 24n
1155 Set (unset) \fBxcase\fR, \fBiuclc\fR, and \fBolcuc\fR.
1156 .RE
1158 .sp
1159 .ne 2
1160 .na
1161 \fB\fBLCASE\fR (\fB-LCASE\fR)\fR
1162 .ad
1163 .RS 24n
1164 Same as \fBlcase\fR (\fB-lcase\fR).
1165 .RE
1167 .sp
1168 .ne 2
1169 .na
1170 \fB\fBtabs\fR (\fB-tabs\fR or \fBtab3\fR)\fR
1171 .ad
1172 .RS 24n
1173 Preserve (expand to spaces) tabs when printing.
1174 .RE
1176 .sp
1177 .ne 2
1178 .na
1179 \fB\fBek\fR\fR
1180 .ad
1181 .RS 24n
1182 Reset ERASE, ERASE2, and KILL characters back to normal DEL, CTRL-h, and CTRL-u,
1183 respectively.
1184 .RE
1186 .sp
1187 .ne 2
1188 .na
1189 \fB\fBsane\fR\fR
1190 .ad
1191 .RS 24n
1192 Reset all modes to some reasonable values.
1193 .RE
1195 .sp
1196 .ne 2
1197 .na
1198 \fB\fIterm\fR\fR
1199 .ad
1200 .RS 24n
1201 Set all modes suitable for the terminal type \fIterm\fR, where \fIterm\fR is
1202 one of \fBtty33\fR, \fBtty37\fR, \fBvt05\fR, \fBtn300\fR, \fBti700\fR, or
1203 \fBtek\fR.
1204 .RE
1206 .sp
1207 .ne 2
1208 .na
1209 \fB\fBasync\fR\fR
1210 .ad
1211 .RS 24n
1212 Set normal asynchronous communications where clock settings are \fBxcibrg\fR,
1213 \fBrcibrg\fR, \fBtsetcoff\fR and \fBrsetcoff\fR.
1214 .RE
1216 .SS "Window Size"
1217 .ne 2
1218 .na
1219 \fB\fBrows\fR \fIn\fR\fR
1220 .ad
1221 .RS 13n
1222 Set window size to \fIn\fR rows.
1223 .RE
1225 .sp
1226 .ne 2
1227 .na
1228 \fB\fBcolumns\fR \fIn\fR\fR
1229 .ad
1230 .RS 13n
1231 Set window size to \fIn\fR columns.
1232 .RE
1234 .sp
1235 .ne 2
1236 .na
1237 \fB\fBcols\fR \fIn\fR\fR
1238 .ad
1239 .RS 13n
1240 Set window size to \fIn\fR columns. \fBcols\fR is a shorthand alias for
1241 columns.
1242 .RE
1244 .sp
1245 .ne 2
1246 .na
1247 \fB\fBypixels\fR \fIn\fR\fR
1248 .ad
1249 .RS 13n
1250 Set vertical window size to \fIn\fR pixels.
1251 .RE
1253 .sp
1254 .ne 2
1255 .na
1256 \fB\fBxpixels\fR \fIn\fR\fR
1257 .ad
1258 .RS 13n
1259 Set horizontal window size to \fIn\fR pixels.
1260 .RE
1262 .SH USAGE
1263 .LP
1264 The \fB-g\fR flag is designed to facilitate the saving and restoring of
1265 terminal state from the shell level. For example, a program can:
1266 .sp
1267 .in +2
1268 .nf
1269 saveterm="$(stty -g)" # save terminal state
1270 stty (new settings) # set new state
1271 \&... # ...
1272 stty $saveterm # restore terminal state
1273 .fi
1274 .in -2
1275 .sp
1277 .sp
1278 .LP
1279 Since the \fB-a\fR format is so loosely specified, scripts that save and
1280 restore terminal settings should use the \fB-g\fR option.
1281 .SH ENVIRONMENT VARIABLES
1282 .LP
1283 See \fBenviron\fR(5) for descriptions of the following environment variables
1284 that affect the execution of \fBstty\fR: \fBLANG\fR, \fBLC_ALL\fR,
1285 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
1286 .SH EXIT STATUS
1287 .LP
1288 The following exit values are returned:
1289 .sp
1290 .ne 2
1291 .na
1292 \fB\fB0\fR\fR
1293 .ad
1294 .RS 6n
1295 Successful completion.
1296 .RE
1298 .sp
1299 .ne 2
1300 .na
1301 \fB\fB>0\fR\fR
1302 .ad
1303 .RS 6n
1304 An error occurred.
1305 .RE
1307 .SH ATTRIBUTES
1308 .LP
1309 See \fBattributes\fR(5) for descriptions of the following attributes:
1310 .SS "/usr/bin/stty"
1311 .TS
1312 box;
1313 c | c
1314 l | l .
1315 ATTRIBUTE TYPE ATTRIBUTE VALUE
1316 _
1317 Interface Stability Committed
1318 _
1319 Standard See \fBstandards\fR(5).
1320 .TE
1322 .SH SEE ALSO
1323 .LP
1324 \fBtabs\fR(1), \fBioctl\fR(2), \fBwrite\fR(2), \fBgetwidth\fR(3C),
1325 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5), \fBldterm\fR(7M),
1326 \fBtermio\fR(7I), \fBtermiox\fR(7I)
1327 .SH NOTES
1328 .LP
1329 Solaris does not support any of the actions implied by \fBswtch\fR, which was
1330 used by the \fBsxt\fR driver on System V release 4. Solaris allows the
1331 \fBswtch\fR value to be set, and prints it out if set, but it does not perform
1332 the \fBswtch\fR action.
1333 .sp
1334 .LP
1335 The job switch functionality on Solaris is actually handled by job control.
1336 \fBsusp\fR is the correct setting for this.