Blame - doc/html/man/tset.1.html - android_external_libncurses

2025-07-08 18:04:53 -0400

[diff] [blame]

1

<!--

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

2

****************************************************************************

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

3

4

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

5

* *

6

* Permission is hereby granted, free of charge, to any person obtaining a *

7

* copy of this software and associated documentation files (the *

8

* "Software"), to deal in the Software without restriction, including *

9

* without limitation the rights to use, copy, modify, merge, publish, *

10

* distribute, distribute with modifications, sublicense, and/or sell *

11

* copies of the Software, and to permit persons to whom the Software is *

12

* furnished to do so, subject to the following conditions: *

13

* *

14

* The above copyright notice and this permission notice shall be included *

15

* in all copies or substantial portions of the Software. *

16

* *

17

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *

18

* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *

19

* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *

20

* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *

21

* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *

22

* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *

23

* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

24

* *

25

* Except as contained in this notice, the name(s) of the above copyright *

26

* holders shall not be used in advertising or otherwise to promote the *

27

* sale, use or other dealings in this Software without prior written *

28

* authorization. *

29

****************************************************************************

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

30

* @Id: tset.1,v 1.85 2024/04/27 17:57:47 tom Exp @

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

31

-->

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

32

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

33

<HTML>

34

<HEAD>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

35

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

36

37

<TITLE>tset 1 2024-04-27 ncurses 6.5 User commands</TITLE>

38

39

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

40

</HEAD>

41

<BODY>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

42

<H1 class="no-header">tset 1 2024-04-27 ncurses 6.5 User commands</H1>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

43

<PRE>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

44

<A HREF="tset.1.html">tset(1)</A> User commands <A HREF="tset.1.html">tset(1)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

49

</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>

50

tset, reset - initialize or reset terminal state

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

51

52

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

53

</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>

54

tset [-IQVcqrsw] [-] [-e ch] [-i ch] [-k ch] [-m mapping] [terminal-

55

type]

56

reset [-IQVcqrsw] [-] [-e ch] [-i ch] [-k ch] [-m mapping] [terminal-

57

type]

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

58

59

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

60

</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>

61

62

</PRE><H3><a name="h3-tset----initialization">tset -- initialization</a></H3><PRE>

63

This program initializes terminals.

64

65

First, tset retrieves the current terminal mode settings for your

66

terminal. It does this by successively testing

67

68

o the standard error,

o standard output,

o standard input and

o ultimately "/dev/tty"

75

76

to obtain terminal settings. Having retrieved these settings, tset

77

remembers which file descriptor to use when updating settings.

78

79

Next, tset determines the type of terminal that you are using. This

80

determination is done as follows, using the first terminal type found.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

81

82

1. The terminal argument specified on the command line.

83

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

84

2. The value of the TERM environment variable.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

85

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

86

3. (BSD systems only.) The terminal type associated with the standard

87

error output device in the /etc/ttys file. (On System V hosts and

88

systems using that convention, getty(8) does this job by setting TERM

89

according to the type passed to it by /etc/inittab.)

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

90

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

91

4. The default terminal type, "unknown", is not suitable for curses

92

applications.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

93

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

94

If the terminal type was not specified on the command-line, the -m

95

option mappings are then applied; see subsection "Terminal Type

96

Mapping". Then, if the terminal type begins with a question mark

97

("?"), the user is prompted for confirmation of the terminal type. An

98

empty response confirms the type, or, another type can be entered to

99

specify a new type. Once the terminal type has been determined, the

100

terminal description for the terminal is retrieved. If no terminal

101

description is found for the type, the user is prompted for another

102

terminal type.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

103

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

104

Once the terminal description is retrieved,

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

105

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

106

o if the "-w" option is enabled, tset may update the terminal's

107

window size.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

108

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

109

If the window size cannot be obtained from the operating system,

110

but the terminal description (or environment, e.g., LINES and

111

COLUMNS variables specify this), use this to set the operating

112

system's notion of the window size.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

113

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

114

o if the "-c" option is enabled, the backspace, interrupt and line

115

kill characters (among many other things) are set

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

116

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

117

