| blob | e2f986b2f2955c403258b547876f6a6c5940129a |
1 .\" Copyright (c) 1985, 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
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.
19 .\"
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
30 .\" SUCH DAMAGE.
31 .\"
32 .\" @(#)tset.1 8.1 (Berkeley) 6/9/93
33 .\" $FreeBSD: src/usr.bin/tset/tset.1,v 1.5.2.5 2003/02/24 22:37:42 trhodes Exp $
34 .\" $DragonFly: src/usr.bin/tset/tset.1,v 1.4 2006/04/17 18:01:38 swildner Exp $
35 .\"
36 .Dd June 9, 1993
37 .Dt TSET 1
38 .Os
39 .Sh NAME
40 .Nm tset ,
41 .Nm reset
42 .Nd terminal initialization
43 .Sh SYNOPSIS
44 .Nm
45 .Op Fl IQrSs
46 .Op Fl
47 .Op Fl e Ar ch
48 .Op Fl i Ar ch
49 .Op Fl k Ar ch
50 .Op Fl m Ar mapping
51 .Op Ar terminal
52 .Nm reset
53 .Op Fl IQrSs
54 .Op Fl
55 .Op Fl e Ar ch
56 .Op Fl i Ar ch
57 .Op Fl k Ar ch
58 .Op Fl m Ar mapping
59 .Op Ar terminal
60 .Sh DESCRIPTION
61 The
62 .Nm
63 utility initializes terminals.
64 It first determines the type of terminal that you are using.
65 This determination is done as follows, using the first terminal type found.
66 .Pp
67 .Bl -bullet -compact -offset indent
68 .It
69 The
70 .Ar terminal
71 argument specified on the command line.
72 .It
73 The value of the
74 .Ev TERM
75 environment variable.
76 .It
77 The terminal type associated with the standard error output device in the
78 .Pa /etc/ttys
79 file.
80 .It
81 The default terminal type, ``unknown''.
82 .El
83 .Pp
84 If the terminal type was not specified on the command-line, the
85 .Fl m
86 option mappings are then applied (see below for more information).
87 Then, if the terminal type begins with a question mark (``?''), the user is
88 prompted for confirmation of the terminal type.
89 An empty response confirms the type, or, another type can be entered to
90 specify a new type.
91 Once the terminal type has been determined, the termcap entry for the terminal
92 is retrieved.
93 If no termcap entry is found for the type, the user is prompted for another
94 terminal type.
95 .Pp
96 Once the termcap entry is retrieved, the window size, backspace, interrupt
97 and line kill characters (among many other things) are set and the terminal
98 and tab initialization strings are sent to the standard error output.
99 Finally, if the erase, interrupt and line kill characters have changed,
100 or are not set to their default values, their values are displayed to the
101 standard error output.
102 .Pp
103 When invoked as
104 .Nm reset ,
105 .Nm
106 sets cooked and echo modes, turns off cbreak and raw modes, turns on
107 newline translation and resets any unset special characters to their
108 default values before doing the terminal initialization described above.
109 This is useful after a program dies leaving a terminal in an abnormal state.
110 Note, you may have to type
111 .Dq Li <LF>reset<LF>
112 (the line-feed character is normally control-J) to get the terminal
113 to work, as carriage-return may no longer work in the abnormal state.
114 Also, the terminal will often not echo the command.
115 .Pp
116 The options are as follows:
117 .Bl -tag -width flag
118 .It Fl
119 The terminal type is displayed to the standard output, and the terminal is
120 not initialized in any way.
121 .It Fl e
122 Set the erase character to
123 .Ar ch .
124 .It Fl I
125 Do not send the terminal or tab initialization strings to the terminal.
126 .It Fl i
127 Set the interrupt character to
128 .Ar ch .
129 .It Fl k
130 Set the line kill character to
131 .Ar ch .
132 .It Fl m
133 Specify a mapping from a port type to a terminal.
134 See below for more information.
135 .It Fl Q
136 Don't display any values for the erase, interrupt and line kill characters.
137 .It Fl r
138 Print the terminal type to the standard error output.
139 .It Fl S
140 Print the terminal type and the termcap entry to the standard output.
141 See the section below on setting the environment for details.
142 .It Fl s
143 Print the sequence of shell commands to initialize the environment variables
144 .Ev TERM
145 and
146 .Ev TERMCAP
147 to the standard output.
148 See the section below on setting the environment for details.
149 .El
150 .Pp
151 The arguments for the
152 .Fl e ,
153 .Fl i
154 and
155 .Fl k
156 options may either be entered as actual characters or by using the
157 .Dq hat
158 notation, i.e. control-h may be specified as
159 .Dq Li ^H
160 or
161 .Dq Li ^h .
162 .Sh SETTING THE ENVIRONMENT
163 It is often desirable to enter the terminal type and information about
164 the terminal's capabilities into the shell's environment.
165 This is done using the
166 .Fl S
167 and
168 .Fl s
169 options.
170 .Pp
171 When the
172 .Fl S
173 option is specified, the terminal type and the termcap entry are written
174 to the standard output, separated by a space and without a terminating
175 newline.
176 This can be assigned to an array by
177 .Xr csh 1
178 and
179 .Xr ksh 1
180 users and then used like any other shell array.
181 .Pp
182 When the
183 .Fl s
184 option is specified, the commands to enter the information into the
185 shell's environment are written to the standard output.
186 If the
187 .Ev SHELL
188 environment variable ends in ``csh'', the commands are for the
189 .Xr csh 1 ,
190 otherwise, they are for
191 .Xr sh 1 .
192 Note, the
193 .Xr csh 1
194 commands set and unset the shell variable
195 .Dq noglob ,
196 leaving it unset.
197 The following line in the
198 .Pa .login
199 or
200 .Pa .profile
201 files will initialize the environment correctly:
202 .Bd -literal -offset indent
203 eval \`tset -s options ... \`
204 .Ed
205 .Pp
206 To demonstrate a simple use of the
207 .Fl S
208 option, the following lines in the
209 .Pa .login
210 file have an equivalent effect:
211 .Bd -literal -offset indent
212 set noglob
213 set term=(`tset -S options ...`)
214 setenv TERM $term[1]
215 setenv TERMCAP "$term[2]"
216 unset term
217 unset noglob
218 .Ed
219 .Sh TERMINAL TYPE MAPPING
220 When the terminal is not hardwired into the system (or the current system
221 information is incorrect) the terminal type derived from the
222 .Pa /etc/ttys
223 file or the
224 .Ev TERM
225 environment variable is often something generic like
226 .Dq network ,
227 .Dq dialup ,
228 or
229 .Dq unknown .
230 When
231 .Nm
232 is used in a startup script
233 .Pf ( Pa .profile
234 for
235 .Xr sh 1
236 users or
237 .Pa .login
238 for
239 .Xr csh 1
240 users) it is often desirable to provide information about the type of
241 terminal used on such ports.
242 The purpose of the
243 .Fl m
244 option is to
245 .Dq map
246 from some set of conditions to a terminal type, that is, to
247 tell
248 .Nm
249 ``If I'm on this port at a particular speed, guess that I'm on that
250 kind of terminal''.
251 .Pp
252 The argument to the
253 .Fl m
254 option consists of an optional port type, an optional operator, an optional
255 baud rate specification, an optional colon (``:'') character and a terminal
256 type.
257 The port type is a string (delimited by either the operator or the colon
258 character).
259 The operator may be any combination of:
260 .Dq Li \&> ,
261 .Dq Li \&< ,
262 .Dq Li \&@ ,
263 and
264 .Dq Li \&! ;
265 .Dq Li \&>
266 means greater than,
267 .Dq Li \&<
268 means less than,
269 .Dq Li \&@
270 means equal to
271 and
272 .Dq Li !\&
273 inverts the sense of the test.
274 The baud rate is specified as a number and is compared with the speed
275 of the standard error output (which should be the control terminal).
276 The terminal type is a string.
277 .Pp
278 If the terminal type is not specified on the command line, the
279 .Fl m
280 mappings are applied to the terminal type.
281 If the port type and baud rate match the mapping, the terminal type specified
282 in the mapping replaces the current type.
283 If more than one mapping is specified, the first applicable mapping is used.
284 .Pp
285 For example, consider the following mapping:
286 .Dq Li dialup>9600:vt100 .
287 The port type is
288 .Dq Li dialup ,
289 the operator is
290 .Dq Li > ,
291 the baud rate specification is
292 .Dq Li 9600 ,
293 and the terminal type is
294 .Dq Li vt100 .
295 The result of this mapping is to specify that if the terminal type is
296 .Dq Li dialup ,
297 and the baud rate is greater than 9600 baud, a terminal type of
298 .Dq Li vt100
299 will be used.
300 .Pp
301 If no port type is specified, the terminal type will match any port type,
302 for example,
303 .Dq Li -m dialup:vt100 -m :?xterm
304 will cause any dialup port, regardless of baud rate, to match the terminal
305 type
306 .Dq Li vt100 ,
307 and any non-dialup port type to match the terminal type
308 .Dq Li ?xterm .
309 Note, because of the leading question mark, the user will be
310 queried on a default port as to whether they are actually using an
311 .Ar xterm
312 terminal.
313 .Pp
314 No whitespace characters are permitted in the
315 .Fl m
316 option argument.
317 Also, to avoid problems with metacharacters, it is suggested that the entire
318 .Fl m
319 option argument be placed within single quote characters, and that
320 .Xr csh 1
321 users insert a backslash character (``\e'') before any exclamation
322 marks (``!'').
323 .Sh ENVIRONMENT
324 The
325 .Nm
326 command utilizes the
327 .Ev SHELL
328 and
329 .Ev TERM
330 environment variables.
331 .Sh FILES
332 .Bl -tag -width /usr/share/misc/termcap -compact
333 .It Pa /etc/ttys
334 system port name to terminal type mapping database
335 .It Pa /usr/share/misc/termcap
336 terminal capability database
337 .El
338 .Sh COMPATIBILITY
339 The
340 .Fl A ,
341 .Fl E ,
342 .Fl h ,
343 .Fl u
344 and
345 .Fl v
346 options have been deleted from the
347 .Nm
348 utility.
349 None of them were documented in
350 .Bx 4.3
351 and all are of limited utility at
352 best.
353 The
354 .Fl a ,
355 .Fl d
356 and
357 .Fl p
358 options are similarly not documented or useful, but were retained as they
359 appear to be in widespread use.
360 It is strongly recommended that any usage of these three options be
361 changed to use the
362 .Fl m
363 option instead.
364 The
365 .Fl n
366 option remains, but has no effect.
367 It is still permissible to specify the
368 .Fl e ,
369 .Fl i
370 and
371 .Fl k
372 options without arguments, although it is strongly recommended that such
373 usage be fixed to explicitly specify the character.
374 .Pp
375 Executing
376 .Nm
377 as
378 .Nm reset
379 no longer implies the
380 .Fl Q
381 option.
382 Also, the interaction between the
383 .Fl
384 option and the
385 .Ar terminal
386 argument in some historic implementations of
387 .Nm
388 has been removed.
389 .Pp
390 Finally, the
391 .Nm
392 implementation has been completely redone (as part of the addition to the
393 system of a
394 .St -p1003.1-88
395 compliant terminal interface) and will no longer compile on systems with
396 older terminal interfaces.
397 .Sh SEE ALSO
398 .Xr csh 1 ,
399 .Xr sh 1 ,
400 .Xr stty 1 ,
401 .Xr tty 4 ,
402 .Xr termcap 5 ,
403 .Xr ttys 5 ,
404 .Xr environ 7
405 .Sh HISTORY
406 The
407 .Nm
408 command appeared in
409 .Bx 3.0 .