mdoc version three plus some changes by bostic (cael)

[unix-history] / usr / src / bin / stty / stty.1

.\" Copyright (c) 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" %sccs.include.redist.man%
.\"
.\"     @(#)stty.1	6.10 (Berkeley) %G%
.\"
.Dd 
.Dt STTY 1
.Os
.Sh NAME
.Nm stty
.Nd set the options for a terminal device interface
.Sh SYNOPSIS
.Nm stty
.Op Fl a | Fl e | Fl g
.Op Fl f Ar file
.Op operands
.Sh DESCRIPTION
The 
.Nm stty
utility sets or reports on terminal
.Tn I/O
characteristics for the device that is its standard input.
If no options or operands are specified, it reports the
settings of certain characteristics if they differ
from their default values.
Otherwise it modifies
the terminal state according to the specified arguments.
Some combinations of arguments are mutually
exclusive on some terminal types.
.Pp
The following options are available:
.Bl -tag -width Ds
.It Fl a
Display all the current settings for the terminal to standard output 
in the
.St -p1003.2 .
.It Fl e
Display all the current settings for the terminal to standard output 
in the traditional
.Tn BSD
``all'' and ``everything'' formats.
.It Fl f
Display the current settings for the terminal named by
.Ar file .
.It Fl g
Display all the current settings for the terminal to standard output 
in a form that may be used as an argument to another invocation of
.Nm stty .
.El
.Pp
The following arguments are available to set the terminal
characteristics:
.Bl -tag -width Fl
.It Cm parenb Pq Fl parenb
Enable (disable) parity generation
and detection.
.It Cm parodd Pq Fl parodd
Select odd (even) parity.
.It Cm cs5 cs6 cs7 cs8
Select character size, if possible.
.It Ar number
Set terminal baud rate to the
number given, if possible.
If the
baud rate is set to zero, modem
control is no longer
asserted.
.It Cm ispeed Ar number
Set terminal input baud rate to the
number given, if possible.
If the
input baud rate is set to zero, the
input baud rate is set to the
value of the output baud
rate.
.It Cm ospeed Ar number
Set terminal output baud rate to
the number given, if possible.
If
the output baud rate is set to
zero, modem control is
no longer asserted.
.It Cm hupcl Pq Fl hupcl
Stop asserting modem control
(do not stop asserting modem control) on last close.
.It Cm hup Pq Fl hup
Same as hupcl
.Pq Fl hupcl .
.It Cm cstopb Pq Fl cstopb
Use two (one) stop bits per character.
.It Cm cread Pq Fl cread
Enable (disable) the receiver.
.It Cm clocal Pq Fl clocal
Assume a line without (with) modem
control.
.It Cm ignbrk Pq Fl ignbrk
Ignore (do not ignore) break on
input.
.It Cm brkint Pq Fl brkint
Signal (do not signal)
.Dv INTR
on
break.
.It Cm ignpar Pq Fl ignpar
Ignore (do not ignore) parity
errors.
.It Cm parmrk Pq Fl parmrk
Mark (do not mark) parity errors.
.It Cm inpck Pq Fl inpck
Enable (disable) input parity
checking.
.It Cm istrip Pq Fl istrip
Strip (do not strip) input characters
to seven bits.
.It Cm inlcr Pq Fl inlcr
Map (do not map)
.Dv NL
to
.Dv CR
on input.
.It Cm igncr Pq Fl igncr
Ignore (do not ignore)
.Dv CR
on input.
.It Cm icrnl Pq Fl icrnl
Map (do not map)
.Dv CR
to
.Dv NL
on input.
.It Cm ixon Pq Fl ixon
Enable (disable)
.Dv START/STOP
output
control.
Output from the system is
stopped when the system receives
.Dv STOP
and started when the system
receives
.Dv START .
.It Cm ixoff Pq Fl ixoff
Request that the system send (not
send)
.Dv START/STOP
characters when
the input queue is nearly
empty/full.
.It Cm opost Pq Fl opost
Post-process output (do not
post-process output; ignore all other
output modes).
.It Cm isig Pq Fl isig
Enable (disable) the checking of
characters against the special control
characters
.Dv INTR , QUIT ,
and
.Dv SUSP .
.It Cm icanon Pq Fl icanon
Enable (disable) canonical input
.Pf ( Dv ERASE
and
.Dv KILL
processing).
.It Cm iexten Pq Fl iexten
Enable (disable) any implementation
defined special control characters
not currently controlled by icanon,
isig, or ixon.
.It Cm echo Pq Fl echo
Echo back (do not echo back) every
character typed.
.It Cm echoe Pq Fl echoe
The
.Dv ERASE
character shall (shall
not) visually erase the last character
in the current line from the
display, if possible.
.It Cm echok Pq Fl echok
Echo (do not echo)
.Dv NL
after
.Dv KILL
character.
.It Cm echonl Pq Fl echonl
Echo (do not echo)
.Dv NL ,
even if echo
is disabled.
.It Cm noflsh Pq Fl noflsh
Disable (enable) flush after
.Dv INTR , QUIT , SUSP .
.It Cm control-character Ar string
Set control-character to string.
If string is a single character,
the control character is set to
that character.
If string is the
two character sequence "^-" or the
string "undef" the control character
is set to
.Pf { Dv _POSIX_VDISABLE Ns }
if
it is in effect for the device; if
.Pf { Dv _POSIX_VDISABLE Ns }
is not in effect
for the device, it is an
error.
.Pp
Recognized control-characters:
.Bd -ragged -offset indent
.Bl -column character Subscript
.It control- Ta Tn POSIX.1
.It character	Subscript	Description
.It _________	_________	_______________
.It eof Ta Tn VEOF	EOF No character
.It eol Ta Tn VEOL	EOL No character
.It erase Ta Tn VERASE	ERASE No character
.It intr Ta Tn VINTR	INTR No character
.It kill Ta Tn VKILL	KILL No character
.It quit Ta Tn VQUIT	QUIT No character
.It susp Ta Tn VSUSP	SUSP No character
.It start Ta Tn VSTART	START No character
.It stop Ta Tn VSTOP	STOP No character
.El
.Ed
.It Cm saved settings
Set the current terminal
characteristics to the saved settings
produced by the
.Fl g
option.
.It Cm min Ar number
.It Cm time Ar number
Set the value of min or time to
number.
.Dv MIN
and
.Dv TIME
are used in
Non-Canonical mode input processing
(-icanon).
.It Cm evenp No or Cm parity
Enable parenb and cs7; disable
parodd.
.It Cm oddp
Enable parenb, cs7, and parodd.
.It Fl parity , evenp ,  oddp
Disable parenb, and set cs8.
.It Cm nl Pq Fl nl
Enable (disable) icrnl.
In addition
-nl unsets inlcr and igncr.
.It Cm ek
Reset
.Dv ERASE
and
.Dv KILL
characters
back to system defaults.
.It Cm sane
Resets all modes to reasonable values for interactive terminal use.
.It Cm tty
Set the line discipline to the standard terminal line discipline
.Dv TTYDISC .
.El
.Pp
If the
.Fl g
option is specified, stty writes to standard output
the current settings in a form that can be used as arguments
to another instance of stty on the same system.
.Pp
If the
.Fl a
option is specified, all of the information about the current setting
is written to standard output
in the same format described for the arguments above.
Unless otherwise specified, this information is displayed as
<space>-separated tokens, on one or
more lines, with one or more tokens per line.
.Pp
If no options are specified, a subset of the
information displayed for the
.Fl a
option is displayed.
.Pp
If the terminal input speed and output speed are the same,
the speed information is displayed as follows:
.Bd -ragged -offset indent
"speed %d baud;", <speed>
.Ed
.Pp
Otherwise speeds are displayed as:
.Pp
.Bd -ragged -offset indent
"ispeed %d baud; ospeed %d baud;", <ispeed>, <ospeed>
.Ed
.Pp
Control characters are displayed as:
.Pp
.Bd -ragged -offset indent
"%s = %s;", <control-character name>, <value>
.Ed
.Pp
where value is either the character, or some visual
representation of the character if it is non-printing, or
the string "<undef>" if the character is disabled.
.Pp
The
.Nm stty
utility exits with one of the following values:
.Bl -tag -width indent
.It Li \&0
The terminal options were read or set successfully.
.It Li \&>0
An error occurred.
.El
.Sh SEE ALSO
.Xr stty 4
.Sh STANDARDS
The
.Nm stty
function is expected to be
.St -p1003.2
compatible.