Penguin
Recent Changes
Annotated edit history of setterm(1) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 SETTERM
2 !!!SETTERM
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 SEE ALSO
8 BUGS
9 ----
10 !!NAME
11
12
13 setterm - set terminal attributes
14 !!SYNOPSIS
15
16
17 __setterm__ [[__options__]
18 !!DESCRIPTION
19
20
21 __setterm__ writes to standard output a character string
22 that will invoke the specified terminal capabilities. Where
23 possible ''terminfo'' is consulted to find the string to
24 use. Some options however (marked
25 ''terminfo__(5)
26 capability. In this case, if the terminal type is
27 __
28 !!OPTIONS
29
30
31 For boolean options (__on__ or __off__), the default
32 is __on__.
33
34
35 For conciseness, an ''8-color'' below is __black__,
36 __red__, __green__, __yellow__, __blue__,
37 __magenta__, __cyan__, or __white__.
38
39
40 A ''16-color'' is an ''8-color'', __grey__, or
41 __bright__ followed by __red__, __green__,
42 __yellow__, __blue__, __magenta__, __cyan__, or
43 __white__.
44
45
46 The various color options may be set independently, at least
47 at virtual consoles, though the results of setting multiple
48 modes (for example, __-underline__ and
49 __-half-bright__) are hardware-dependent.
50
51
52 __-term__ terminal_name
53
54
55 Overrides the TERM environment variable.
56
57
58 __-reset__
59
60
61 Displays the terminal reset string, which typically resets
62 the terminal to its power on state.
63
64
65 __-initialize__
66
67
68 Displays the terminal initialization string, which typically
69 sets the terminal's rendering options, and other attributes
70 to the default values.
71
72
73 __-cursor__ [[__on__|__off__]
74
75
76 Turns the terminal's cursor on or off.
77
78
79 __-repeat__ [[__on__|__off__] (virtual consoles
80 only)
81
82
83 Turns keyboard repeat on or off.
84
85
86 __-appcursorkeys__ [[__on__|__off__] (virtual
87 consoles only)
88
89
90 Sets Cursor Key Application Mode on or off. When on, ESC O
91 A, ESC O B, etc. will be sent for the cursor keys instead of
92 ESC [[ A, ESC [[ B, etc. See the
93
94
95 __-linewrap__ [[__on__|__off__] (virtual consoles
96 only)
97
98
99 Turns automatic line-wrapping on or off.
100
101
102 __-default__
103
104
105 Sets the terminal's rendering options to the default
106 values.
107
108
109 __-foreground__ ''8-color''|__default__ (virtual
110 consoles only)
111
112
113 Sets the foreground text color.
114
115
116 __-background__ ''8-color''|__default__ (virtual
117 consoles only)
118
119
120 Sets the background text color.
121
122
123 __-ulcolor__ ''16-color'' (virtual consoles
124 only)
125
126
127 Sets the color for underlined characters.
128
129
130 __-hbcolor__ ''16-color'' (virtual consoles
131 only)
132
133
134 Sets the color for half-bright characters.
135
136
137 __-inversescreen__ [[__on__|__off__] (virtual
138 consoles only)
139
140
141 Inverts the screen colors. Foreground and background are
142 swapped, as are underline and half-brightness.
143
144
145 __-bold__ [[__on__|__off__]
146
147
148 Turns bold (extra bright) mode on or off. Except at a
149 virtual console, __-bold off__ turns off all attributes
150 (bold, half-brightness, blink, reverse).
151
152
153 __-half-bright__ [[__on__|__off__]
154
155
156 Turns dim (half-brightness) mode on or off (see
157 __-hbcolor__). Except at a virtual console,
158 __-half-bright off__ turns off all attributes (bold,
159 half-brightness, blink, reverse).
160
161
162 __-blink__ [[__on__|__off__]
163
164
165 Turns blink mode on or off. Except at a virtual console,
166 __-blink off__ turns off all attributes (bold,
167 half-brightness, blink, reverse).
168
169
170 __-reverse__ [[__on__|__off__]
171
172
173 Turns reverse video mode on or off. Except at a virtual
174 console, __-reverse off__ turns off all attributes (bold,
175 half-brightness, blink, reverse).
176
177
178 __-underline__ [[__on__|__off__]
179
180
181 Turns underline mode on or off (see
182 __-ulcolor__).
183
184
185 __-store__ (virtual consoles only)
186
187
188 Stores the terminal's current rendering options as the
189 default values.
190
191
192 __-clear__ [[__all__]
193
194
195 Clears the screen and
196 clear__(1).
197
198
199 __-clear rest__
200
201
202 Clears from the current cursor position to the end of the
203 screen.
204
205
206 __-tabs__ [[tab1 tab2 tab3 ...] (virtual consoles
207 only)
208
209
210 Sets tab stops at the given horizontal cursor positions, in
211 the range 1-160. Without arguments, shows the current tab
212 stop settings.
213
214
215 __-clrtabs__ [[tab1 tab2 tab3 ...] (virtual consoles
216 only)
217
218
219 Clears tab stops from the given horizontal cursor positions,
220 in the range 1-160. Without arguments, clears all tab
221 stops.
222
223
224 __-regtabs__ [[1-160] (virtual consoles only)
225
226
227 Clears all tab stops, then sets a regular tab stop pattern,
228 with one tab every specified number of positions. Without an
229 argument, defaults to 8.
230
231
232 __-blank__ [[0-60] (virtual consoles only)
233
234
235 Sets the interval of inactivity, in minutes, after which the
236 screen will be automatically blanked (using APM if
237 available). Without an argument, defaults to 0 (disable
238 console blanking).
239
240
241 __-dump__ [[1-NR_CONS]
242
243
244 Writes a snapshot of the given virtual console (with
245 attributes) to the file specified in the __-file__
246 option, overwriting its contents; the default is
247 screen.dump. Without an argument, dumps the current virtual
248 console. Overrides __-append__.
249
250
251 __-append__ [[1-NR_CONS]
252
253
254 Like __-dump__, but appends to the snapshot file instead
255 of overwriting it. Only works if no __-dump__ options are
256 given.
257
258
259 __-file__ dumpfilename
260
261
262 Sets the snapshot file name for any __-dump__ or
263 __-append__ options on the same command line. If this
264 option is not present, the default is screen.dump in the
265 current directory.
266
267
268 __-msg__ [[__on__|__off__] (virtual consoles
269 only)
270
271
272 Enables or disables the sending of kernel __printk()__
273 messages to the console.
274
275
276 __-msglevel__ 1-8 (virtual consoles only)
277
278
279 Sets the console logging level for kernel __printk()__
280 messages. All messages strictly more important than this
281 will be printed, so a logging level of 0 has the same effect
282 as __-msg on__ and a logging level of 8 will print all
283 kernel messages. klogd(8) may be a more convenient
284 interface to the logging of kernel messages.
285
286
287 __-powersave on__|__vsync__
288
289
290 Puts the monitor into VESA vsync suspend mode.
291
292
293 __-powersave hsync__
294
295
296 Puts the monitor into VESA hsync suspend mode.
297
298
299 __-powersave powerdown__
300
301
302 Puts the monitor into VESA powerdown mode.
303
304
305 __-powersave__ [[__off__]
306
307
308 Turns off monitor VESA powersaving features.
309
310
311 __-powerdown__ [[0-60]
312
313
314 Sets the VESA powerdown interval in minutes. Without an
315 argument, defaults to 0 (disable powerdown). If the console
316 is blanked or the monitor is in suspend mode, then the
317 monitor will go into vsync suspend mode or powerdown mode
318 respectively after this period of time has
319 elapsed.
320
321
322 __-blength__ [[0-2000]
323
324
325 Sets the bell duration in milliseconds. Without an argument,
326 defaults to 0.
327
328
329 __-bfreq__ [[freqnumber]
330
331
332 Sets the bell frequency in Hz. Without an argument, defaults
333 to 0.
334 !!SEE ALSO
335
336
337 tput(1), stty(1), terminfo(5),
338 tty(4)
339 !!BUGS
340
341
342 Differences between the Minix and Linux versions are not
343 documented.
344 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.