Page MenuHomeFreeBSD
Differential D17428 Diff 49333 head/usr.sbin/vidcontrol/vidcontrol.1

Changeset View

Standalone View

View Options

head/usr.sbin/vidcontrol/vidcontrol.1

.\" .\"
.\" vidcontrol - a utility for manipulating the syscons or vt video driver .\" vidcontrol - a utility for manipulating the syscons or vt video driver
.\" .\"
.\" Redistribution and use in source and binary forms, with or without .\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions .\" modification, are permitted provided that the following conditions
.\" are met: .\" are met:
.\" 1. Redistributions of source code must retain the above copyright .\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer. .\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright .\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the .\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution. .\" documentation and/or other materials provided with the distribution.
.\" .\"
.\" @(#)vidcontrol.1 .\" @(#)vidcontrol.1
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd January 19, 2016 .Dd October 20, 2018
.Dt VIDCONTROL 1 .Dt VIDCONTROL 1
.Os .Os
.Sh NAME .Sh NAME
.Nm vidcontrol .Nm vidcontrol
.Nd system console control and configuration utility .Nd system console control and configuration utility
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Op Fl CdLHPpx .Op Fl CdLHPpx
Show All 23 Lines
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
utility is used to set various options for the utility is used to set various options for the
.Xr syscons 4 .Xr syscons 4
or or
.Xr vt 4 .Xr vt 4
console driver, console driver,
such as video mode, colors, cursor shape, screen output map, font and screen such as video mode, colors, cursor shape, screen output map, font, and screen
saver timeout. saver timeout.
Only a small subset of options is supported by Only a small subset of options is supported by
.Xr vt 4 . .Xr vt 4 .
Unsupported options lead to error messages, typically including Unsupported options lead to error messages, typically including
the text "Inappropriate ioctl for device". the text "Inappropriate ioctl for device".
.Pp .Pp
The following command line options are supported: The following command line options are supported:
.Bl -tag -width indent .Bl -tag -width indent
Show All 39 Lines
.Fl i Cm mode .Fl i Cm mode
option. option.
See See
.Sx Video Mode Support .Sx Video Mode Support
below. below.
.It Ar foreground Op Ar background .It Ar foreground Op Ar background
Change colors when displaying text. Change colors when displaying text.
Specify the foreground color Specify the foreground color
(e.g.\& (e.g.,
.Dq vidcontrol white ) , .Dq vidcontrol white ) ,
or both a foreground and background colors or both a foreground and background colors
(e.g.\& (e.g.,
.Dq vidcontrol yellow blue ) . .Dq vidcontrol yellow blue ) .
Use the Use the
.Cm show .Cm show
command below to see available colors. command below to see available colors.
.It Cm show .It Cm show
See the supported colors on a given platform. See the supported colors on a given platform.
.It Fl b Ar color .It Fl b Ar color
Set border color to Set border color to
.Ar color . .Ar color .
This option may not be always supported by the video driver. This option may not be always supported by the video driver.
.It Fl C .It Fl C
Clear the history buffer. Clear the history buffer.
.It Fl c Ar setting Ns Op , Ns Ar setting ... .It Fl c Ar setting Ns Op , Ns Ar setting ...
Change the cursor appearance. Change the cursor appearance.
The change is specified by a non-empty comma-separated list of The change is specified by a non-empty comma-separated list of
.Cm setting Ns s . .Ar setting Ns s .
Each Each
.Cm setting .Ar setting
overrides or modifies previous ones in left to right order. overrides or modifies previous ones in left to right order.
.Pp .Pp
The following override The following override
.Cm setting Ns s .Ar setting Ns s
are available: are available:
.Bl -tag -width indent .Bl -tag -width indent
.It Cm normal .It Cm normal
Set to a block covering 1 character cell, Set to a block covering 1 character cell,
with a configuration-dependent coloring with a configuration-dependent coloring
that should be at worst inverse video. that should be at worst inverse video.
.It Cm destructive .It Cm destructive
Set to a blinking sub-block with Set to a blinking sub-block with
.Cm height .Cm height
scanlines starting at scanlines starting at
.Cm base . .Cm base .
The name The name
.Dq destructive .Dq destructive
is bad for backwards compatibility. is bad for backwards compatibility.
This This
.Cm setting .Ar setting
should not force destructiveness, should not force destructiveness,
and it now only gives destructiveness in some and it now only gives destructiveness in some
configurations (typically for hardware cursors configurations (typically for hardware cursors
in text mode). in text mode).
Blinking limits destructiveness. Blinking limits destructiveness.
This This
.Cm setting .Ar setting
should now be spelled should now be spelled
.Cm normal , Ns Cm blink , Ns Cm noblock . .Cm normal , Ns Cm blink , Ns Cm noblock .
A non-blinking destructive cursor would be unusable, A non-blinking destructive cursor would be unusable,
so old versions of so old versions of
.Nm .Nm
didn't support it, did not support it,
and this version doesn't have an override for it. and this version does not have an override for it.
.It Cm base Ns = Ns Ar value, Cm height Ns = Ns Ar value .It Cm base Ns = Ns Ar value , Cm height Ns = Ns Ar value
Set the specified scanline parameters. Set the specified scanline parameters.
These parameters are only active in These parameters are only active in
.Cm noblock .Cm noblock
mode. mode.
.Cm value .Cm value
is an integer in any base supported by is an integer in any base supported by
.Xr strtol 3 . .Xr strtol 3 .
Setting Setting
.Cm height .Cm height
to 0 turns off the cursor in to 0 turns off the cursor in
.Cm noblock .Cm noblock
mode. mode.
Negative Negative
.Ar value Ns s .Ar value Ns s
are silently ignored. are silently ignored.
Positive Positive
.Ar value Ns s .Ar value Ns s
are clamped to fit in the character cell when the cursor is drawn. are clamped to fit in the character cell when the cursor is drawn.
.El .El
.Pp .Pp
The following modifier The following modifier
.Cm setting Ns s .Ar setting Ns s
are available: are available:
.Bl -tag -width indent .Bl -tag -width indent
.It Cm blink , noblink .It Cm blink , noblink
Set or clear the blinking attribute. Set or clear the blinking attribute.
This is not quite backwards compatible. This is not quite backwards compatible.
In old versions of In old versions of
.Nm , Cm blink .Nm , Cm blink
was an override to a blinking block. was an override to a blinking block.
Show All 13 Lines
The The
.Cm block .Cm block
method tends to give better coloring. method tends to give better coloring.
.It Cm hidden , nohidden .It Cm hidden , nohidden
Set or clear the hidden attribute. Set or clear the hidden attribute.
.El .El
.Pp .Pp
The following (non-sticky) flags control application of the The following (non-sticky) flags control application of the
.Cm setting Ns s : .Ar setting Ns s :
.Bl -tag -width indent .Bl -tag -width indent
.It Cm charcolors .It Cm charcolors
Apply Apply
.Cm base .Cm base
and and
.Cm height .Cm height
to the (character) cursor's list of preferred colors instead of its shape. to the (character) cursor's list of preferred colors instead of its shape.
Beware that the color numbers are raw VGA palette indexes, Beware that the color numbers are raw VGA palette indexes,
Show All 24 Lines
is also set). is also set).
.It Cm default .It Cm default
Apply the changes to the default settings and then to the active settings, Apply the changes to the default settings and then to the active settings,
instead of only to the active settings. instead of only to the active settings.
Together with Together with
.Cm local , .Cm local ,
this gives 2 selection bits which select between 4 destinations. this gives 2 selection bits which select between 4 destinations.
.It Cm shapeonly .It Cm shapeonly
Ignore any changes to the Ignore any changes to the
.Cm block .Cm block
and and
.Cm hidden .Cm hidden
attributes. attributes.
.It Cm local .It Cm local
Apply the changes to the current vty. Apply the changes to the current vty.
The default is to apply them to a global place The default is to apply them to a global place
and copy from there to all vtys. and copy from there to all vtys.
Show All 38 Lines
.Nm .Nm
will try to guess it from the size of font file. will try to guess it from the size of font file.
.Pp .Pp
When using When using
.Xr vt 4 .Xr vt 4
both both
.Ar size .Ar size
and and
.Ar font .Ar file
can be omitted, and the default font will be loaded. can be omitted, and the default font will be loaded.
.Pp .Pp
Note that older video cards, such as MDA and CGA, do not support Note that older video cards, such as MDA and CGA, do not support
software font. software font.
See also See also
.Sx Video Mode Support .Sx Video Mode Support
and and
.Sx EXAMPLES .Sx EXAMPLES
▲ Show 20 Lines • Show All 242 Lines • ▼ Show 20 Lines
.Nm .Nm
output contains a small header which includes additional output contains a small header which includes additional
information which may be useful to utilities processing information which may be useful to utilities processing
the output. the output.
.Pp .Pp
The first 10 bytes are always arranged as follows: The first 10 bytes are always arranged as follows:
.Bl -column "Byte range" "Contents" -offset indent .Bl -column "Byte range" "Contents" -offset indent
.It Sy "Byte Range Contents" .It Sy "Byte Range Contents"
.It "1 thru 8 Literal text" Dq Li SCRSHOT_ .It "1 - 8 Literal text" Dq Li SCRSHOT_
.It "9 File format version number" .It "9 File format version number"
.It "10 Remaining number of bytes in the header" .It "10 Remaining number of bytes in the header"
.El .El
.Pp .Pp
Subsequent bytes depend on the version number. Subsequent bytes depend on the version number.
.Bl -column "Version" "13 and up" -offset indent .Bl -column "Version" "13 and up" -offset indent
.It Sy "Version Byte Meaning" .It Sy "Version Byte Meaning"
.It "1 11 Terminal width, in characters" .It "1 11 Terminal width, in characters"
Show All 36 Lines
.Pp .Pp
See See
.Xr rc.conf 5 .Xr rc.conf 5
for more details. for more details.
.Ss Driver Configuration .Ss Driver Configuration
The video card driver may let you change default configuration The video card driver may let you change default configuration
options, such as the default font, so that you do not need to set up options, such as the default font, so that you do not need to set up
the options at boot time. the options at boot time.
See video card driver manuals, (e.g.\& See video card driver manuals, (e.g.,
.Xr vga 4 ) .Xr vga 4 )
for details. for details.
.Sh FILES .Sh FILES
.Bl -tag -width /usr/share/syscons/scrnmaps/foo-bar -compact .Bl -tag -width /usr/share/syscons/scrnmaps/foo-bar -compact
.It Pa /usr/share/syscons/fonts/* .It Pa /usr/share/syscons/fonts/*
.It Pa /usr/share/vt/fonts/* .It Pa /usr/share/vt/fonts/*
font files. font files.
.It Pa /usr/share/syscons/scrnmaps/* .It Pa /usr/share/syscons/scrnmaps/*
Show All 20 Lines
.Pp .Pp
.Dl vidcontrol -f 8x16 iso-8x16 .Dl vidcontrol -f 8x16 iso-8x16
.Pp .Pp
Furthermore, you can also omit font size Furthermore, you can also omit font size
.Dq Li 8x16 : .Dq Li 8x16 :
.Pp .Pp
.Dl vidcontrol -f iso-8x16 .Dl vidcontrol -f iso-8x16
.Pp .Pp
Moreover, the suffix specifying the font size can be also omitted; in Moreover, the suffix specifying the font size can also be omitted; in
this case, this case,
.Nm .Nm
will use the size of the currently displayed font to construct the will use the size of the currently displayed font to construct the
suffix: suffix:
.Pp .Pp
.Dl vidcontrol -f iso .Dl vidcontrol -f iso
.Pp .Pp
Likewise, you can also abbreviate the screen output map file name for Likewise, you can also abbreviate the screen output map file name for
▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines