2 .\" Copyright (c) 1990, 1993, 1994
3 .\" The Regents of the University of California. All rights reserved.
5 .\" This code is derived from software contributed to Berkeley by
6 .\" the Institute of Electrical and Electronics Engineers, Inc.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)stty.1 8.4 (Berkeley) 4/18/94
40 .Nd set the options for a terminal device interface
49 utility sets or reports on terminal
50 characteristics for the device that is its standard input.
51 If no options or arguments are specified, it reports the settings of a subset
52 of characteristics as well as additional ones if they differ from their
55 the terminal state according to the specified arguments.
56 Some combinations of arguments are mutually
57 exclusive on some terminal types.
59 The following options are available:
60 .Bl -tag -width indent
62 Display all the current settings for the terminal to standard output
66 Display all the current settings for the terminal to standard output
69 ``all'' and ``everything'' formats.
71 Open and use the terminal named by
73 rather than using standard input.
80 set or display settings on a terminal that might otherwise
83 Display all the current settings for the terminal to standard output
84 in a form that may be used as an argument to a subsequent invocation of
86 to restore the current terminal state as per
90 The following arguments are available to set the terminal
93 Control mode flags affect hardware characteristics associated with the
95 This corresponds to the c_cflag in the termios structure.
97 .It Cm parenb Pq Fl parenb
98 Enable (disable) parity generation
100 .It Cm parodd Pq Fl parodd
101 Select odd (even) parity.
102 .It Cm cs5 cs6 cs7 cs8
103 Select character size, if possible.
105 Set terminal baud rate to the
106 number given, if possible.
108 baud rate is set to zero, modem
111 .It Cm ispeed Ar number
112 Set terminal input baud rate to the
113 number given, if possible.
115 input baud rate is set to zero, the
116 input baud rate is set to the
117 value of the output baud
119 .It Cm ospeed Ar number
120 Set terminal output baud rate to
121 the number given, if possible.
123 the output baud rate is set to
124 zero, modem control is
126 .It Cm speed Ar number
133 .It Cm hupcl Pq Fl hupcl
134 Stop asserting modem control
135 (do not stop asserting modem control) on last close.
139 .It Cm cstopb Pq Fl cstopb
140 Use two (one) stop bits per character.
141 .It Cm cread Pq Fl cread
142 Enable (disable) the receiver.
143 .It Cm clocal Pq Fl clocal
144 Assume a line without (with) modem
146 .It Cm crtscts Pq Fl crtscts
147 Enable (disable) RTS/CTS flow control.
148 .It Cm rtsdtr Pq Fl -rtsdtr
149 Enable (disable) asserting RTS/DTR on open.
152 This corresponds to the c_iflag in the termios structure.
154 .It Cm ignbrk Pq Fl ignbrk
155 Ignore (do not ignore) break on
157 .It Cm brkint Pq Fl brkint
158 Signal (do not signal)
162 .It Cm ignpar Pq Fl ignpar
163 Ignore (do not ignore) characters with parity
165 .It Cm parmrk Pq Fl parmrk
166 Mark (do not mark) characters with parity errors.
167 .It Cm inpck Pq Fl inpck
168 Enable (disable) input parity
170 .It Cm istrip Pq Fl istrip
171 Strip (do not strip) input characters
173 .It Cm inlcr Pq Fl inlcr
179 .It Cm igncr Pq Fl igncr
180 Ignore (do not ignore)
183 .It Cm icrnl Pq Fl icrnl
189 .It Cm ixon Pq Fl ixon
194 Output from the system is
195 stopped when the system receives
197 and started when the system
202 is set, any character restarts output.
203 .It Cm ixoff Pq Fl ixoff
204 Request that the system send (not
208 the input queue is nearly
210 .It Cm ixany Pq Fl ixany
211 Allow any character (allow only
214 .It Cm imaxbel Pq Fl imaxbel
215 The system imposes a limit of
217 (currently 255) characters in the input queue.
220 is set and the input queue limit has been reached,
221 subsequent input causes the system to send an ASCII BEL
222 character to the output queue (the terminal beeps at you).
226 is unset and the input queue is full, the next input character causes
227 the entire input and output queues to be discarded.
230 This corresponds to the c_oflag of the termios structure.
232 .It Cm opost Pq Fl opost
233 Post-process output (do not
234 post-process output; ignore all other
236 .It Cm onlcr Pq Fl onlcr
242 .It Cm ocrnl Pq Fl ocrnl
249 Select tab expansion policy.
251 disables tab expansion, while
254 .It Cm onocr Pq Fl onocr
255 Do not (do) output CRs at column zero.
256 .It Cm onlret Pq Fl onlret
257 On the terminal NL performs (does not perform) the CR function.
260 Local mode flags (lflags) affect various and sundry characteristics of terminal
262 Historically the term "local" pertained to new job control features
263 implemented by Jim Kulp on a
267 Later the driver ran on the first
269 at Evans Hall, UC Berkeley, where the job control details
270 were greatly modified but the structure definitions and names
271 remained essentially unchanged.
272 The second interpretation of the 'l' in lflag
273 is ``line discipline flag'' which corresponds to the
279 .It Cm isig Pq Fl isig
280 Enable (disable) the checking of
281 characters against the special control
286 .It Cm icanon Pq Fl icanon
287 Enable (disable) canonical input
292 .It Cm iexten Pq Fl iexten
293 Enable (disable) any implementation
294 defined special control characters
295 not currently controlled by icanon,
297 .It Cm echo Pq Fl echo
298 Echo back (do not echo back) every
300 .It Cm echoe Pq Fl echoe
303 character shall (shall
304 not) visually erase the last character
305 in the current line from the
306 display, if possible.
307 .It Cm echok Pq Fl echok
313 .It Cm echoke Pq Fl echoke
316 character shall (shall
317 not) visually erase the
318 current line from the
319 display, if possible.
320 .It Cm echonl Pq Fl echonl
325 .It Cm echoctl Pq Fl echoctl
328 is set, echo control characters as ^X.
329 Otherwise control characters
331 .It Cm echoprt Pq Fl echoprt
332 For printing terminals.
333 If set, echo erased characters backwards within ``\\''
335 Otherwise, disable this feature.
336 .It Cm noflsh Pq Fl noflsh
337 Disable (enable) flush after
338 .Dv INTR , QUIT , SUSP .
339 .It Cm tostop Pq Fl tostop
342 for background output.
343 This causes background jobs to stop if they attempt
345 .It Cm altwerase Pq Fl altwerase
346 Use (do not use) an alternate word erase algorithm when processing
349 This alternate algorithm considers sequences of
350 alphanumeric/underscores as words.
351 It also skips the first preceding character in its classification
352 (as a convenience since the one preceding character could have been
353 erased with simply an
356 .It Cm mdmbuf Pq Fl mdmbuf
357 If set, flow control output based on condition of Carrier Detect.
359 writes return an error if Carrier Detect is low (and Carrier is not being
363 .It Cm flusho Pq Fl flusho
364 Indicates output is (is not) being discarded.
365 .It Cm pendin Pq Fl pendin
366 Indicates input is (is not) pending after a switch from non-canonical
367 to canonical mode and will be re-input when a read becomes pending
368 or more input arrives.
370 .Ss Control Characters:
372 .It Ar control-character Ar string
374 .Ar control-character
377 If string is a single character,
378 the control character is set to
381 two character sequence "^-" or the
382 string "undef" the control character
383 is disabled (i.e., set to
384 .Pf { Dv _POSIX_VDISABLE Ns } . )
386 Recognized control-characters:
387 .Bd -ragged -offset indent
388 .Bl -column character Subscript
389 .It control- Ta \& Ta \&
390 .It character Ta Subscript Ta Description
391 .It _________ Ta _________ Ta _______________
392 .It eof Ta Tn VEOF Ta EOF No character
393 .It eol Ta Tn VEOL Ta EOL No character
394 .It eol2 Ta Tn VEOL2 Ta EOL2 No character
395 .It erase Ta Tn VERASE Ta ERASE No character
396 .It erase2 Ta Tn VERASE2 Ta ERASE2 No character
397 .It werase Ta Tn VWERASE Ta WERASE No character
398 .It intr Ta Tn VINTR Ta INTR No character
399 .It kill Ta Tn VKILL Ta KILL No character
400 .It quit Ta Tn VQUIT Ta QUIT No character
401 .It susp Ta Tn VSUSP Ta SUSP No character
402 .It start Ta Tn VSTART Ta START No character
403 .It stop Ta Tn VSTOP Ta STOP No character
404 .It dsusp Ta Tn VDSUSP Ta DSUSP No character
405 .It lnext Ta Tn VLNEXT Ta LNEXT No character
406 .It reprint Ta Tn VREPRINT Ta REPRINT No character
407 .It status Ta Tn VSTATUS Ta STATUS No character
411 .It Cm time Ar number
412 Set the value of min or time to
418 Non-Canonical mode input processing
421 .Ss Combination Modes:
423 .It Ar saved settings
424 Set the current terminal
425 characteristics to the saved settings
429 .It Cm evenp No or Cm parity
430 Enable parenb and cs7; disable
433 Enable parenb, cs7, and parodd.
434 .It Fl parity , evenp , oddp
435 Disable parenb, and set cs8.
436 .It Cm \&nl Pq Fl \&nl
437 Enable (disable) icrnl.
439 -nl unsets inlcr and igncr.
447 back to system defaults.
449 Resets all modes to reasonable values for interactive terminal use.
451 Set the line discipline to the standard terminal line discipline
454 Set (disable) all modes suitable for a CRT display device.
455 .It Cm kerninfo Pq Fl kerninfo
456 Enable (disable) the system generated status line associated with
459 character (usually set to ^T).
460 The status line consists of the
461 system load average, the current command name, its process ID, the
462 event the process is waiting on (or the status of the process), the user
463 and system times, percent cpu, and current memory usage.
468 .Va kern.tty_info_kstacks
469 is set to a non-zero value, the status message also includes the kernel program
470 stack of the foreground thread.
471 .It Cm columns Ar number
472 The terminal size is recorded as having
475 .It Cm cols Ar number
478 .It Cm rows Ar number
479 The terminal size is recorded as having
483 Set modes suitable for users of Digital Equipment Corporation systems
488 characters are set to ^?, ^U, and ^C;
493 .It Cm extproc Pq Fl extproc
494 If set, this flag indicates that some amount of terminal processing is being
495 performed by either the terminal hardware or by the remote side connected
498 If set, change the modes of the terminal so that no input or output processing
500 If unset, change the modes of the terminal to some reasonable
501 state that performs input and output processing.
503 terminal driver no longer has a single
505 bit, it is not possible to intuit what flags were set prior to setting
507 This means that unsetting
509 may not put back all the setting that were previously in effect.
510 To set the terminal into a raw state and then accurately restore it, the following
511 shell code is recommended:
513 save_state=$(stty -g)
519 The size of the terminal is printed as two numbers on a single line,
520 first rows, then columns.
522 .Ss Compatibility Modes:
523 These modes remain for compatibility with the previous version of
529 Reports all the terminal modes as with
531 except that the control characters are printed in a columnar format.
540 .Cm brkint , ixon , imaxbel , opost ,
552 .It Cm newcrt Pq Fl newcrt
558 .It Cm tandem Pq Fl tandem
561 .It Cm decctlq Pq Fl decctlq
564 .It Cm crterase Pq Fl crterase
567 .It Cm crtbs Pq Fl crtbs
570 .It Cm crtkill Pq Fl crtkill
573 .It Cm ctlecho Pq Fl ctlecho
576 .It Cm prterase Pq Fl prterase
579 .It Cm litout Pq Fl litout
582 .It Cm oxtabs Pq Fl oxtabs
583 Expand (do not expand) tabs to spaces on output.
584 .It Cm tabs Pq Fl tabs
588 Same as the control character
590 .It Cm flush Ar value
591 Same as the control character
593 .It Cm rprnt Ar value
594 Same as the control character
606 utility is expected to be
614 extensions to the standard.