tset.1.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  2. <!--
  3. ****************************************************************************
  4. * Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. *
  5. * *
  6. * Permission is hereby granted, free of charge, to any person obtaining a *
  7. * copy of this software and associated documentation files (the *
  8. * "Software"), to deal in the Software without restriction, including *
  9. * without limitation the rights to use, copy, modify, merge, publish, *
  10. * distribute, distribute with modifications, sublicense, and/or sell *
  11. * copies of the Software, and to permit persons to whom the Software is *
  12. * furnished to do so, subject to the following conditions: *
  13. * *
  14. * The above copyright notice and this permission notice shall be included *
  15. * in all copies or substantial portions of the Software. *
  16. * *
  17. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
  18. * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
  19. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
  20. * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
  21. * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
  22. * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
  23. * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
  24. * *
  25. * Except as contained in this notice, the name(s) of the above copyright *
  26. * holders shall not be used in advertising or otherwise to promote the *
  27. * sale, use or other dealings in this Software without prior written *
  28. * authorization. *
  29. ****************************************************************************
  30. * @Id: tset.1,v 1.19 2006/12/24 15:00:30 tom Exp @
  31. -->
  32. <HTML>
  33. <HEAD>
  34. <TITLE>tset 1</TITLE>
  35. <link rev=made href="mailto:bug-ncurses@gnu.org">
  36. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  37. </HEAD>
  38. <BODY>
  39. <H1>tset 1</H1>
  40. <HR>
  41. <PRE>
  42. <!-- Manpage converted by man2html 3.0.1 -->
  43. <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG> <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>
  44. </PRE>
  45. <H2>NAME</H2><PRE>
  46. <STRONG>tset</STRONG>, <STRONG>reset</STRONG> - terminal initialization
  47. </PRE>
  48. <H2>SYNOPSIS</H2><PRE>
  49. <STRONG>tset</STRONG> [<STRONG>-IQVcqrsw</STRONG>] [<STRONG>-</STRONG>] [<STRONG>-e</STRONG> <EM>ch</EM>] [<STRONG>-i</STRONG> <EM>ch</EM>] [<STRONG>-k</STRONG> <EM>ch</EM>] [<STRONG>-m</STRONG> <EM>mapping</EM>]
  50. [<EM>terminal</EM>]
  51. <STRONG>reset</STRONG> [<STRONG>-IQVcqrsw</STRONG>] [<STRONG>-</STRONG>] [<STRONG>-e</STRONG> <EM>ch</EM>] [<STRONG>-i</STRONG> <EM>ch</EM>] [<STRONG>-k</STRONG> <EM>ch</EM>] [<STRONG>-m</STRONG> <EM>mapping</EM>]
  52. [<EM>terminal</EM>]
  53. </PRE>
  54. <H2>DESCRIPTION</H2><PRE>
  55. <STRONG>Tset</STRONG> initializes terminals. <STRONG>Tset</STRONG> first determines the
  56. type of terminal that you are using. This determination
  57. is done as follows, using the first terminal type found.
  58. 1. The <STRONG>terminal</STRONG> argument specified on the command line.
  59. 2. The value of the <STRONG>TERM</STRONG> environmental variable.
  60. 3. (BSD systems only.) The terminal type associated with
  61. the standard error output device in the <EM>/etc/ttys</EM> file.
  62. (On Linux and System-V-like UNIXes, <EM>getty</EM> does this job by
  63. setting <STRONG>TERM</STRONG> according to the type passed to it by
  64. <EM>/etc/inittab</EM>.)
  65. 4. The default terminal type, ``unknown''.
  66. If the terminal type was not specified on the command-
  67. line, the <STRONG>-m</STRONG> option mappings are then applied (see the
  68. section <STRONG>TERMINAL</STRONG> <STRONG>TYPE</STRONG> <STRONG>MAPPING</STRONG> for more information).
  69. Then, if the terminal type begins with a question mark
  70. (``?''), the user is prompted for confirmation of the ter-
  71. minal type. An empty response confirms the type, or,
  72. another type can be entered to specify a new type. Once
  73. the terminal type has been determined, the terminfo entry
  74. for the terminal is retrieved. If no terminfo entry is
  75. found for the type, the user is prompted for another ter-
  76. minal type.
  77. Once the terminfo entry is retrieved, the window size,
  78. backspace, interrupt and line kill characters (among many
  79. other things) are set and the terminal and tab initializa-
  80. tion strings are sent to the standard error output.
  81. Finally, if the erase, interrupt and line kill characters
  82. have changed, or are not set to their default values,
  83. their values are displayed to the standard error output.
  84. Use the <STRONG>-c</STRONG> or <STRONG>-w</STRONG> option to select only the window sizing
  85. versus the other initialization. If neither option is
  86. given, both are assumed.
  87. When invoked as <STRONG>reset</STRONG>, <STRONG>tset</STRONG> sets cooked and echo modes,
  88. turns off cbreak and raw modes, turns on newline transla-
  89. tion and resets any unset special characters to their
  90. default values before doing the terminal initialization
  91. described above. This is useful after a program dies
  92. leaving a terminal in an abnormal state. Note, you may
  93. have to type
  94. <STRONG>&lt;LF&gt;reset&lt;LF&gt;</STRONG>
  95. (the line-feed character is normally control-J) to get the
  96. terminal to work, as carriage-return may no longer work in
  97. the abnormal state. Also, the terminal will often not
  98. echo the command.
  99. The options are as follows:
  100. <STRONG>-c</STRONG> Set control characters and modes. <STRONG>-e</STRONG> Set the erase
  101. character to <EM>ch</EM>.
  102. <STRONG>-I</STRONG> Do not send the terminal or tab initialization
  103. strings to the terminal.
  104. <STRONG>-i</STRONG> Set the interrupt character to <EM>ch</EM>.
  105. <STRONG>-k</STRONG> Set the line kill character to <EM>ch</EM>.
  106. <STRONG>-m</STRONG> Specify a mapping from a port type to a terminal.
  107. See the section <STRONG>TERMINAL</STRONG> <STRONG>TYPE</STRONG> <STRONG>MAPPING</STRONG> for more infor-
  108. mation.
  109. <STRONG>-Q</STRONG> Do not display any values for the erase, interrupt
  110. and line kill characters. Normally <STRONG>tset</STRONG> displays the
  111. values for control characters which differ from the
  112. system's default values.
  113. <STRONG>-q</STRONG> The terminal type is displayed to the standard out-
  114. put, and the terminal is not initialized in any way.
  115. The option `-' by itself is equivalent but archaic.
  116. <STRONG>-r</STRONG> Print the terminal type to the standard error output.
  117. <STRONG>-s</STRONG> Print the sequence of shell commands to initialize
  118. the environment variable <STRONG>TERM</STRONG> to the standard output.
  119. See the section <STRONG>SETTING</STRONG> <STRONG>THE</STRONG> <STRONG>ENVIRONMENT</STRONG> for details.
  120. <STRONG>-V</STRONG> reports the version of ncurses which was used in this
  121. program, and exits.
  122. <STRONG>-w</STRONG> Resize the window to match the size deduced via
  123. <STRONG>setupterm</STRONG>. Normally this has no effect, unless
  124. <STRONG>setupterm</STRONG> is not able to detect the window size.
  125. The arguments for the <STRONG>-e</STRONG>, <STRONG>-i</STRONG>, and <STRONG>-k</STRONG> options may either be
  126. entered as actual characters or by using the `hat' nota-
  127. tion, i.e. control-h may be specified as ``^H'' or ``^h''.
  128. </PRE>
  129. <H2>SETTING THE ENVIRONMENT</H2><PRE>
  130. It is often desirable to enter the terminal type and
  131. information about the terminal's capabilities into the
  132. shell's environment. This is done using the <STRONG>-s</STRONG> option.
  133. When the <STRONG>-s</STRONG> option is specified, the commands to enter the
  134. information into the shell's environment are written to
  135. the standard output. If the <STRONG>SHELL</STRONG> environmental variable
  136. ends in ``csh'', the commands are for <STRONG>csh</STRONG>, otherwise, they
  137. are for <STRONG>sh</STRONG>. Note, the <STRONG>csh</STRONG> commands set and unset the
  138. shell variable <STRONG>noglob</STRONG>, leaving it unset. The following
  139. line in the <STRONG>.login</STRONG> or <STRONG>.profile</STRONG> files will initialize the
  140. environment correctly:
  141. eval `tset -s options ... `
  142. </PRE>
  143. <H2>TERMINAL TYPE MAPPING</H2><PRE>
  144. When the terminal is not hardwired into the system (or the
  145. current system information is incorrect) the terminal type
  146. derived from the <EM>/etc/ttys</EM> file or the <STRONG>TERM</STRONG> environmental
  147. variable is often something generic like <STRONG>network</STRONG>, <STRONG>dialup</STRONG>,
  148. or <STRONG>unknown</STRONG>. When <STRONG>tset</STRONG> is used in a startup script it is
  149. often desirable to provide information about the type of
  150. terminal used on such ports.
  151. The purpose of the <STRONG>-m</STRONG> option is to map from some set of
  152. conditions to a terminal type, that is, to tell <STRONG>tset</STRONG> ``If
  153. I'm on this port at a particular speed, guess that I'm on
  154. that kind of terminal''.
  155. The argument to the <STRONG>-m</STRONG> option consists of an optional port
  156. type, an optional operator, an optional baud rate specifi-
  157. cation, an optional colon (``:'') character and a terminal
  158. type. The port type is a string (delimited by either the
  159. operator or the colon character). The operator may be any
  160. combination of ``&gt;'', ``&lt;'', ``@'', and ``!''; ``&gt;'' means
  161. greater than, ``&lt;'' means less than, ``@'' means equal to
  162. and ``!'' inverts the sense of the test. The baud rate is
  163. specified as a number and is compared with the speed of
  164. the standard error output (which should be the control
  165. terminal). The terminal type is a string.
  166. If the terminal type is not specified on the command line,
  167. the <STRONG>-m</STRONG> mappings are applied to the terminal type. If the
  168. port type and baud rate match the mapping, the terminal
  169. type specified in the mapping replaces the current type.
  170. If more than one mapping is specified, the first applica-
  171. ble mapping is used.
  172. For example, consider the following mapping:
  173. <STRONG>dialup&gt;9600:vt100</STRONG>. The port type is dialup , the operator
  174. is &gt;, the baud rate specification is 9600, and the termi-
  175. nal type is vt100. The result of this mapping is to spec-
  176. ify that if the terminal type is <STRONG>dialup</STRONG>, and the baud rate
  177. is greater than 9600 baud, a terminal type of <STRONG>vt100</STRONG> will
  178. be used.
  179. If no baud rate is specified, the terminal type will match
  180. any baud rate. If no port type is specified, the terminal
  181. type will match any port type. For example, <STRONG>-m</STRONG>
  182. <STRONG>dialup:vt100</STRONG> <STRONG>-m</STRONG> <STRONG>:?xterm</STRONG> will cause any dialup port,
  183. regardless of baud rate, to match the terminal type vt100,
  184. and any non-dialup port type to match the terminal type
  185. ?xterm. Note, because of the leading question mark, the
  186. user will be queried on a default port as to whether they
  187. are actually using an xterm terminal.
  188. No whitespace characters are permitted in the <STRONG>-m</STRONG> option
  189. argument. Also, to avoid problems with meta-characters,
  190. it is suggested that the entire <STRONG>-m</STRONG> option argument be
  191. placed within single quote characters, and that <STRONG>csh</STRONG> users
  192. insert a backslash character (``\'') before any exclama-
  193. tion marks (``!'').
  194. </PRE>
  195. <H2>HISTORY</H2><PRE>
  196. The <STRONG>tset</STRONG> command appeared in BSD 3.0. The <STRONG>ncurses</STRONG> imple-
  197. mentation was lightly adapted from the 4.4BSD sources for
  198. a terminfo environment by Eric S. Raymond &lt;esr@snark.thyr-
  199. sus.com&gt;.
  200. </PRE>
  201. <H2>COMPATIBILITY</H2><PRE>
  202. The <STRONG>tset</STRONG> utility has been provided for backward-compati-
  203. bility with BSD environments (under most modern UNIXes,
  204. <STRONG>/etc/inittab</STRONG> and <STRONG><A HREF="getty.1.html">getty(1)</A></STRONG> can set <STRONG>TERM</STRONG> appropriately for
  205. each dial-up line; this obviates what was <STRONG>tset</STRONG>'s most
  206. important use). This implementation behaves like 4.4BSD
  207. tset, with a few exceptions specified here.
  208. The <STRONG>-S</STRONG> option of BSD tset no longer works; it prints an
  209. error message to stderr and dies. The <STRONG>-s</STRONG> option only sets
  210. <STRONG>TERM</STRONG>, not <STRONG>TERMCAP</STRONG>. Both these changes are because the
  211. <STRONG>TERMCAP</STRONG> variable is no longer supported under terminfo-
  212. based <STRONG>ncurses</STRONG>, which makes <STRONG>tset</STRONG> <STRONG>-S</STRONG> useless (we made it die
  213. noisily rather than silently induce lossage).
  214. There was an undocumented 4.4BSD feature that invoking
  215. tset via a link named `TSET` (or via any other name begin-
  216. ning with an upper-case letter) set the terminal to use
  217. upper-case only. This feature has been omitted.
  218. The <STRONG>-A</STRONG>, <STRONG>-E</STRONG>, <STRONG>-h</STRONG>, <STRONG>-u</STRONG> and <STRONG>-v</STRONG> options were deleted from the
  219. <STRONG>tset</STRONG> utility in 4.4BSD. None of them were documented in
  220. 4.3BSD and all are of limited utility at best. The <STRONG>-a</STRONG>,
  221. <STRONG>-d</STRONG>, and <STRONG>-p</STRONG> options are similarly not documented or useful,
  222. but were retained as they appear to be in widespread use.
  223. It is strongly recommended that any usage of these three
  224. options be changed to use the <STRONG>-m</STRONG> option instead. The -n
  225. option remains, but has no effect. The <STRONG>-adnp</STRONG> options are
  226. therefore omitted from the usage summary above.
  227. It is still permissible to specify the <STRONG>-e</STRONG>, <STRONG>-i</STRONG>, and <STRONG>-k</STRONG>
  228. options without arguments, although it is strongly recom-
  229. mended that such usage be fixed to explicitly specify the
  230. character.
  231. As of 4.4BSD, executing <STRONG>tset</STRONG> as <STRONG>reset</STRONG> no longer implies
  232. the <STRONG>-Q</STRONG> option. Also, the interaction between the - option
  233. and the <EM>terminal</EM> argument in some historic implementations
  234. of <STRONG>tset</STRONG> has been removed.
  235. </PRE>
  236. <H2>ENVIRONMENT</H2><PRE>
  237. The <STRONG>tset</STRONG> command uses these environment variables:
  238. SHELL
  239. tells <STRONG>tset</STRONG> whether to initialize <STRONG>TERM</STRONG> using <STRONG>sh</STRONG> or <STRONG>csh</STRONG>
  240. syntax.
  241. TERM Denotes your terminal type. Each terminal type is
  242. distinct, though many are similar.
  243. TERMCAP
  244. may denote the location of a termcap database. If it
  245. is not an absolute pathname, e.g., begins with a `/',
  246. <STRONG>tset</STRONG> removes the variable from the environment before
  247. looking for the terminal description.
  248. </PRE>
  249. <H2>FILES</H2><PRE>
  250. /etc/ttys
  251. system port name to terminal type mapping database
  252. (BSD versions only).
  253. /usr/share/terminfo
  254. terminal capability database
  255. </PRE>
  256. <H2>SEE ALSO</H2><PRE>
  257. <STRONG><A HREF="csh.1.html">csh(1)</A></STRONG>, <STRONG><A HREF="sh.1.html">sh(1)</A></STRONG>, <STRONG><A HREF="stty.1.html">stty(1)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG><A HREF="tty.4.html">tty(4)</A></STRONG>, ter-
  258. <STRONG><A HREF="minfo.5.html">minfo(5)</A></STRONG>, <STRONG><A HREF="ttys.5.html">ttys(5)</A></STRONG>, <STRONG><A HREF="environ.7.html">environ(7)</A></STRONG>
  259. This describes <STRONG>ncurses</STRONG> version 5.6 (patch 20081011).
  260. <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>
  261. </PRE>
  262. <HR>
  263. <ADDRESS>
  264. Man(1) output converted with
  265. <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  266. </ADDRESS>
  267. </BODY>
  268. </HTML>