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. Neither the name of the University nor the names of its contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" @(#)stty.1 8.4 (Berkeley) 4/18/94
32 .\" $FreeBSD: src/bin/stty/stty.1,v 1.13.2.6 2001/12/14 14:22:09 ru Exp $
39 .Nd set the options for a terminal device interface
42 .Op Fl a | Fl e | Fl g
48 utility sets or reports on terminal
49 characteristics for the device that is its standard input.
50 If no options or operands are specified, it reports the settings of a subset
51 of characteristics as well as additional ones if they differ from their
54 the terminal state according to the specified arguments.
55 Some combinations of arguments are mutually
56 exclusive on some terminal types.
58 The following options are available:
59 .Bl -tag -width indent
61 Display all the current settings for the terminal to standard output
65 Display all the current settings for the terminal to standard output
68 ``all'' and ``everything'' formats.
70 Open and use the terminal named by
72 rather than using standard input.
73 The file is opened using the
78 set or display settings on a terminal that might otherwise
81 Display all the current settings for the terminal to standard output
82 in a form that may be used as an argument to a subsequent invocation of
84 to restore the current terminal state as per
88 The following arguments are available to set the terminal
91 Control mode flags affect hardware characteristics associated with the
93 This corresponds to the c_cflag in the termios structure.
95 .It Cm parenb Pq Fl parenb
96 Enable (disable) parity generation
98 .It Cm parodd Pq Fl parodd
99 Select odd (even) parity.
100 .It Cm cs5 cs6 cs7 cs8
101 Select character size, if possible.
103 Set terminal baud rate to the
104 number given, if possible.
106 baud rate is set to zero, modem
109 .It Cm ispeed Ar number
110 Set terminal input baud rate to the
111 number given, if possible.
113 input baud rate is set to zero, the
114 input baud rate is set to the
115 value of the output baud
117 .It Cm ospeed Ar number
118 Set terminal output baud rate to
119 the number given, if possible.
121 the output baud rate is set to
122 zero, modem control is
124 .It Cm speed Ar number
131 .It Cm hupcl Pq Fl hupcl
132 Stop asserting modem control
133 (do not stop asserting modem control) on last close.
137 .It Cm cstopb Pq Fl cstopb
138 Use two (one) stop bits per character.
139 .It Cm cread Pq Fl cread
140 Enable (disable) the receiver.
141 .It Cm clocal Pq Fl clocal
142 Assume a line without (with) modem
144 .It Cm crtscts Pq Fl crtscts
145 Enable (disable) RTS/CTS flow control.
148 This corresponds to the c_iflag in the termios structure.
150 .It Cm ignbrk Pq Fl ignbrk
151 Ignore (do not ignore) break on
153 .It Cm brkint Pq Fl brkint
154 Signal (do not signal)
158 .It Cm ignpar Pq Fl ignpar
159 Ignore (do not ignore) characters with parity
161 .It Cm parmrk Pq Fl parmrk
162 Mark (do not mark) characters with parity errors.
163 .It Cm inpck Pq Fl inpck
164 Enable (disable) input parity
166 .It Cm istrip Pq Fl istrip
167 Strip (do not strip) input characters
169 .It Cm inlcr Pq Fl inlcr
175 .It Cm igncr Pq Fl igncr
176 Ignore (do not ignore)
179 .It Cm icrnl Pq Fl icrnl
185 .It Cm ixon Pq Fl ixon
190 Output from the system is
191 stopped when the system receives
193 and started when the system
198 is set, any character restarts output.
199 .It Cm ixoff Pq Fl ixoff
200 Request that the system send (not
204 the input queue is nearly
206 .It Cm ixany Pq Fl ixany
207 Allow any character (allow only
210 .It Cm imaxbel Pq Fl imaxbel
211 The system imposes a limit of
213 (currently 255) characters in the input queue.
216 is set and the input queue limit has been reached,
217 subsequent input causes the system to send an ASCII BEL
218 character to the output queue (the terminal beeps at you).
221 is unset and the input queue is full, the next input character causes
222 the entire input and output queues to be discarded.
225 This corresponds to the c_oflag of the termios structure.
227 .It Cm opost Pq Fl opost
228 Post-process output (do not
229 post-process output; ignore all other
231 .It Cm onlcr Pq Fl onlcr
237 .It Cm ocrnl Pq Fl ocrnl
244 Select tab expansion policy.
246 disables tab expansion, while
249 .It Cm oxtabs Pq Fl oxtabs
257 .It Cm onocr Pq Fl onocr
258 Do not (do) output CRs at column zero.
259 .It Cm onlret Pq Fl onlret
260 On the terminal NL performs (does not perform) the CR function.
263 Local mode flags (lflags) affect various and sundry characteristics of terminal
265 Historically the term "local" pertained to new job control features
266 implemented by Jim Kulp on a
270 Later the driver ran on the first
272 at Evans Hall, UC Berkeley, where the job control details
273 were greatly modified but the structure definitions and names
274 remained essentially unchanged.
275 The second interpretation of the 'l' in lflag
276 is ``line discipline flag'' which corresponds to the
282 .It Cm isig Pq Fl isig
283 Enable (disable) the checking of
284 characters against the special control
289 .It Cm icanon Pq Fl icanon
290 Enable (disable) canonical input
295 .It Cm iexten Pq Fl iexten
296 Enable (disable) any implementation
297 defined special control characters
298 not currently controlled by icanon,
300 .It Cm echo Pq Fl echo
301 Echo back (do not echo back) every
303 .It Cm echoe Pq Fl echoe
306 character shall (shall
307 not) visually erase the last character
308 in the current line from the
309 display, if possible.
310 .It Cm echok Pq Fl echok
316 .It Cm echoke Pq Fl echoke
319 character shall (shall
320 not) visually erase the
321 current line from the
322 display, if possible.
323 .It Cm echonl Pq Fl echonl
328 .It Cm echoctl Pq Fl echoctl
331 is set, echo control characters as ^X.
332 Otherwise control characters echo as themselves.
333 .It Cm echoprt Pq Fl echoprt
334 For printing terminals.
335 If set, echo erased characters backwards within ``\\''
337 Otherwise, disable this feature.
338 .It Cm noflsh Pq Fl noflsh
339 Disable (enable) flush after
340 .Dv INTR , QUIT , SUSP .
341 .It Cm tostop Pq Fl tostop
344 for background output.
345 This causes background jobs to stop if they attempt terminal output.
346 .It Cm altwerase Pq Fl altwerase
347 Use (do not use) an alternate word erase algorithm when processing
350 This alternate algorithm considers sequences of
351 alphanumeric/underscores as words.
352 It also skips the first preceding character in its classification
353 (as a convenience since the one preceding character could have been
354 erased with simply an
357 .It Cm mdmbuf Pq Fl mdmbuf
358 If set, flow control output based on condition of Carrier Detect.
360 writes return an error if Carrier Detect is low (and Carrier is not being
364 .It Cm flusho Pq Fl flusho
365 Indicates output is (is not) being discarded.
366 .It Cm pendin Pq Fl pendin
367 Indicates input is (is not) pending after a switch from non-canonical
368 to canonical mode and will be re-input when a read becomes pending
369 or more input arrives.
371 .Ss Control Characters:
373 .It Ar control-character Ar string
375 .Ar control-character
378 If string is a single character,
379 the control character is set to
382 two character sequence "^-" or the
383 string "undef" the control character
384 is disabled (i.e.\& set to
385 .Pf { Dv _POSIX_VDISABLE Ns } . )
387 Recognized control-characters:
388 .Bl -column "character" "Subscript" "Description"
389 .It Sy Control Ta Sy Subscript Ta Sy Description
390 .It Sy character Ta "" Ta ""
391 .It eof Ta Dv VEOF Ta "EOF character"
392 .It eol Ta Dv VEOL Ta "EOL character"
393 .It eol2 Ta Dv VEOL2 Ta "EOL2 character"
394 .It erase Ta Dv VERASE Ta "ERASE character"
395 .It erase2 Ta Dv VERASE2 Ta "ERASE2 character"
396 .It werase Ta Dv VWERASE Ta "WERASE character"
397 .It intr Ta Dv VINTR Ta "INTR character"
398 .It kill Ta Dv VKILL Ta "KILL character"
399 .It quit Ta Dv VQUIT Ta "QUIT character"
400 .It susp Ta Dv VSUSP Ta "SUSP character"
401 .It start Ta Dv VSTART Ta "START character"
402 .It stop Ta Dv VSTOP Ta "STOP character"
403 .It dsusp Ta Dv VDSUSP Ta "DSUSP character"
404 .It lnext Ta Dv VLNEXT Ta "LNEXT character"
405 .It reprint Ta Dv VREPRINT Ta "REPRINT character"
406 .It status Ta Dv VSTATUS Ta "STATUS character"
407 .It ckpt Ta Dv VCHECKPT Ta "CKPT character"
410 .It Cm time Ar number
411 Set the value of min or time to
417 Non-Canonical mode input processing
420 .Ss Combination Modes:
422 .It Ar saved settings
423 Set the current terminal
424 characteristics to the saved settings
428 .It Cm evenp No or Cm parity
429 Enable parenb and cs7; disable
432 Enable parenb, cs7, and parodd.
433 .It Fl parity , evenp , oddp
434 Disable parenb, and set cs8.
435 .It Cm \&nl Pq Fl \&nl
436 Enable (disable) icrnl.
438 -nl unsets inlcr and igncr.
446 back to system defaults.
448 Resets all modes to reasonable values for interactive terminal use.
450 Set the line discipline to the standard terminal line discipline
453 Set (disable) all modes suitable for a CRT display device.
454 .It Cm kerninfo Pq Fl kerninfo
455 Enable (disable) the system generated status line associated with
458 character (usually set to ^T).
459 The status line consists of the
460 system load average, the current command name, its process ID, the
461 event the process is waiting on (or the status of the process), the user
462 and system times, percent cpu, and current memory usage.
463 .It Cm columns Ar number
464 The terminal size is recorded as having
467 .It Cm cols Ar number
470 .It Cm rows Ar number
471 The terminal size is recorded as having
475 Set modes suitable for users of Digital Equipment Corporation systems
480 characters are set to ^?, ^U, and ^C;
485 .It Cm extproc Pq Fl extproc
486 If set, this flag indicates that some amount of terminal processing is being
487 performed by either the terminal hardware or by the remote side connected
490 If set, change the modes of the terminal so that no input or output processing
492 If unset, change the modes of the terminal to some reasonable
493 state that performs input and output processing.
494 Note that since the terminal driver no longer has a single
496 bit, it is not possible to intuit what flags were set prior to setting
498 This means that unsetting
500 may not put back all the setting that were previously in effect.
501 To set the terminal into a raw state and then accurately restore it, the following
502 shell code is recommended:
504 save_state=$(stty -g)
510 The size of the terminal is printed as two numbers on a single line,
511 first rows, then columns.
513 .Ss Compatibility Modes:
514 These modes remain for compatibility with the previous version of
520 Reports all the terminal modes as with
522 except that the control characters are printed in a columnar format.
531 .Cm brkint , ixon , imaxbel , opost ,
543 .It Cm newcrt Pq Fl newcrt
549 .It Cm tandem Pq Fl tandem
552 .It Cm decctlq Pq Fl decctlq
555 .It Cm crterase Pq Fl crterase
558 .It Cm crtbs Pq Fl crtbs
561 .It Cm crtkill Pq Fl crtkill
564 .It Cm ctlecho Pq Fl ctlecho
567 .It Cm prterase Pq Fl prterase
570 .It Cm litout Pq Fl litout
573 .It Cm tabs Pq Fl tabs
577 Same as the control character
579 .It Cm flush Ar value
580 Same as the control character
582 .It Cm rprnt Ar value
583 Same as the control character
593 utility is expected to be
601 extensions to the standard.