blob: 73192cd5efbf20576c1207bc622f6ecd12e05911 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +01003 * Copyright (c) 1998-2011,2013 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05304 * *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
12 * *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
15 * *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
27 * authorization. *
28 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +010029 * @Id: tset.1,v 1.29 2013/12/21 22:15:53 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053030-->
Steve Kondikae271bc2015-11-15 02:50:53 +010031<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053032<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +010034<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053036<TITLE>tset 1</TITLE>
37<link rev=made href="mailto:bug-ncurses@gnu.org">
38<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39</HEAD>
40<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +010041<H1 class="no-header">tset 1</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053042<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053043<STRONG><A HREF="tset.1.html">tset(1)</A></STRONG> <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>
44
45
46
47
48</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010049<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053050 <STRONG>tset</STRONG>, <STRONG>reset</STRONG> - terminal initialization
51
52
53</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010054<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053055 <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>]
56 [<EM>terminal</EM>]
57 <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>]
58 [<EM>terminal</EM>]
59
60
61</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010062<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053063 <STRONG>Tset</STRONG> initializes terminals. <STRONG>Tset</STRONG> first determines the
64 type of terminal that you are using. This determination
65 is done as follows, using the first terminal type found.
66
67 1. The <STRONG>terminal</STRONG> argument specified on the command line.
68
69 2. The value of the <STRONG>TERM</STRONG> environmental variable.
70
71 3. (BSD systems only.) The terminal type associated with
72 the standard error output device in the <EM>/etc/ttys</EM> file.
Steve Kondikae271bc2015-11-15 02:50:53 +010073 (On System-V-like UNIXes and systems using that conven-
74 tion, <EM>getty</EM> does this job by setting <STRONG>TERM</STRONG> according to the
75 type passed to it by <EM>/etc/inittab</EM>.)
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053076
Steve Kondikae271bc2015-11-15 02:50:53 +010077 4. The default terminal type, "unknown".
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053078
79 If the terminal type was not specified on the command-
80 line, the <STRONG>-m</STRONG> option mappings are then applied (see the
81 section <STRONG>TERMINAL</STRONG> <STRONG>TYPE</STRONG> <STRONG>MAPPING</STRONG> for more information).
82 Then, if the terminal type begins with a question mark
Steve Kondikae271bc2015-11-15 02:50:53 +010083 ("?"), the user is prompted for confirmation of the termi-
84 nal type. An empty response confirms the type, or,
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053085 another type can be entered to specify a new type. Once
86 the terminal type has been determined, the terminfo entry
87 for the terminal is retrieved. If no terminfo entry is
88 found for the type, the user is prompted for another ter-
89 minal type.
90
91 Once the terminfo entry is retrieved, the window size,
92 backspace, interrupt and line kill characters (among many
93 other things) are set and the terminal and tab initializa-
94 tion strings are sent to the standard error output.
95 Finally, if the erase, interrupt and line kill characters
96 have changed, or are not set to their default values,
97 their values are displayed to the standard error output.
98 Use the <STRONG>-c</STRONG> or <STRONG>-w</STRONG> option to select only the window sizing
99 versus the other initialization. If neither option is
100 given, both are assumed.
101
102 When invoked as <STRONG>reset</STRONG>, <STRONG>tset</STRONG> sets cooked and echo modes,
103 turns off cbreak and raw modes, turns on newline transla-
104 tion and resets any unset special characters to their
105 default values before doing the terminal initialization
106 described above. This is useful after a program dies
107 leaving a terminal in an abnormal state. Note, you may
108 have to type
109
110 <STRONG>&lt;LF&gt;reset&lt;LF&gt;</STRONG>
111
112 (the line-feed character is normally control-J) to get the
113 terminal to work, as carriage-return may no longer work in
114 the abnormal state. Also, the terminal will often not
115 echo the command.
116
117 The options are as follows:
118
Steve Kondikae271bc2015-11-15 02:50:53 +0100119 <STRONG>-c</STRONG> Set control characters and modes.
120
121 <STRONG>-e</STRONG> Set the erase character to <EM>ch</EM>.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530122
123 <STRONG>-I</STRONG> Do not send the terminal or tab initialization
124 strings to the terminal.
125
126 <STRONG>-i</STRONG> Set the interrupt character to <EM>ch</EM>.
127
128 <STRONG>-k</STRONG> Set the line kill character to <EM>ch</EM>.
129
Steve Kondikae271bc2015-11-15 02:50:53 +0100130 <STRONG>-m</STRONG> Specify a mapping from a port type to a terminal.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530131 See the section <STRONG>TERMINAL</STRONG> <STRONG>TYPE</STRONG> <STRONG>MAPPING</STRONG> for more infor-
132 mation.
133
Steve Kondikae271bc2015-11-15 02:50:53 +0100134 <STRONG>-Q</STRONG> Do not display any values for the erase, interrupt
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530135 and line kill characters. Normally <STRONG>tset</STRONG> displays the
Steve Kondikae271bc2015-11-15 02:50:53 +0100136 values for control characters which differ from the
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530137 system's default values.
138
Steve Kondikae271bc2015-11-15 02:50:53 +0100139 <STRONG>-q</STRONG> The terminal type is displayed to the standard out-
140 put, and the terminal is not initialized in any way.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530141 The option `-' by itself is equivalent but archaic.
142
143 <STRONG>-r</STRONG> Print the terminal type to the standard error output.
144
145 <STRONG>-s</STRONG> Print the sequence of shell commands to initialize
146 the environment variable <STRONG>TERM</STRONG> to the standard output.
Steve Kondikae271bc2015-11-15 02:50:53 +0100147 See the section <STRONG>SETTING</STRONG> <STRONG>THE</STRONG> <STRONG>ENVIRONMENT</STRONG> for details.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530148
149 <STRONG>-V</STRONG> reports the version of ncurses which was used in this
150 program, and exits.
151
Steve Kondikae271bc2015-11-15 02:50:53 +0100152 <STRONG>-w</STRONG> Resize the window to match the size deduced via
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530153 <STRONG>setupterm</STRONG>. Normally this has no effect, unless
154 <STRONG>setupterm</STRONG> is not able to detect the window size.
155
156 The arguments for the <STRONG>-e</STRONG>, <STRONG>-i</STRONG>, and <STRONG>-k</STRONG> options may either be
Steve Kondikae271bc2015-11-15 02:50:53 +0100157 entered as actual characters or by using the `hat' nota-
158 tion, i.e., control-h may be specified as "^H" or "^h".
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530159
160
161</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100162<H2><a name="h2-SETTING-THE-ENVIRONMENT">SETTING THE ENVIRONMENT</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530163 It is often desirable to enter the terminal type and
164 information about the terminal's capabilities into the
165 shell's environment. This is done using the <STRONG>-s</STRONG> option.
166
167 When the <STRONG>-s</STRONG> option is specified, the commands to enter the
168 information into the shell's environment are written to
169 the standard output. If the <STRONG>SHELL</STRONG> environmental variable
Steve Kondikae271bc2015-11-15 02:50:53 +0100170 ends in "csh", the commands are for <STRONG>csh</STRONG>, otherwise, they
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530171 are for <STRONG>sh</STRONG>. Note, the <STRONG>csh</STRONG> commands set and unset the
172 shell variable <STRONG>noglob</STRONG>, leaving it unset. The following
173 line in the <STRONG>.login</STRONG> or <STRONG>.profile</STRONG> files will initialize the
174 environment correctly:
175
176 eval `tset -s options ... `
177
178
179</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100180<H2><a name="h2-TERMINAL-TYPE-MAPPING">TERMINAL TYPE MAPPING</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530181 When the terminal is not hardwired into the system (or the
182 current system information is incorrect) the terminal type
183 derived from the <EM>/etc/ttys</EM> file or the <STRONG>TERM</STRONG> environmental
184 variable is often something generic like <STRONG>network</STRONG>, <STRONG>dialup</STRONG>,
185 or <STRONG>unknown</STRONG>. When <STRONG>tset</STRONG> is used in a startup script it is
186 often desirable to provide information about the type of
187 terminal used on such ports.
188
189 The purpose of the <STRONG>-m</STRONG> option is to map from some set of
Steve Kondikae271bc2015-11-15 02:50:53 +0100190 conditions to a terminal type, that is, to tell <STRONG>tset</STRONG> "If
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530191 I'm on this port at a particular speed, guess that I'm on
Steve Kondikae271bc2015-11-15 02:50:53 +0100192 that kind of terminal".
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530193
194 The argument to the <STRONG>-m</STRONG> option consists of an optional port
195 type, an optional operator, an optional baud rate specifi-
Steve Kondikae271bc2015-11-15 02:50:53 +0100196 cation, an optional colon (":") character and a terminal
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530197 type. The port type is a string (delimited by either the
198 operator or the colon character). The operator may be any
Steve Kondikae271bc2015-11-15 02:50:53 +0100199 combination of "&gt;", "&lt;", "@", and "!"; "&gt;" means greater
200 than, "&lt;" means less than, "@" means equal to and "!"
201 inverts the sense of the test. The baud rate is specified
202 as a number and is compared with the speed of the standard
203 error output (which should be the control terminal). The
204 terminal type is a string.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530205
206 If the terminal type is not specified on the command line,
207 the <STRONG>-m</STRONG> mappings are applied to the terminal type. If the
208 port type and baud rate match the mapping, the terminal
209 type specified in the mapping replaces the current type.
210 If more than one mapping is specified, the first applica-
211 ble mapping is used.
212
213 For example, consider the following mapping:
214 <STRONG>dialup&gt;9600:vt100</STRONG>. The port type is dialup , the operator
215 is &gt;, the baud rate specification is 9600, and the termi-
216 nal type is vt100. The result of this mapping is to spec-
217 ify that if the terminal type is <STRONG>dialup</STRONG>, and the baud rate
218 is greater than 9600 baud, a terminal type of <STRONG>vt100</STRONG> will
219 be used.
220
221 If no baud rate is specified, the terminal type will match
222 any baud rate. If no port type is specified, the terminal
223 type will match any port type. For example, <STRONG>-m</STRONG>
224 <STRONG>dialup:vt100</STRONG> <STRONG>-m</STRONG> <STRONG>:?xterm</STRONG> will cause any dialup port,
225 regardless of baud rate, to match the terminal type vt100,
226 and any non-dialup port type to match the terminal type
227 ?xterm. Note, because of the leading question mark, the
228 user will be queried on a default port as to whether they
229 are actually using an xterm terminal.
230
231 No whitespace characters are permitted in the <STRONG>-m</STRONG> option
232 argument. Also, to avoid problems with meta-characters,
233 it is suggested that the entire <STRONG>-m</STRONG> option argument be
234 placed within single quote characters, and that <STRONG>csh</STRONG> users
Steve Kondikae271bc2015-11-15 02:50:53 +0100235 insert a backslash character ("\") before any exclamation
236 marks ("!").
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530237
238
239</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100240<H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530241 The <STRONG>tset</STRONG> command appeared in BSD 3.0. The <STRONG>ncurses</STRONG> imple-
242 mentation was lightly adapted from the 4.4BSD sources for
243 a terminfo environment by Eric S. Raymond &lt;esr@snark.thyr-
244 sus.com&gt;.
245
246
247</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100248<H2><a name="h2-COMPATIBILITY">COMPATIBILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530249 The <STRONG>tset</STRONG> utility has been provided for backward-compati-
250 bility with BSD environments (under most modern UNIXes,
Steve Kondikae271bc2015-11-15 02:50:53 +0100251 <STRONG>/etc/inittab</STRONG> and <STRONG>getty(1)</STRONG> can set <STRONG>TERM</STRONG> appropriately for
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530252 each dial-up line; this obviates what was <STRONG>tset</STRONG>'s most
253 important use). This implementation behaves like 4.4BSD
254 tset, with a few exceptions specified here.
255
256 The <STRONG>-S</STRONG> option of BSD tset no longer works; it prints an
257 error message to stderr and dies. The <STRONG>-s</STRONG> option only sets
Steve Kondikae271bc2015-11-15 02:50:53 +0100258 <STRONG>TERM</STRONG>, not <STRONG>TERMCAP</STRONG>. Both of these changes are because the
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530259 <STRONG>TERMCAP</STRONG> variable is no longer supported under terminfo-
260 based <STRONG>ncurses</STRONG>, which makes <STRONG>tset</STRONG> <STRONG>-S</STRONG> useless (we made it die
261 noisily rather than silently induce lossage).
262
263 There was an undocumented 4.4BSD feature that invoking
264 tset via a link named `TSET` (or via any other name begin-
265 ning with an upper-case letter) set the terminal to use
266 upper-case only. This feature has been omitted.
267
268 The <STRONG>-A</STRONG>, <STRONG>-E</STRONG>, <STRONG>-h</STRONG>, <STRONG>-u</STRONG> and <STRONG>-v</STRONG> options were deleted from the
269 <STRONG>tset</STRONG> utility in 4.4BSD. None of them were documented in
270 4.3BSD and all are of limited utility at best. The <STRONG>-a</STRONG>,
271 <STRONG>-d</STRONG>, and <STRONG>-p</STRONG> options are similarly not documented or useful,
272 but were retained as they appear to be in widespread use.
273 It is strongly recommended that any usage of these three
Steve Kondikae271bc2015-11-15 02:50:53 +0100274 options be changed to use the <STRONG>-m</STRONG> option instead. The <STRONG>-n</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530275 option remains, but has no effect. The <STRONG>-adnp</STRONG> options are
276 therefore omitted from the usage summary above.
277
278 It is still permissible to specify the <STRONG>-e</STRONG>, <STRONG>-i</STRONG>, and <STRONG>-k</STRONG>
279 options without arguments, although it is strongly recom-
280 mended that such usage be fixed to explicitly specify the
281 character.
282
283 As of 4.4BSD, executing <STRONG>tset</STRONG> as <STRONG>reset</STRONG> no longer implies
284 the <STRONG>-Q</STRONG> option. Also, the interaction between the - option
285 and the <EM>terminal</EM> argument in some historic implementations
286 of <STRONG>tset</STRONG> has been removed.
287
288
289</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100290<H2><a name="h2-ENVIRONMENT">ENVIRONMENT</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530291 The <STRONG>tset</STRONG> command uses these environment variables:
292
293 SHELL
294 tells <STRONG>tset</STRONG> whether to initialize <STRONG>TERM</STRONG> using <STRONG>sh</STRONG> or <STRONG>csh</STRONG>
295 syntax.
296
297 TERM Denotes your terminal type. Each terminal type is
298 distinct, though many are similar.
299
300 TERMCAP
301 may denote the location of a termcap database. If it
302 is not an absolute pathname, e.g., begins with a `/',
303 <STRONG>tset</STRONG> removes the variable from the environment before
304 looking for the terminal description.
305
306
307</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100308<H2><a name="h2-FILES">FILES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530309 /etc/ttys
310 system port name to terminal type mapping database
311 (BSD versions only).
312
313 /usr/share/terminfo
314 terminal capability database
315
316
317</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100318<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
319 <STRONG>csh(1)</STRONG>, <STRONG>sh(1)</STRONG>, <STRONG>stty(1)</STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG>tty(4)</STRONG>,
320 <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG>ttys(5)</STRONG>, <STRONG>environ(7)</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530321
Steve Kondikae271bc2015-11-15 02:50:53 +0100322 This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20150808).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530323
324
325
326 <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>
327</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100328<div class="nav">
329<ul>
330<li><a href="#h2-NAME">NAME</a></li>
331<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
332<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
333<li><a href="#h2-SETTING-THE-ENVIRONMENT">SETTING THE ENVIRONMENT</a></li>
334<li><a href="#h2-TERMINAL-TYPE-MAPPING">TERMINAL TYPE MAPPING</a></li>
335<li><a href="#h2-HISTORY">HISTORY</a></li>
336<li><a href="#h2-COMPATIBILITY">COMPATIBILITY</a></li>
337<li><a href="#h2-ENVIRONMENT">ENVIRONMENT</a></li>
338<li><a href="#h2-FILES">FILES</a></li>
339<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
340</ul>
341</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530342</BODY>
343</HTML>