1 .\" Copyright (c) 1985, 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. 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 .\" @(#)tset.1 8.1 (Berkeley) 6/9/93
41 .Nd terminal initialization
62 utility initializes terminals.
63 It first determines the type of terminal that you are using.
64 This determination is done as follows, using the first terminal type found.
66 .Bl -bullet -compact -offset indent
70 argument specified on the command line.
76 The terminal type associated with the standard error output device in the
80 The default terminal type, ``unknown''.
83 If the terminal type was not specified on the command-line, the
85 option mappings are then applied (see below for more information).
86 Then, if the terminal type begins with a question mark (``?''), the user is
87 prompted for confirmation of the terminal type.
88 An empty response confirms the type, or, another type can be entered to
90 Once the terminal type has been determined, the termcap entry for the terminal
92 If no termcap entry is found for the type, the user is prompted for another
95 Once the termcap entry is retrieved, the window size, backspace, interrupt
96 and line kill characters (among many other things) are set and the terminal
97 and tab initialization strings are sent to the standard error output.
98 Finally, if the erase, interrupt and line kill characters have changed,
99 or are not set to their default values, their values are displayed to the
100 standard error output.
105 sets cooked and echo modes, turns off cbreak and raw modes, turns on
106 newline translation and resets any unset special characters to their
107 default values before doing the terminal initialization described above.
108 This is useful after a program dies leaving a terminal in an abnormal state.
109 Note, you may have to type
111 (the line-feed character is normally control-J) to get the terminal
112 to work, as carriage-return may no longer work in the abnormal state.
113 Also, the terminal will often not echo the command.
115 The options are as follows:
118 The terminal type is displayed to the standard output, and the terminal is
119 not initialized in any way.
121 Set the erase character to
124 Do not send the terminal or tab initialization strings to the terminal.
126 Set the interrupt character to
129 Set the line kill character to
132 Specify a mapping from a port type to a terminal.
133 See below for more information.
135 Do not display any values for the erase, interrupt and line kill characters.
137 Print the terminal type to the standard error output.
139 Print the terminal type and the termcap entry to the standard output.
140 See the section below on setting the environment for details.
142 Print the sequence of shell commands to initialize the environment variables
146 to the standard output.
147 See the section below on setting the environment for details.
150 The arguments for the
155 options may either be entered as actual characters or by using the
157 notation, i.e., control-h may be specified as
161 .Sh SETTING THE ENVIRONMENT
162 It is often desirable to enter the terminal type and information about
163 the terminal's capabilities into the shell's environment.
164 This is done using the
172 option is specified, the terminal type and the termcap entry are written
173 to the standard output, separated by a space and without a terminating
175 This can be assigned to an array by
179 users and then used like any other shell array.
183 option is specified, the commands to enter the information into the
184 shell's environment are written to the standard output.
187 environment variable ends in ``csh'', the commands are for the
189 otherwise, they are for
193 commands set and unset the shell variable
196 The following line in the
200 files will initialize the environment correctly:
201 .Bd -literal -offset indent
202 eval \`tset -s options ... \`
205 To demonstrate a simple use of the
207 option, the following lines in the
209 file have an equivalent effect:
210 .Bd -literal -offset indent
212 set term=(`tset -S options ...`)
214 setenv TERMCAP "$term[2]"
218 .Sh TERMINAL TYPE MAPPING
219 When the terminal is not hardwired into the system (or the current system
220 information is incorrect) the terminal type derived from the
224 environment variable is often something generic like
231 is used in a startup script
239 users) it is often desirable to provide information about the type of
240 terminal used on such ports.
245 from some set of conditions to a terminal type, that is, to
248 ``If I'm on this port at a particular speed, guess that I'm on that
253 option consists of an optional port type, an optional operator, an optional
254 baud rate specification, an optional colon (``:'') character and a terminal
256 The port type is a string (delimited by either the operator or the colon
258 The operator may be any combination of:
272 inverts the sense of the test.
273 The baud rate is specified as a number and is compared with the speed
274 of the standard error output (which should be the control terminal).
275 The terminal type is a string.
277 If the terminal type is not specified on the command line, the
279 mappings are applied to the terminal type.
280 If the port type and baud rate match the mapping, the terminal type specified
281 in the mapping replaces the current type.
282 If more than one mapping is specified, the first applicable mapping is used.
284 For example, consider the following mapping:
285 .Dq Li dialup>9600:vt100 .
290 the baud rate specification is
292 and the terminal type is
294 The result of this mapping is to specify that if the terminal type is
296 and the baud rate is greater than 9600 baud, a terminal type of
300 If no port type is specified, the terminal type will match any port type,
302 .Dq Li -m dialup:vt100 -m :?xterm
303 will cause any dialup port, regardless of baud rate, to match the terminal
306 and any non-dialup port type to match the terminal type
308 Note, because of the leading question mark, the user will be
309 queried on a default port as to whether they are actually using an
313 No whitespace characters are permitted in the
316 Also, to avoid problems with metacharacters, it is suggested that the entire
318 option argument be placed within single quote characters, and that
320 users insert a backslash character (``\e'') before any exclamation
329 environment variables.
331 .Bl -tag -width /usr/share/misc/termcap -compact
333 system port name to terminal type mapping database
334 .It Pa /usr/share/misc/termcap
335 terminal capability database
345 options have been deleted from the
348 None of them were documented in
350 and all are of limited utility at
357 options are similarly not documented or useful, but were retained as they
358 appear to be in widespread use.
359 It is strongly recommended that any usage of these three options be
365 option remains, but has no effect.
366 It is still permissible to specify the
371 options without arguments, although it is strongly recommended that such
372 usage be fixed to explicitly specify the character.
378 no longer implies the
381 Also, the interaction between the
385 argument in some historic implementations of
391 implementation has been completely redone (as part of the addition to the
394 compliant terminal interface) and will no longer compile on systems with
395 older terminal interfaces.