1 .\" Copyright (c) 1990, 1993, 1994
2 .\" The Regents of the University of California. All rights reserved.
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the Institute of Electrical and Electronics Engineers, Inc.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\" must display the following acknowledgement:
17 .\" This product includes software developed by the University of
18 .\" California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\" may be used to endorse or promote products derived from this software
21 .\" without specific prior written permission.
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .\" @(#)stty.1 8.4 (Berkeley) 4/18/94
36 .\" $FreeBSD: src/bin/stty/stty.1,v 1.13.2.6 2001/12/14 14:22:09 ru Exp $
37 .\" $DragonFly: src/bin/stty/stty.1,v 1.4 2006/02/10 19:01:09 swildner Exp $
44 .Nd set the options for a terminal device interface
47 .Op Fl a | Fl e | Fl g
53 utility sets or reports on terminal
54 characteristics for the device that is its standard input.
55 If no options or operands are specified, it reports the settings of a subset
56 of characteristics as well as additional ones if they differ from their
59 the terminal state according to the specified arguments.
60 Some combinations of arguments are mutually
61 exclusive on some terminal types.
63 The following options are available:
64 .Bl -tag -width indent
66 Display all the current settings for the terminal to standard output
70 Display all the current settings for the terminal to standard output
73 ``all'' and ``everything'' formats.
75 Open and use the terminal named by
77 rather than using standard input.
78 The file is opened using the
83 set or display settings on a terminal that might otherwise
86 Display all the current settings for the terminal to standard output
87 in a form that may be used as an argument to a subsequent invocation of
89 to restore the current terminal state as per
93 The following arguments are available to set the terminal
96 Control mode flags affect hardware characteristics associated with the
98 This corresponds to the c_cflag in the termios structure.
100 .It Cm parenb Pq Fl parenb
101 Enable (disable) parity generation
103 .It Cm parodd Pq Fl parodd
104 Select odd (even) parity.
105 .It Cm cs5 cs6 cs7 cs8
106 Select character size, if possible.
108 Set terminal baud rate to the
109 number given, if possible.
111 baud rate is set to zero, modem
114 .It Cm ispeed Ar number
115 Set terminal input baud rate to the
116 number given, if possible.
118 input baud rate is set to zero, the
119 input baud rate is set to the
120 value of the output baud
122 .It Cm ospeed Ar number
123 Set terminal output baud rate to
124 the number given, if possible.
126 the output baud rate is set to
127 zero, modem control is
129 .It Cm speed Ar number
136 .It Cm hupcl Pq Fl hupcl
137 Stop asserting modem control
138 (do not stop asserting modem control) on last close.
142 .It Cm cstopb Pq Fl cstopb
143 Use two (one) stop bits per character.
144 .It Cm cread Pq Fl cread
145 Enable (disable) the receiver.
146 .It Cm clocal Pq Fl clocal
147 Assume a line without (with) modem
149 .It Cm crtscts Pq Fl crtscts
150 Enable (disable) RTS/CTS flow control.
153 This corresponds to the c_iflag in the termios structure.
155 .It Cm ignbrk Pq Fl ignbrk
156 Ignore (do not ignore) break on
158 .It Cm brkint Pq Fl brkint
159 Signal (do not signal)
163 .It Cm ignpar Pq Fl ignpar
164 Ignore (do not ignore) characters with parity
166 .It Cm parmrk Pq Fl parmrk
167 Mark (do not mark) characters with parity errors.
168 .It Cm inpck Pq Fl inpck
169 Enable (disable) input parity
171 .It Cm istrip Pq Fl istrip
172 Strip (do not strip) input characters
174 .It Cm inlcr Pq Fl inlcr
180 .It Cm igncr Pq Fl igncr
181 Ignore (do not ignore)
184 .It Cm icrnl Pq Fl icrnl
190 .It Cm ixon Pq Fl ixon
195 Output from the system is
196 stopped when the system receives
198 and started when the system
203 is set, any character restarts output.
204 .It Cm ixoff Pq Fl ixoff
205 Request that the system send (not
209 the input queue is nearly
211 .It Cm ixany Pq Fl ixany
212 Allow any character (allow only
215 .It Cm imaxbel Pq Fl imaxbel
216 The system imposes a limit of
218 (currently 255) characters in the input queue.
221 is set and the input queue limit has been reached,
222 subsequent input causes the system to send an ASCII BEL
223 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
248 .It Cm oxtabs Pq Fl oxtabs
249 Expand (do not expand) tabs to spaces on output.
250 .It Cm onocr Pq Fl onocr
251 Do not (do) output CRs at column zero.
252 .It Cm onlret Pq Fl onlret
253 On the terminal NL performs (does not perform) the CR function.
256 Local mode flags (lflags) affect various and sundry characteristics of terminal
258 Historically the term "local" pertained to new job control features
259 implemented by Jim Kulp on a
263 Later the driver ran on the first
265 at Evans Hall, UC Berkeley, where the job control details
266 were greatly modified but the structure definitions and names
267 remained essentially unchanged.
268 The second interpretation of the 'l' in lflag
269 is ``line discipline flag'' which corresponds to the
275 .It Cm isig Pq Fl isig
276 Enable (disable) the checking of
277 characters against the special control
282 .It Cm icanon Pq Fl icanon
283 Enable (disable) canonical input
288 .It Cm iexten Pq Fl iexten
289 Enable (disable) any implementation
290 defined special control characters
291 not currently controlled by icanon,
293 .It Cm echo Pq Fl echo
294 Echo back (do not echo back) every
296 .It Cm echoe Pq Fl echoe
299 character shall (shall
300 not) visually erase the last character
301 in the current line from the
302 display, if possible.
303 .It Cm echok Pq Fl echok
309 .It Cm echoke Pq Fl echoke
312 character shall (shall
313 not) visually erase the
314 current line from the
315 display, if possible.
316 .It Cm echonl Pq Fl echonl
321 .It Cm echoctl Pq Fl echoctl
324 is set, echo control characters as ^X.
325 Otherwise control characters echo as themselves.
326 .It Cm echoprt Pq Fl echoprt
327 For printing terminals.
328 If set, echo erased characters backwards within ``\\''
330 Otherwise, disable this feature.
331 .It Cm noflsh Pq Fl noflsh
332 Disable (enable) flush after
333 .Dv INTR , QUIT , SUSP .
334 .It Cm tostop Pq Fl tostop
337 for background output.
338 This causes background jobs to stop if they attempt terminal output.
339 .It Cm altwerase Pq Fl altwerase
340 Use (do not use) an alternate word erase algorithm when processing
343 This alternate algorithm considers sequences of
344 alphanumeric/underscores as words.
345 It also skips the first preceding character in its classification
346 (as a convenience since the one preceding character could have been
347 erased with simply an
350 .It Cm mdmbuf Pq Fl mdmbuf
351 If set, flow control output based on condition of Carrier Detect.
353 writes return an error if Carrier Detect is low (and Carrier is not being
357 .It Cm flusho Pq Fl flusho
358 Indicates output is (is not) being discarded.
359 .It Cm pendin Pq Fl pendin
360 Indicates input is (is not) pending after a switch from non-canonical
361 to canonical mode and will be re-input when a read becomes pending
362 or more input arrives.
364 .Ss Control Characters:
366 .It Ar control-character Ar string
368 .Ar control-character
371 If string is a single character,
372 the control character is set to
375 two character sequence "^-" or the
376 string "undef" the control character
377 is disabled (i.e.\& set to
378 .Pf { Dv _POSIX_VDISABLE Ns } . )
380 Recognized control-characters:
381 .Bd -ragged -offset indent
382 .Bl -column character Subscript
384 .It character Ta Subscript Ta Description
385 .It _________ Ta _________ Ta _______________
386 .It eof Ta Tn VEOF Ta EOF No character
387 .It eol Ta Tn VEOL Ta EOL No character
388 .It eol2 Ta Tn VEOL2 Ta EOL2 No character
389 .It erase Ta Tn VERASE Ta ERASE No character
390 .It erase2 Ta Tn VERASE2 Ta ERASE2 No character
391 .It werase Ta Tn VWERASE Ta WERASE No character
392 .It intr Ta Tn VINTR Ta INTR No character
393 .It kill Ta Tn VKILL Ta KILL No character
394 .It quit Ta Tn VQUIT Ta QUIT No character
395 .It susp Ta Tn VSUSP Ta SUSP No character
396 .It start Ta Tn VSTART Ta START No character
397 .It stop Ta Tn VSTOP Ta STOP No character
398 .It dsusp Ta Tn VDSUSP Ta DSUSP No character
399 .It lnext Ta Tn VLNEXT Ta LNEXT No character
400 .It reprint Ta Tn VREPRINT Ta REPRINT No character
401 .It status Ta Tn VSTATUS Ta STATUS No character
402 .It ckpt Ta Tn VCHECKPT Ta CKPT No character
406 .It Cm time Ar number
407 Set the value of min or time to
413 Non-Canonical mode input processing
416 .Ss Combination Modes:
418 .It Ar saved settings
419 Set the current terminal
420 characteristics to the saved settings
424 .It Cm evenp No or Cm parity
425 Enable parenb and cs7; disable
428 Enable parenb, cs7, and parodd.
429 .It Fl parity , evenp , oddp
430 Disable parenb, and set cs8.
431 .It Cm \&nl Pq Fl \&nl
432 Enable (disable) icrnl.
434 -nl unsets inlcr and igncr.
442 back to system defaults.
444 Resets all modes to reasonable values for interactive terminal use.
446 Set the line discipline to the standard terminal line discipline
449 Set (disable) all modes suitable for a CRT display device.
450 .It Cm kerninfo Pq Fl kerninfo
451 Enable (disable) the system generated status line associated with
454 character (usually set to ^T).
455 The status line consists of the
456 system load average, the current command name, its process ID, the
457 event the process is waiting on (or the status of the process), the user
458 and system times, percent cpu, and current memory usage.
459 .It Cm columns Ar number
460 The terminal size is recorded as having
463 .It Cm cols Ar number
466 .It Cm rows Ar number
467 The terminal size is recorded as having
471 Set modes suitable for users of Digital Equipment Corporation systems
476 characters are set to ^?, ^U, and ^C;
481 .It Cm extproc Pq Fl extproc
482 If set, this flag indicates that some amount of terminal processing is being
483 performed by either the terminal hardware or by the remote side connected
486 If set, change the modes of the terminal so that no input or output processing
488 If unset, change the modes of the terminal to some reasonable
489 state that performs input and output processing.
490 Note that since the terminal driver no longer has a single
492 bit, it is not possible to intuit what flags were set prior to setting
494 This means that unsetting
496 may not put back all the setting that were previously in effect.
497 To set the terminal into a raw state and then accurately restore it, the following
498 shell code is recommended:
500 save_state=$(stty -g)
506 The size of the terminal is printed as two numbers on a single line,
507 first rows, then columns.
509 .Ss Compatibility Modes:
510 These modes remain for compatibility with the previous version of
516 Reports all the terminal modes as with
518 except that the control characters are printed in a columnar format.
527 .Cm brkint , ixon , imaxbel , opost ,
539 .It Cm newcrt Pq Fl newcrt
545 .It Cm tandem Pq Fl tandem
548 .It Cm decctlq Pq Fl decctlq
551 .It Cm crterase Pq Fl crterase
554 .It Cm crtbs Pq Fl crtbs
557 .It Cm crtkill Pq Fl crtkill
560 .It Cm ctlecho Pq Fl ctlecho
563 .It Cm prterase Pq Fl prterase
566 .It Cm litout Pq Fl litout
569 .It Cm tabs Pq Fl tabs
573 Same as the control character
575 .It Cm flush Ar value
576 Same as the control character
578 .It Cm rprnt Ar value
579 Same as the control character
589 utility is expected to be
597 extensions to the standard.