usr.bin/tset/tset.1

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