BSD 4_2 release

[unix-history] / usr / man / man1 / tset.1

diff --git a/usr/man/man1/tset.1 b/usr/man/man1/tset.1
index 8a8349a..04f5060 100644 (file)
--- a/usr/man/man1/tset.1
+++ b/usr/man/man1/tset.1
@@ -1,232 +1,403 @@
-.TH TSET 1 11/16/79 1
-.UC
+.TH TSET 1 "16 October 1982"
+.UC 4
+.\"    @(#)tset.1      1.2

 .SH NAME
 .SH NAME

-tset \- set terminal modes
+tset \- terminal dependent initialization

 .SH SYNOPSIS
 .B tset
 .SH SYNOPSIS
 .B tset

-[
-.I options
-] [
-.I type
-]
+[ options ] [
+.B \-m
+[ident][test baudrate]:type ] \&... [ type ]
+.sp 1
+.B reset
+\&...

 .SH DESCRIPTION
 .I Tset
 .SH DESCRIPTION
 .I Tset

-causes terminal dependent processing such as setting
-erase and kill characters, setting or resetting delays.
-It is driven by the
+sets up your terminal when you first log in to a UNIX system.
+It does terminal dependent processing such as setting
+erase and kill characters, setting or resetting delays,
+sending any sequences needed to properly initialized the terminal,
+and the like.
+It first determines the
+.I type
+of terminal involved,
+and then does necessary initializations and mode settings.
+The type of terminal attached to each \s-2UNIX\s0 port is specified in the

 .I /etc/ttytype
 .I /etc/ttytype

-and
-.I /etc/termcap
-files.
+database.
+Type names for terminals may be found in the
+.IR termcap (5)
+database.
+If a port is not wired permanently to a specific terminal (not hardwired)
+it will be given an appropriate generic identifier such as
+.IR dialup .

 .PP
 .PP

-.I Tset
-is most useful when included in the
+In the case where no arguments are specified,
+.I tset
+simply reads the terminal type out of the environment variable TERM
+and re-initializes the terminal.  The rest of this manual concerns
+itself with mode and environment initialization,
+typically done once at login, and options
+used at initialization time to determine the terminal type and set up
+terminal modes.
+.PP
+When used in a startup script (\fI\&.profile\fR for
+.IR sh (1)
+users or

 .I \&.login
 .I \&.login

-(for
-.IR csh (1))
+for
+.IR csh (1)
+users) it is desirable to give information about the type of terminal
+you will usually use on ports which are not hardwired.
+These ports are identified in
+.I /etc/ttytype
+as
+.I dialup
+or
+.I plugboard

 or
 or