o unless the "-I" option is enabled, the terminal and tab

118

initialization strings are sent to the standard error output, and

119

tset waits one second (in case a hardware reset was issued).

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

120

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

121

o Finally, if the erase, interrupt and line kill characters have

122

changed, or are not set to their default values, their values are

123

displayed to the standard error output.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

124

125

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

126

</PRE><H3><a name="h3-reset----reinitialization">reset -- reinitialization</a></H3><PRE>

127

When invoked as reset, tset sets the terminal modes to "sane" values:

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

128

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

129

o sets cooked and echo modes,

130

131

o turns off cbreak and raw modes,

132

133

o turns on newline translation and

134

135

o resets any unset special characters to their default values

136

137

before doing the terminal initialization described above. Also, rather

138

than using the terminal initialization strings, it uses the terminal

139

reset strings.

140

141

The reset command is useful after a program dies leaving a terminal in

142

an abnormal state:

143

144

o you may have to type

<LF>reset<LF>

(the line-feed character is normally control-J) to get the terminal

149

to work, as carriage-return may no longer work in the abnormal

150

state.

151

152

o Also, the terminal will often not echo the command.

153

154

155

</PRE><H3><a name="h3-Setting-the-Environment">Setting the Environment</a></H3><PRE>

156

It is often desirable to enter the terminal type and information about

157

the terminal's capabilities into the shell's environment. This is done

158

using the -s option.

159

160

When the -s option is specified, the commands to enter the information

161

into the shell's environment are written to the standard output. If

162

the SHELL environment variable ends in "csh", the commands are for

163

csh(1), otherwise, they are for sh(1). The csh commands set and unset

164

the shell variable noglob, leaving it unset. The following line in the

165

.login or .profile files will initialize the environment correctly:

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

166

167

eval `tset -s options ... `

168

169

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

170

</PRE><H3><a name="h3-Terminal-Type-Mapping">Terminal Type Mapping</a></H3><PRE>

171

When the terminal is not hardwired into the system (or the current

172

system information is incorrect) the terminal type derived from the

173

/etc/ttys file or the TERM environment variable is often something

174

generic like network, dialup, or unknown. When tset is used in a

175

startup script it is often desirable to provide information about the

176

type of terminal used on such ports.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

177

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

178

The -m options maps from some set of conditions to a terminal type,

179

that is, to tell tset "If I'm on this port at a particular speed, guess

180

that I'm on that kind of terminal".

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

181

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

182

The argument to the -m option consists of an optional port type, an

183

optional operator, an optional baud rate specification, an optional

184

colon (":") character and a terminal type. The port type is a string

185

(delimited by either the operator or the colon character). The

186

operator may be any combination of ">", "<", "@", and "!"; ">" means

187

greater than, "<" means less than, "@" means equal to and "!" inverts

188

the sense of the test. The baud rate is specified as a number and is

189

compared with the speed of the standard error output (which should be

190

the control terminal). The terminal type is a string.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

191

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

192

If the terminal type is not specified on the command line, the -m

193

mappings are applied to the terminal type. If the port type and baud

194

rate match the mapping, the terminal type specified in the mapping

195

replaces the current type. If more than one mapping is specified, the

196

first applicable mapping is used.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

197

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

198

For example, consider the following mapping: dialup>9600:vt100. The

199

port type is dialup , the operator is >, the baud rate specification is

200

9600, and the terminal type is vt100. The result of this mapping is to

201

specify that if the terminal type is dialup, and the baud rate is

202

greater than 9600 baud, a terminal type of vt100 will be used.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

203

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

204

If no baud rate is specified, the terminal type will match any baud

205

rate. If no port type is specified, the terminal type will match any

206

port type. For example, -m dialup:vt100 -m :?xterm will cause any

207

dialup port, regardless of baud rate, to match the terminal type vt100,

208

and any non-dialup port type to match the terminal type ?xterm. Note,

209

because of the leading question mark, the user will be queried on a

210

default port as to whether they are actually using an xterm terminal.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

211

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

212

No whitespace characters are permitted in the -m option argument.

213

Also, to avoid problems with meta-characters, it is suggested that the

214

