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