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