2 ****************************************************************************
3 * Copyright (c) 1998-2013,2016 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************
29 * @Id: tset.1,v 1.31 2016/01/30 15:41:41 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <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">
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 <H1 class="no-header">tset 1</H1>
43 <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG> <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>tset</STRONG>, <STRONG>reset</STRONG> - terminal initialization
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53 <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>]
55 <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>]
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61 </PRE><H3><a name="h3-tset---initialization">tset - initialization</a></H3><PRE>
62 <STRONG>Tset</STRONG> initializes terminals. <STRONG>Tset</STRONG> first determines the
63 type of terminal that you are using. This determination
64 is done as follows, using the first terminal type found.
66 1. The <STRONG>terminal</STRONG> argument specified on the command line.
68 2. The value of the <STRONG>TERM</STRONG> environmental variable.
70 3. (BSD systems only.) The terminal type associated with
71 the standard error output device in the <EM>/etc/ttys</EM> file.
72 (On System-V-like UNIXes and systems using that conven-
73 tion, <EM>getty</EM> does this job by setting <STRONG>TERM</STRONG> according to the
74 type passed to it by <EM>/etc/inittab</EM>.)
76 4. The default terminal type, "unknown".
78 If the terminal type was not specified on the command-
79 line, the <STRONG>-m</STRONG> option mappings are then applied (see the
80 section <STRONG>TERMINAL</STRONG> <STRONG>TYPE</STRONG> <STRONG>MAPPING</STRONG> for more information).
81 Then, if the terminal type begins with a question mark
82 ("?"), the user is prompted for confirmation of the termi-
83 nal type. An empty response confirms the type, or,
84 another type can be entered to specify a new type. Once
85 the terminal type has been determined, the terminfo entry
86 for the terminal is retrieved. If no terminfo entry is
87 found for the type, the user is prompted for another ter-
90 Once the terminfo entry is retrieved, the window size,
91 backspace, interrupt and line kill characters (among many
92 other things) are set and the terminal and tab initializa-
93 tion strings are sent to the standard error output.
94 Finally, if the erase, interrupt and line kill characters
95 have changed, or are not set to their default values,
96 their values are displayed to the standard error output.
97 Use the <STRONG>-c</STRONG> or <STRONG>-w</STRONG> option to select only the window sizing
98 versus the other initialization. If neither option is
99 given, both are assumed.
102 </PRE><H3><a name="h3-reset---reinitialization">reset - reinitialization</a></H3><PRE>
103 When invoked as <STRONG>reset</STRONG>, <STRONG>tset</STRONG> sets cooked and echo modes,
104 turns off cbreak and raw modes, turns on newline transla-
105 tion and resets any unset special characters to their
106 default values before doing the terminal initialization
107 described above. This is useful after a program dies
108 leaving a terminal in an abnormal state. Note, you may
111 <STRONG><LF>reset<LF></STRONG>
113 (the line-feed character is normally control-J) to get the
114 terminal to work, as carriage-return may no longer work in
115 the abnormal state. Also, the terminal will often not
119 </PRE><H2><a name="h2-OPTIONS">OPTIONS</a></H2><PRE>
120 The options are as follows:
122 <STRONG>-c</STRONG> Set control characters and modes.
124 <STRONG>-e</STRONG> Set the erase character to <EM>ch</EM>.
126 <STRONG>-I</STRONG> Do not send the terminal or tab initialization
127 strings to the terminal.
129 <STRONG>-i</STRONG> Set the interrupt character to <EM>ch</EM>.
131 <STRONG>-k</STRONG> Set the line kill character to <EM>ch</EM>.
133 <STRONG>-m</STRONG> Specify a mapping from a port type to a terminal.
134 See the section <STRONG>TERMINAL</STRONG> <STRONG>TYPE</STRONG> <STRONG>MAPPING</STRONG> for more infor-
137 <STRONG>-Q</STRONG> Do not display any values for the erase, interrupt
138 and line kill characters. Normally <STRONG>tset</STRONG> displays the
139 values for control characters which differ from the
140 system's default values.
142 <STRONG>-q</STRONG> The terminal type is displayed to the standard out-
143 put, and the terminal is not initialized in any way.
144 The option `-' by itself is equivalent but archaic.
146 <STRONG>-r</STRONG> Print the terminal type to the standard error output.
148 <STRONG>-s</STRONG> Print the sequence of shell commands to initialize
149 the environment variable <STRONG>TERM</STRONG> to the standard output.
150 See the section <STRONG>SETTING</STRONG> <STRONG>THE</STRONG> <STRONG>ENVIRONMENT</STRONG> for details.
152 <STRONG>-V</STRONG> reports the version of ncurses which was used in this
155 <STRONG>-w</STRONG> Resize the window to match the size deduced via
156 <STRONG>setupterm</STRONG>. Normally this has no effect, unless
157 <STRONG>setupterm</STRONG> is not able to detect the window size.
159 The arguments for the <STRONG>-e</STRONG>, <STRONG>-i</STRONG>, and <STRONG>-k</STRONG> options may either be
160 entered as actual characters or by using the `hat' nota-
161 tion, i.e., control-h may be specified as "^H" or "^h".
164 </PRE><H2><a name="h2-SETTING-THE-ENVIRONMENT">SETTING THE ENVIRONMENT</a></H2><PRE>
165 It is often desirable to enter the terminal type and
166 information about the terminal's capabilities into the
167 shell's environment. This is done using the <STRONG>-s</STRONG> option.
169 When the <STRONG>-s</STRONG> option is specified, the commands to enter the
170 information into the shell's environment are written to
171 the standard output. If the <STRONG>SHELL</STRONG> environmental variable
172 ends in "csh", the commands are for <STRONG>csh</STRONG>, otherwise, they
173 are for <STRONG>sh</STRONG>. Note, the <STRONG>csh</STRONG> commands set and unset the
174 shell variable <STRONG>noglob</STRONG>, leaving it unset. The following
175 line in the <STRONG>.login</STRONG> or <STRONG>.profile</STRONG> files will initialize the
176 environment correctly:
178 eval `tset -s options ... `
181 </PRE><H2><a name="h2-TERMINAL-TYPE-MAPPING">TERMINAL TYPE MAPPING</a></H2><PRE>
182 When the terminal is not hardwired into the system (or the
183 current system information is incorrect) the terminal type
184 derived from the <EM>/etc/ttys</EM> file or the <STRONG>TERM</STRONG> environmental
185 variable is often something generic like <STRONG>network</STRONG>, <STRONG>dialup</STRONG>,
186 or <STRONG>unknown</STRONG>. When <STRONG>tset</STRONG> is used in a startup script it is
187 often desirable to provide information about the type of
188 terminal used on such ports.
190 The purpose of the <STRONG>-m</STRONG> option is to map from some set of
191 conditions to a terminal type, that is, to tell <STRONG>tset</STRONG> "If
192 I'm on this port at a particular speed, guess that I'm on
193 that kind of terminal".
195 The argument to the <STRONG>-m</STRONG> option consists of an optional port
196 type, an optional operator, an optional baud rate specifi-
197 cation, an optional colon (":") character and a terminal
198 type. The port type is a string (delimited by either the
199 operator or the colon character). The operator may be any
200 combination of ">", "<", "@", and "!"; ">" means greater
201 than, "<" means less than, "@" means equal to and "!"
202 inverts the sense of the test. The baud rate is specified
203 as a number and is compared with the speed of the standard
204 error output (which should be the control terminal). The
205 terminal type is a string.
207 If the terminal type is not specified on the command line,
208 the <STRONG>-m</STRONG> mappings are applied to the terminal type. If the
209 port type and baud rate match the mapping, the terminal
210 type specified in the mapping replaces the current type.
211 If more than one mapping is specified, the first applica-
214 For example, consider the following mapping:
215 <STRONG>dialup>9600:vt100</STRONG>. The port type is dialup , the operator
216 is >, the baud rate specification is 9600, and the termi-
217 nal type is vt100. The result of this mapping is to spec-
218 ify that if the terminal type is <STRONG>dialup</STRONG>, and the baud rate
219 is greater than 9600 baud, a terminal type of <STRONG>vt100</STRONG> will
222 If no baud rate is specified, the terminal type will match
223 any baud rate. If no port type is specified, the terminal
224 type will match any port type. For example, <STRONG>-m</STRONG>
225 <STRONG>dialup:vt100</STRONG> <STRONG>-m</STRONG> <STRONG>:?xterm</STRONG> will cause any dialup port,
226 regardless of baud rate, to match the terminal type vt100,
227 and any non-dialup port type to match the terminal type
228 ?xterm. Note, because of the leading question mark, the
229 user will be queried on a default port as to whether they
230 are actually using an xterm terminal.
232 No whitespace characters are permitted in the <STRONG>-m</STRONG> option
233 argument. Also, to avoid problems with meta-characters,
234 it is suggested that the entire <STRONG>-m</STRONG> option argument be
235 placed within single quote characters, and that <STRONG>csh</STRONG> users
236 insert a backslash character ("\") before any exclamation
240 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
241 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 <esr@snark.thyr-
247 </PRE><H2><a name="h2-COMPATIBILITY">COMPATIBILITY</a></H2><PRE>
248 The <STRONG>tset</STRONG> utility has been provided for backward-compati-
249 bility with BSD environments (under most modern UNIXes,
250 <STRONG>/etc/inittab</STRONG> and <STRONG>getty(1)</STRONG> can set <STRONG>TERM</STRONG> appropriately for
251 each dial-up line; this obviates what was <STRONG>tset</STRONG>'s most
252 important use). This implementation behaves like 4.4BSD
253 tset, with a few exceptions specified here.
255 The <STRONG>-S</STRONG> option of BSD tset no longer works; it prints an
256 error message to stderr and dies. The <STRONG>-s</STRONG> option only sets
257 <STRONG>TERM</STRONG>, not <STRONG>TERMCAP</STRONG>. Both of these changes are because the
258 <STRONG>TERMCAP</STRONG> variable is no longer supported under terminfo-
259 based <STRONG>ncurses</STRONG>, which makes <STRONG>tset</STRONG> <STRONG>-S</STRONG> useless (we made it die
260 noisily rather than silently induce lossage).
262 There was an undocumented 4.4BSD feature that invoking
263 tset via a link named `TSET` (or via any other name begin-
264 ning with an upper-case letter) set the terminal to use
265 upper-case only. This feature has been omitted.
267 The <STRONG>-A</STRONG>, <STRONG>-E</STRONG>, <STRONG>-h</STRONG>, <STRONG>-u</STRONG> and <STRONG>-v</STRONG> options were deleted from the
268 <STRONG>tset</STRONG> utility in 4.4BSD. None of them were documented in
269 4.3BSD and all are of limited utility at best. The <STRONG>-a</STRONG>,
270 <STRONG>-d</STRONG>, and <STRONG>-p</STRONG> options are similarly not documented or useful,
271 but were retained as they appear to be in widespread use.
272 It is strongly recommended that any usage of these three
273 options be changed to use the <STRONG>-m</STRONG> option instead. The <STRONG>-n</STRONG>
274 option remains, but has no effect. The <STRONG>-adnp</STRONG> options are
275 therefore omitted from the usage summary above.
277 It is still permissible to specify the <STRONG>-e</STRONG>, <STRONG>-i</STRONG>, and <STRONG>-k</STRONG>
278 options without arguments, although it is strongly recom-
279 mended that such usage be fixed to explicitly specify the
282 As of 4.4BSD, executing <STRONG>tset</STRONG> as <STRONG>reset</STRONG> no longer implies
283 the <STRONG>-Q</STRONG> option. Also, the interaction between the - option
284 and the <EM>terminal</EM> argument in some historic implementations
285 of <STRONG>tset</STRONG> has been removed.
288 </PRE><H2><a name="h2-ENVIRONMENT">ENVIRONMENT</a></H2><PRE>
289 The <STRONG>tset</STRONG> command uses these environment variables:
292 tells <STRONG>tset</STRONG> whether to initialize <STRONG>TERM</STRONG> using <STRONG>sh</STRONG> or <STRONG>csh</STRONG>
295 TERM Denotes your terminal type. Each terminal type is
296 distinct, though many are similar.
299 may denote the location of a termcap database. If it
300 is not an absolute pathname, e.g., begins with a `/',
301 <STRONG>tset</STRONG> removes the variable from the environment before
302 looking for the terminal description.
305 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
307 system port name to terminal type mapping database
311 terminal capability database
314 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
315 <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>,
316 <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG>ttys(5)</STRONG>, <STRONG>environ(7)</STRONG>
318 This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20160130).
322 <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>
326 <li><a href="#h2-NAME">NAME</a></li>
327 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
328 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
330 <li><a href="#h3-tset---initialization">tset - initialization</a></li>
331 <li><a href="#h3-reset---reinitialization">reset - reinitialization</a></li>
334 <li><a href="#h2-OPTIONS">OPTIONS</a></li>
335 <li><a href="#h2-SETTING-THE-ENVIRONMENT">SETTING THE ENVIRONMENT</a></li>
336 <li><a href="#h2-TERMINAL-TYPE-MAPPING">TERMINAL TYPE MAPPING</a></li>
337 <li><a href="#h2-HISTORY">HISTORY</a></li>
338 <li><a href="#h2-COMPATIBILITY">COMPATIBILITY</a></li>
339 <li><a href="#h2-ENVIRONMENT">ENVIRONMENT</a></li>
340 <li><a href="#h2-FILES">FILES</a></li>
341 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>