-.I \&.profile
-(for
-.IR sh (1))
-file executed automatically at login,
-with
-.B \-d
-used to specify the terminal type you most frequently dial in on.
-.PP
-There are gobs of exciting options.
-Most of them can be ignored most of the time.
-The options are listed in approximate order of importance,
-from the very important
-to the hopelessly obscure.
-.nr xx \w'\-d \fItype\fR  '
-.TP \n(xxu
-\fB\-d\fR \fItype\fR
-If the terminal is a dialup
-set the type to
+.I arpanet,
+etc.
+To specify
+what terminal type you usually use on these ports, the
+.B \-m
+(map) option flag is followed by the appropriate port type identifier,
+an optional baud rate specification,
+and the terminal type.
+(The effect is to ``map'' from some conditions to a terminal type,
+that is, to tell
+.I tset
+``If I'm on this kind of port, guess that I'm on that kind of terminal''.)
+If more than one mapping is specified, the first applicable mapping prevails.
+A missing port type identifier matches all identifiers.
+Any of the alternate generic names given in
+.I termcap
+may be used for the identifier.
+.PP
+A
+.I baudrate
+is specified as with
+.IR stty (1),
+and is compared with the
+speed of the diagnostic output (which should be the control terminal).
+The baud rate
+.I test
+may be any combination of:
+.BR > ,
+.BR @ ,
+.BR < ,
+and
+.BR ! ;
+.B @
+means ``at''
+and
+.B !
+inverts the sense of the test.  To avoid problems with metacharacters, it
+is best to place the entire argument to
+.B \-m
+within ``\''' characters; users of
+.IR csh (1)
+must also put a ``\e'' before any ``!'' used here.
+.PP
+.KS
+Thus
+.IP
+tset \-m \'dialup>300:adm3a\' -m dialup:dw2 -m \'plugboard:?adm3a\'
+.KE
+.LP
+causes the terminal type to be set to an
+.I adm3a
+if the port in use is a dialup at a speed greater than 300 baud;
+to a 
+.I dw2
+if the port is (otherwise) a dialup (i.e. at 300 baud or less).
+(\fBNOTE:\fP the examples given here appear to take up more than
+one line, for text processing reasons.  When you type in real
+.I tset
+commands, you must enter them entirely on one line.)
+If the

 .I type
 .I type

-instead.
-This flag overrides the
+finally determined by
+.I tset
+begins with a question mark,
+the user is asked if s/he really wants that type.
+A null response means to use that type;
+otherwise, another type can be entered which will be used instead.
+Thus, in the above case, the user will be queried on a plugboard port
+as to whether they are actually using an
+.IR adm3a .
+.PP
+If no mapping applies and a final

 .I type
 .I type

-parameter on the command line,
-so
-.br
-       tset \-d adm3a hp2621
-.br
-sets the type to ``adm3a'' if you are on a dialup
-and ``hp2621'' otherwise.
-.TP
-\fB\-p\fR \fItype\fR
-Like \fB\-d\fR, but for ``plugboard'' ports.
-.TP
-\fB\-b\fR \fItype\fR
-Like \fB\-d\fR, but for ``bussiplexor'' ports.
-.TP
-\fB\-a\fR \fItype\fR
-Like \fB\-d\fR, but for \s-2ARPANET\s0 telnet connections.
-.TP
-.BI \-e x
-Set the erase character to
-.I x.
-If
-.I x
-is omitted,
-set the erase character to the erase character for the
-terminal you are on
-(usually control-H).
-If this flag is omitted,
-this processing will only happen
-on terminals that can backspace
-and not overstrike.
-.TP
-.BI \-k x
-Sets the kill character to
-.I x.
-The default for
-.I x
-is control-X.
-.TP
+option, not preceded by a
+.BR \-m ,
+is given on the command line
+then that type is used;
+otherwise the identifier found in the
+.I /etc/ttytype
+database will be taken to be the terminal type.
+This should always be the case for hardwired ports.
+.PP
+It is usually desirable to return the terminal type, as finally determined by
+.IR tset ,
+and information about the terminal's capabilities
+to a shell's environment.  This can be done using the

 .B \-
 .B \-

-Output the terminal type to the standard output.
-If this is the only argument specified,
+option; using the Bourne shell,
+.IR sh (1):
+.IP
+export TERM; TERM=\`tset \- \fIoptions...\fR\`
+.LP
+or using the C shell,
+.IR csh (1):
+.IP
+setenv TERM \`tset - \fIoptions...\fR\`
+.PP
+With
+.I csh
+it is convenient to make an alias in your .cshrc:
+.PP
+.RS
+alias tset \'setenv TERM \`tset \- \e!*\`\'
+.RE
+Either of these aliases allow the command
+.RS
+tset 2621
+.RE
+to be invoked at any time from your login csh.
+.B "Note to Bourne Shell users:"
+It is
+.B not
+possible to get this aliasing effect with a shell script,
+because shell scripts cannot set the environment of their parent.
+(If a process could set its parent's environment,
+none of this nonsense would be necessary in the first place.)
+.PP
+These commands cause

 .I tset
 .I tset

-does no other processing.
+to place the name of your terminal in the variable
+TERM in the environment; see
+.IR environ (7).
+.PP
+Once the terminal type is known,
+.I tset
+engages in terminal driver mode setting.
+This normally involves sending an initialization sequence to the
+terminal, setting the single character erase (and optionally
+the line-kill (full line erase)) characters,
+and setting special character delays.
+Tab and newline expansion are turned off during transmission of
+the terminal initialization sequence.
+.PP
+On terminals that can backspace but not overstrike
+(such as a \s-2CRT\s0),
+and when the erase character is the default erase character
+(`#' on standard systems),
+the erase character is changed to \s-2BACKSPACE\s0 (Control-H).
+.PP
+The options are:

 .TP
 .TP

-.B \-s
-Output setenv commands to set the TERM and TERMCAP
-variables.  (See below.)
+.B \-e\fIc
+set the erase character to be the named character
+.I c
+on all terminals,
+the default being the backspace character on the terminal, usually ^H.
+The character
+.I c
+can either be typed directly, or entered using the hat
+notation used here.

 .TP
 .TP

-.B \-h
-Do not look at the environment.
+.B \-k\fIc
+is similar to
+.B \-e
+but for the line kill character rather than the erase character;
+.I c
+defaults to ^X (for purely historical reasons).
+The kill characters is left alone if
+.B \-k
+is not specified.
+The hat notation can also be used for this option.

 .TP
 .TP

-.B \-r
-Output the terminal type to the diagnostic output.
-Useful for people who like to know
-what kind of terminal they are on.
+.B \-
+The name of the terminal finally decided upon is output on the
+standard output.
+This is intended to be captured by the shell and placed in the
+environment variable TERM.

 .TP
 .TP

-.B \-Q
-Be quiet.
-This supresses the output of the
-``Erase set to'' and ``Kill set to'' messages.
+.B \-n
+On systems with the Berkeley 4BSD tty driver,
+specifies that the new tty driver modes should be initialized for this terminal.
+For a \s-2CRT\s0,
+the CRTERASE and CRTKILL
+modes are set only if the baud rate is 1200 or greater.
+See tty(4) for more detail.

 .TP
 .B \-I
 .TP
 .B \-I

-Don't do tab initialization.
-Useful when long startup strings are output
-and the terminal is already initialized.
+suppresses transmitting terminal initialization strings.

 .TP
 .TP

-.BI \-E x
-Like
-.BR \-e ,
-except this flag is ignored on terminals that
-cannot backspace at all.
-God help you if you have to use this flag;
-it only exists because out there somewhere an
-\s-2ASR\s0-33 may still exist.
-.PP
-The type of the terminal you are on
-is divined from the environment
-...(in version 7),
-...or the /etc/htmp file
-...(in version 6),
-unless the
-.I type
-argument is given
-or any of the
-.B \-h,
-.B \-d,
-.B \-p,
-.B \-a,
-or
-.B \-b
-flags are given.
-If any of these are set,
+.B \-Q
+suppresses printing the
+``Erase set to'' and ``Kill set to'' messages.
+.PP
+If
+.B tset
+is invoked as
+.BR reset ,
+it will set cooked and echo modes, turn off cbreak and raw modes,
+turn on newline translation, and restore special characters
+to a sensible state before any terminal dependent processing is done.
+Any special character that is found to be \s-2NULL\s0
+or ``\-1'' is reset to its default value.
+.PP
+This is most useful after a program dies leaving a terminal in a funny
+state. You may have to type ``\s-2<LF>\s0reset\s-2<LF>\s0'' to get it to work
+since \s-2<CR>\s0 may not work in this state. Often none of this will echo.
+.SH EXAMPLES
+.PP
+These examples all assume the Bourne shell and use the - option.
+If you use
+.IR csh ,
+use one of the variations described above.
+Note that a typical use of

 .I tset
 .I tset

-looks in the
-.I /etc/ttytype
-file for a type based on the port
-you are logged in on.
-The
-.I type
-may be any type given in
-.I /etc/termcap.
-If any
-.I type
-begins with a question mark,
-the user is asked if s/he really wants that type.
-A null response means to use that type;
-otherwise, another type can be entered which will be used instead.
-(The question mark should be escaped with \e
-to prevent filename expansion by the shell.)
-In the
-.B \-e,
-.B \-E,
+in a .profile or .login will also use the
+.B \-e

 and
 .B \-k
 and
 .B \-k

-flags,
-.I x
-can be replaced with
-.RI ``^ X \&''
-where X is any character;
-this
-is equivalent to
-.RI control- X .
+options, and often the
+.B \-n
+or
+.B \-Q
+options as well.
+These options have not been included here to keep the examples small.
+(\fBNOTE:\fP some of the examples given here appear to take up more than
+one line, for text processing reasons.  When you type in real
+.I tset
+commands, you must enter them entirely on one line.)

 .PP
 .PP

-The
-.B \-s
-option outputs ``setenv'' commands
-(if your default shell is
-.IR csh (1))
-or ``export'' and assignment commands
-(if your default shell is 
-.IR sh (1))
-it can be used as:
-.br
-       \`tset \-s ...\`
-.br
-[Actually, this is not possible because of a problem in the shells.
-Instead, use:
-.nf
-       tset \-s ... > /tmp/tset$$
-       source /tmp/tset$$
-       rm /tmp/tset$$
-.fi
-(If using
-.IR sh (1)
-replace `source' by `.')]
-..Currently,
-...B \-s
-..sets the variables TERM
-..with the terminal type
-..and TERMCAP with the actual line from the
-...I /etc/termcap
-..file;
-..this makes
-...I ex
-..and other terminal-dependent programs start up faster.
-.PP
-For version 6 systems,
+At the moment, you are on a 2621.
+This is suitable for typing by hand but
+not for a .profile, unless you are
+.I always
+on a 2621.
+.IP
+export TERM; TERM=\`tset \- 2621\`
+.PP
+You have an h19 at home which you dial up on, but your office terminal
+is hardwired and known in /etc/ttytype.
+.IP
+export TERM; TERM=\`tset \- \-m dialup:h19\`
+.PP
+You have a switch which connects everything to everything, making
+it nearly impossible to key on what port you are coming in on.
+You use a vt100 in your office at 9600 baud, and dial up to switch
+ports at 1200 baud from home on a 2621.
+Sometimes you use someone elses terminal at work,
+so you want it to ask you to make sure what terminal
+type you have at high speeds, but at 1200 baud you are
+always on a 2621.
+Note the placement of the question mark, and the quotes
+to protect the greater than and question mark from
+interpretation by the shell.
+.IP
+export TERM; TERM=\`tset \- \-m 'switch>1200:?vt100' \-m 'switch<=1200:2621'
+.PP
+All of the above entries will fall back on the terminal type
+specified in
+.I /etc/ttytype
+if none of the conditions hold.
+The following entry is appropriate if
+you always dial up, always at the same baud rate,
+on many different kinds of terminals.
+Your most common terminal is an adm3a.
+It always asks you what kind of terminal you are on,
+defaulting to adm3a.
+.IP
+export TERM; TERM=\`tset \- \?adm3a\`
+.PP
+If the file
+.I /etc/ttytype
+is not properly installed and you want to
+key entirely on the baud rate, the following can be used:
+.IP
+export TERM; TERM=\`tset \- \-m '>1200:vt100' 2621\`
+.PP
+Here is a fancy example to illustrate the power of

 .I tset
 .I tset

-gets the terminal type from the file
-/etc/htmp
-and updates it there.
-A special
-.B \-u
-flag on version 6 systems suppresses any possible
-updating of /etc/htmp.
-.SH EXAMPLES
-tset \-dti733 \-p \e?hp2621 \-e \-k^U
-.br
-\`tset \-dadm3a \-s \-e# \-r\`
-.br
-tset gt42
+and to hopelessly confuse anyone who has made it this far.
+You dial up at 1200 baud or less on a concept100,
+sometimes over switch ports and sometimes over regular dialups.
+You use various terminals at speeds higher than 1200 over switch ports,
+most often the terminal in your office, which is a vt100.
+However, sometimes you log in from the university you used to go to,
+over the ARPANET; in this case you are on an ALTO emulating a dm2500.
+You also often log in on various hardwired ports, such as the console,
+all of which are properly entered in
+.IR /etc/ttytype .
+You want your erase character set to control H,
+your kill character set to control U,
+and don't want
+.I tset
+to print the ``Erase set to Backspace, Kill set to Control U'' message.
+.IP
+export TERM; TERM=\`tset \-e \-k^U \-Q \- \-m 'switch<=1200:concept100' \-m 'switch:?vt100' \-m dialup:concept100 \-m arpanet:dm2500\`

 .SH FILES
 .DT
 .SH FILES
 .DT

-/etc/htmp              Terminal type database (version 6 only)
+/etc/ttytype   port name to terminal type mapping database

 .br
 .br

-/etc/ttytype           Terminal id to type map database
-.br
-/etc/termcap   Terminal capability database
-.SH AUTHOR
-Eric P. Allman
+/etc/termcap   terminal capability database

 .SH SEE\ ALSO
 .SH SEE\ ALSO

-setenv(1), stty(1), ttytype(5), termcap(5)
+csh(1), sh(1), stty(1), ttytype(5), termcap(5), environ(7)
+.SH AUTHORS
+Eric Allman
+.br
+David Wasley
+.br
+Mark Horton

 .SH BUGS
 .SH BUGS

+.PP
+The
+.I tset
+command is one of the first commands a user must master when getting
+started on a UNIX system.
+Unfortunately, it is one of the most complex,
+largely because of the extra effort the user must go through
+to get the environment of the login shell set.
+Something needs to be done to make all this simpler,
+either the
+.IR login (1)
+program should do this stuff,
+or a default shell alias should be made,
+or a way to set the environment of the parent should exist.
+.ig
+.SH NOTES
+For compatibility with earlier versions of
+.I tset
+a number of flags are accepted whose use is discouraged:
+.TP 10
+\fB\-d\fR type
+equivalent to
+.B \-m
+dialup:type
+.TP 10
+\fB\-p\fR type
+equivalent to
+.B \-m
+plugboard:type
+.TP 10
+\fB\-a\fR type
+equivalent to
+.B \-m
+arpanet:type
+.TP 10
+\fB\-E\fR c
+Sets the erase character to
+.I c
+only if the terminal can backspace.
+.TP 10
+\fB\-\fR
+prints the terminal type on the standard output
+.TP 10
+\fB\-r\fR
+prints the terminal type on the diagnostic output.
+..