entire -m option argument be placed within single quote characters, and

215

that csh users insert a backslash character ("\") before any

216

exclamation marks ("!").

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

217

218

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

219

</PRE><H2><a name="h2-OPTIONS">OPTIONS</a></H2><PRE>

220

The options are as follows:

221

222

-c Set control characters and modes.

223

224

-e ch

225

Set the erase character to ch.

226

227

-I Do not send the terminal or tab initialization strings to the

terminal.

-i ch

Set the interrupt character to ch.

232

233

-k ch

234

Set the line kill character to ch.

235

236

-m mapping

237

Specify a mapping from a port type to a terminal; see subsection

238

"Terminal Type Mapping".

239

240

-Q Do not display any values for the erase, interrupt and line kill

241

characters. Normally tset displays the values for control

242

characters which differ from the system's default values.

243

244

-q The terminal type is displayed to the standard output, and the

245

terminal is not initialized in any way. The option "-" by itself

246

is equivalent but archaic.

247

248

-r Print the terminal type to the standard error output.

249

250

-s Print the sequence of shell commands to initialize the environment

251

variable TERM to the standard output; see subsection "Setting the

252

Environment".

253

254

-V reports the version of ncurses which was used in this program, and

255

exits.

256

257

-w Resize the window to match the size deduced via <A HREF="curs_terminfo.3x.html">setupterm(3x)</A>.

258

Normally this has no effect, unless setupterm is not able to

259

detect the window size.

260

261

The arguments for the -e, -i, and -k options may either be entered as

262

actual characters or by using the "hat" notation, i.e., control-h may

263

be specified as "^H" or "^h".

264

265

If neither -c or -w is given, both options are assumed.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

266

267

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

268

</PRE><H2><a name="h2-ENVIRONMENT">ENVIRONMENT</a></H2><PRE>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

269

The tset command uses these environment variables:

270

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

271

SHELL

272

tells tset whether to initialize TERM using sh(1) or csh(1)

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

273

syntax.

274

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

275

TERM Denotes your terminal type. Each terminal type is distinct,

276

though many are similar.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

277

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

278

TERMCAP

279

may denote the location of a termcap database. If it is not an

280

absolute pathname, e.g., begins with a "/", tset removes the

281

variable from the environment before looking for the terminal

282

description.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

283

284

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

285

</PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>

286

/etc/ttys

287

system port name to terminal type mapping database (BSD versions

288

only).

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

289

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

290

/usr/share/terminfo

291

compiled terminal description database directory

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

292

293

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

294

</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>

295

Neither IEEE Std 1003.1/The Open Group Base Specifications Issue 7

296

(POSIX.1-2008) nor X/Open Curses Issue 7 documents tset or reset.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

297

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

298

The AT&T tput utility (AIX, HP-UX, Solaris) incorporated the terminal-

299

mode manipulation as well as termcap-based features such as resetting

300

tabstops from tset in BSD (4.1c), presumably with the intention of

301

making tset obsolete. However, each of those systems still provides

302

tset. In fact, the commonly-used reset utility is always an alias for

303

tset.

304

305

The tset utility provides backward compatibility with BSD environments;

306

under most modern Unices, /etc/inittab and getty(8) can set TERM

307

appropriately for each dial-up line, obviating what was tset's most

308

important use. This implementation behaves like 4.4BSD tset, with a

309

few exceptions we shall consider now.

310

311

A few options are different because the TERMCAP variable is no longer

312

supported under terminfo-based ncurses:

313

314

o The -S option of BSD tset no longer works; it prints an error

315

message to the standard error and dies.

316

317

o The -s option only sets TERM, not TERMCAP.

318

319

There was an undocumented 4.4BSD feature that invoking tset via a link

320

named "TSET" (or via any other name beginning with an upper-case

321

letter) set the terminal to use upper-case only. This feature has been

322

omitted.

323

324

The -A, -E, -h, -u and -v options were deleted from the tset utility in

325

4.4BSD. None of them were documented in 4.3BSD and all are of limited

326

utility at best. The -a, -d, and -p options are similarly not

327

documented or useful, but were retained as they appear to be in

328

widespread use. It is strongly recommended that any usage of these

329

three options be changed to use the -m option instead. The -a, -d, and

330

-p options are therefore omitted from the usage summary above.

331

332

Very old systems, e.g., 3BSD, used a different terminal driver which

333

was replaced in 4BSD in the early 1980s. To accommodate these older

334

systems, the 4BSD tset provided a -n option to specify that the new

335

terminal driver should be used. This implementation does not provide

336

that choice.

337

338

It is still permissible to specify the -e, -i, and -k options without

339

arguments, although it is strongly recommended that such usage be fixed

340

to explicitly specify the character.

341

342

As of 4.4BSD, executing tset as reset no longer implies the -Q option.

343

Also, the interaction between the - option and the terminal argument in

344

some historic implementations of tset has been removed.

345

346

The -c and -w options are not found in earlier implementations.

347

However, a different window size-change feature was provided in 4.4BSD.

348

349

o In 4.4BSD, tset uses the window size from the termcap description

350

to set the window size if tset is not able to obtain the window

351

size from the operating system.

352

353

o In ncurses, tset obtains the window size using <A HREF="curs_terminfo.3x.html">setupterm(3x)</A>, which

354

may be from the operating system, the LINES and COLUMNS environment

355

variables or the terminal description.

356

357

Obtaining the window size from a terminal's type description is common

358

to both implementations, but considered obsolescent. Its only

359

practical use is for hardware terminals. Generally, the window size

360

will remain uninitialized only if there were a problem obtaining the

361

value from the operating system (and setupterm would still fail). The

362

LINES and COLUMNS environment variables may thus be useful for working

363

around window-size problems, but have the drawback that if the window

364

is resized, their values must be recomputed and reassigned. The

365

resize(1) program distributed with xterm(1) assists this activity.

366

367

368

</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>

369

A reset command written by Kurt Shoens appeared in 1BSD (March 1978).

370

It set the erase and kill characters to ^H (backspace) and @

371

respectively. Mark Horton improved this reset in 3BSD (October 1979),

372

adding intr, quit, start/stop, and eof characters as well as changing

373

the program to avoid modifying any user settings. That version of

374

reset did not use termcap.

375

376

Eric Allman wrote a distinct tset command for 1BSD, using a forerunner

377

of termcap called ttycap. Allman's comments in the source code

378

indicate that he began work in October 1977, continuing development

379

over the next few years. By late 1979, it had migrated to termcap and

380

handled the TERMCAP variable. Later comments indicate that tset was

381

modified in September 1980 to use logic copied from the 3BSD "reset"

382

program when it was invoked as reset. This version appeared in

383

4.1cBSD, late in 1982. Other developers such as Keith Bostic and Jim

384

Bloom continued to modify tset until 4.4BSD was released in 1993.

385

386

The ncurses implementation was lightly adapted from the 4.4BSD sources

387

to use the terminfo API by Eric S. Raymond <esr@snark.thyrsus.com>.

388

389

390

</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>

391

csh(1), sh(1), stty(1), <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>, tty(4), <A HREF="terminfo.5.html">terminfo(5)</A>,

392

ttys(5), environ(7)

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

396

ncurses 6.5 2024-04-27 <A HREF="tset.1.html">tset(1)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

397

</PRE>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

<ul>

<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

402

<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>

403

<ul>

404

<li><a href="#h3-tset----initialization">tset -- initialization</a></li>

405

<li><a href="#h3-reset----reinitialization">reset -- reinitialization</a></li>

406

<li><a href="#h3-Setting-the-Environment">Setting the Environment</a></li>

407

<li><a href="#h3-Terminal-Type-Mapping">Terminal Type Mapping</a></li>

408

</ul>

409

</li>

410

<li><a href="#h2-OPTIONS">OPTIONS</a></li>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

411

<li><a href="#h2-ENVIRONMENT">ENVIRONMENT</a></li>

412

<li><a href="#h2-FILES">FILES</a></li>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

413

<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>

414

<li><a href="#h2-HISTORY">HISTORY</a></li>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

415

416

</ul>

417

</div>

Amit Daniel Kachhap