SETTERM(1) Linux Programmer's Manual SETTERM(1)
NAME
setterm(1,3x,3x curs_terminfo) - set(7,n,1 builtins) terminal attributes
SYNOPSIS
setterm(1,3x,3x curs_terminfo) [options]
DESCRIPTION
setterm(1,3x,3x curs_terminfo) writes to standard output a character string(3,n) that will invoke
the specified terminal capabilities. Where possible terminfo is con-
sulted to find the string(3,n) to use. Some options however (marked "vir-
tual(5,8) consoles only" below) do not correspond to a terminfo(5) capabil-
ity. In this case, if(3,n) the terminal type is "con" or "linux" the string(3,n)
that invokes the specified capabilities on the PC Minix virtual(5,8) console(4,n)
driver is output. Options that are not implemented by the terminal are
ignored.
OPTIONS
For boolean options (on or off), the default is on.
For conciseness, an 8-color below is black, red, green, yellow, blue,
magenta, cyan, or white.
A 16-color is an 8-color, grey, or bright followed by red, green, yel-
low, blue, magenta, cyan, or white.
The various color options may be set(7,n,1 builtins) independently, at least at virtual(5,8)
consoles, though the results of setting multiple modes (for example,
-underline and -half-bright) are hardware-dependent.
-term terminal_name
Overrides the TERM environment variable.
-reset Displays the terminal reset(1,7,1 tput) string(3,n), which typically resets the
terminal to its power on state.
-initialize
Displays the terminal initialization string(3,n), which typically
sets the terminal's rendering options, and other attributes to
the default values.
-cursor [on|off]
Turns the terminal's cursor on or off.
-repeat [on|off] (virtual(5,8) consoles only)
Turns keyboard repeat on or off.
-appcursorkeys [on|off] (virtual(5,8) consoles only)
Sets Cursor Key Application Mode on or off. When on, ESC O A,
ESC O B, etc. will be sent for the cursor keys instead of ESC [
A, ESC [ B, etc. See the "vi and Cursor-Keys" section of the
Text-Terminal-HOWTO for how this can cause problems for vi
users.
-linewrap [on|off] (virtual(5,8) consoles only)
Turns automatic line-wrapping on or off.
-default
Sets the terminal's rendering options to the default values.
-foreground 8-color|default (virtual(5,8) consoles only)
Sets the foreground text color.
-background 8-color|default (virtual(5,8) consoles only)
Sets the background text color.
-ulcolor 16-color (virtual(5,8) consoles only)
Sets the color for underlined characters.
-hbcolor 16-color (virtual(5,8) consoles only)
Sets the color for half-bright characters.
-inversescreen [on|off] (virtual(5,8) consoles only)
Inverts the screen colors. Foreground and background are
swapped, as are underline and half-brightness.
-bold [on|off]
Turns bold (extra bright) mode on or off. Except at a virtual(5,8)
console(4,n), -bold off turns off all attributes (bold, half-bright-
ness, blink, reverse).
-half-bright [on|off]
Turns dim (half-brightness) mode on or off (see -hbcolor).
Except at a virtual(5,8) console(4,n), -half-bright off turns off all
attributes (bold, half-brightness, blink, reverse).
-blink [on|off]
Turns blink mode on or off. Except at a virtual(5,8) console(4,n), -blink
off turns off all attributes (bold, half-brightness, blink,
reverse).
-reverse [on|off]
Turns reverse video mode on or off. Except at a virtual(5,8) con-
sole(4,n), -reverse off turns off all attributes (bold, half-bright-
ness, blink, reverse).
-underline [on|off]
Turns underline mode on or off (see -ulcolor).
-store (virtual(5,8) consoles only)
Stores the terminal's current rendering options (foreground and
background colors) as the values to be used at reset-to-default.
-clear [all]
Clears the screen and "homes" the cursor, as clear(1,3x,3x clrtobot)(1).
-clear rest
Clears from the current cursor position to the end of the
screen.
-tabs [tab1 tab2 tab3 ...] (virtual(5,8) consoles only)
Sets tab stops at the given horizontal cursor positions, in(1,8) the
range 1-160. Without arguments, shows the current tab stop set-
tings.
-clrtabs [tab1 tab2 tab3 ...] (virtual(5,8) consoles only)
Clears tab stops from the given horizontal cursor positions, in(1,8)
the range 1-160. Without arguments, clears all tab stops.
-regtabs [1-160] (virtual(5,8) consoles only)
Clears all tab stops, then sets a regular tab stop pattern, with
one tab every specified number of positions. Without an argu-
ment, defaults to 8.
-blank [0-60] (virtual(5,8) consoles only)
Sets the interval of inactivity, in(1,8) minutes, after which the
screen will be automatically blanked (using APM if(3,n) available).
Without an argument, defaults to 0 (disable console(4,n) blanking).
-dump [1-NR_CONS]
Writes a snapshot of the given virtual(5,8) console(4,n) (with attributes)
to the file(1,n) specified in(1,8) the -file option, overwriting its con-
tents; the default is screen.dump. Without an argument, dumps
the current virtual(5,8) console. Overrides -append.
-append [1-NR_CONS]
Like -dump, but appends to the snapshot file(1,n) instead of over-
writing it. Only works if(3,n) no -dump options are given.
-file dumpfilename
Sets the snapshot file(1,n) name for any -dump or -append options on
the same command line. If this option is not present, the
default is screen.dump in(1,8) the current directory.
-msg [on|off] (virtual(5,8) consoles only)
Enables or disables the sending of kernel printk() messages to
the console.
-msglevel 1-8 (virtual(5,8) consoles only)
Sets the console(4,n) logging level for kernel printk() messages.
All messages strictly more important than this will be printed,
so a logging level of 0 has the same effect as -msg on and a
logging level of 8 will print all kernel messages. klogd(8) may
be a more convenient interface to the logging of kernel mes-
sages.
-powersave on|vsync
Puts the monitor into VESA vsync suspend mode.
-powersave hsync
Puts the monitor into VESA hsync suspend mode.
-powersave powerdown
Puts the monitor into VESA powerdown mode.
-powersave [off]
Turns off monitor VESA powersaving features.
-powerdown [0-60]
Sets the VESA powerdown interval in(1,8) minutes. Without an argu-
ment, defaults to 0 (disable powerdown). If the console(4,n) is
blanked or the monitor is in(1,8) suspend mode, then the monitor will
go into vsync suspend mode or powerdown mode respectively after
this period of time(1,2,n) has elapsed.
-blength [0-2000]
Sets the bell duration in(1,8) milliseconds. Without an argument,
defaults to 0.
-bfreq [freqnumber]
Sets the bell frequency in(1,8) Hz. Without an argument, defaults to
0.
SEE ALSO
tput(1), stty(1), terminfo(5), tty(1,4)(4)
BUGS
Differences between the Minix and Linux versions are not documented.
Util-Linux 2.10 7 January 2000 SETTERM(1)