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