usr.sbin/vidcontrol/vidcontrol.1

   1 .\"
   2 .\" vidcontrol - a utility for manipulating the syscons video driver
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\"     @(#)vidcontrol.1
  14 .\" $FreeBSD$
  15 .\"
  16 .Dd May 27, 2002
  17 .Dt VIDCONTROL 1
  18 .Os
  19 .Sh NAME
  20 .Nm vidcontrol
  21 .Nd system console control and configuration utility
  22 .Sh SYNOPSIS
  23 .Nm
  24 .Op Fl CdLHPpx
  25 .Op Fl b Ar color
  26 .Op Fl c Ar appearance
  27 .Oo
  28 .Fl f
  29 .Op Ar size
  30 .Ar file
  31 .Oc
  32 .Op Fl g Ar geometry
  33 .Op Fl h Ar size
  34 .Op Fl i Cm adapter | mode
  35 .Op Fl l Ar screen_map
  36 .Op Fl M Ar char
  37 .Op Fl m Cm on | off
  38 .Op Fl r Ar foreground Ar background
  39 .Op Fl S Cm on | off
  40 .Op Fl s Ar number
  41 .Op Fl t Ar N | Cm off
  42 .Op Ar mode
  43 .Op Ar foreground Op Ar background
  44 .Op Cm show
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 command is used to set various options for the
  49 .Xr syscons 4
  50 console driver,
  51 such as video mode, colors, cursor shape, screen output map, font and screen
  52 saver timeout.
  53 .Pp
  54 The following command line options are supported:
  55 .Bl -tag -width indent
  56 .It Ar mode
  57 Select a new video mode.
  58 The modes currently recognized are:
  59 .Ar 80x25 ,
  60 .Ar 80x30 ,
  61 .Ar 80x43 ,
  62 .Ar 80x50 ,
  63 .Ar 80x60 ,
  64 .Ar 132x25 ,
  65 .Ar 132x30 ,
  66 .Ar 132x43 ,
  67 .Ar 132x50 ,
  68 .Ar 132x60 ,
  69 .Ar VGA_40x25 ,
  70 .Ar VGA_80x25 ,
  71 .Ar VGA_80x30 ,
  72 .Ar VGA_80x50 ,
  73 .Ar VGA_80x60 ,
  74 .Ar VGA_90x25 ,
  75 .Ar VGA_90x30 ,
  76 .Ar VGA_90x43 ,
  77 .Ar VGA_90x50 ,
  78 .Ar VGA_90x60 ,
  79 .Ar EGA_80x25 ,
  80 .Ar EGA_80x43 ,
  81 .Ar VESA_132x25 ,
  82 .Ar VESA_132x43 ,
  83 .Ar VESA_132x50 ,
  84 .Ar VESA_132x60 .
  85 .\"The graphic mode
  86 .\".Ar VGA_320x200
  87 .\"and
  88 The raster text mode
  89 .Ar VESA_800x600
  90 can also be chosen.
  91 See
  92 .Sx Video Mode Support
  93 below.
  94 .It Ar foreground Op Ar background
  95 Change colors when displaying text.
  96 Specify the foreground color
  97 (e.g.\&
  98 .Dq vidcontrol white ) ,
  99 or both a foreground and background colors
 100 (e.g.\&
 101 .Dq vidcontrol yellow blue ) .
 102 Use the
 103 .Cm show
 104 command below to see available colors.
 105 .It Cm show
 106 See the supported colors on a given platform.
 107 .It Fl b Ar color
 108 Set border color to
 109 .Ar color .
 110 This option may not be always supported by the video driver.
 111 .It Fl C
 112 Clear the history buffer.
 113 .It Fl c Cm normal | blink | destructive
 114 Change the cursor appearance.
 115 The cursor is either an inverting block
 116 .Pq Cm normal
 117 that can optionally
 118 .Cm blink ,
 119 or it can be like the old hardware cursor
 120 .Pq Cm destructive .
 121 The latter is actually a simulation.
 122 .It Fl d
 123 Print out current output screen map.
 124 .It Xo
 125 .Fl f
 126 .Op Ar size
 127 .Ar file
 128 .Xc
 129 Load font
 130 .Ar file
 131 for
 132 .Ar size
 133 (currently, only
 134 .Cm 8x8 ,
 135 .Cm 8x14
 136 or
 137 .Cm 8x16 ) .
 138 The font file can be either uuencoded or in raw binary format.
 139 You can also use the menu-driven
 140 .Xr vidfont 1
 141 command to load the font of your choice.
 142 .Pp
 143 .Ar Size
 144 may be omitted, in this case
 145 .Nm
 146 will try to guess it from the size of font file.
 147 .Pp
 148 Note that older video cards, such as MDA and CGA, do not support
 149 software font.
 150 See also
 151 .Sx Video Mode Support
 152 and
 153 .Sx EXAMPLES
 154 below and the man page for
 155 .Xr syscons 4 .
 156 .It Fl g Ar geometry
 157 Set the
 158 .Ar geometry
 159 of the text mode for the modes with selectable
 160 geometry.
 161 Currently only raster modes, such as
 162 .Ar VESA_800x600 ,
 163 support this option.
 164 See also
 165 .Sx Video Mode Support
 166 and
 167 .Sx EXAMPLES
 168 below.
 169 .It Fl h Ar size
 170 Set the size of the history (scrollback) buffer to
 171 .Ar size
 172 lines.
 173 .It Fl i Cm adapter
 174 Shows info about the current video adapter.
 175 .It Fl i Cm mode
 176 Shows the possible video modes with the current video hardware.
 177 .It Fl l Ar screen_map
 178 Install screen output map file from
 179 .Ar screen_map .
 180 See also
 181 .Xr syscons 4 .
 182 .It Fl L
 183 Install default screen output map.
 184 .It Fl M Ar char
 185 Sets the base character used to render the mouse pointer to
 186 .Ar char .
 187 .It Fl m Cm on | off
 188 Switch the mouse pointer
 189 .Cm on
 190 or
 191 .Cm off .
 192 Used together with the
 193 .Xr moused 8
 194 daemon for text mode cut & paste functionality.
 195 .It Fl p
 196 Capture the current contents of the video buffer corresponding
 197 to the terminal device referred to by standard input.
 198 The
 199 .Nm
 200 utility writes contents of the video buffer to the standard
 201 output in a raw binary format.
 202 For details about that
 203 format see
 204 .Sx Format of Video Buffer Dump
 205 below.
 206 .It Fl P
 207 Same as
 208 .Fl p ,
 209 but dump contents of the video buffer in a plain text format
 210 ignoring nonprintable characters and information about text
 211 attributes.
 212 .It Fl H
 213 When used with
 214 .Fl p
 215 or
 216 .Fl P ,
 217 it instructs
 218 .Nm
 219 to dump full history buffer instead of visible portion of
 220 the video buffer only.
 221 .It Fl r Ar foreground background
 222 Change reverse mode colors to
 223 .Ar foreground
 224 and
 225 .Ar background .
 226 .It Fl S Cm on | off
 227 Turn vty switching on or off.
 228 When vty switching is off,
 229 attempts to switch to a different virtual terminal will fail.
 230 (The default is to permit vty switching.)
 231 This protection can be easily bypassed when the kernel is compiled with
 232 the
 233 .Dv DDB
 234 option.
 235 However, you probably should not compile the kernel debugger on a box which
 236 is supposed to be physically secure.
 237 .It Fl s Ar number
 238 Set the current vty to
 239 .Ar number .
 240 .It Fl t Ar N | Cm off
 241 Set the screensaver timeout to
 242 .Ar N
 243 seconds, or turns it
 244 .Cm off .
 245 .It Fl x
 246 Use hexadecimal digits for output.
 247 .El
 248 .Ss Video Mode Support
 249 Note that not all modes listed above may be supported by the video
 250 hardware.
 251 You can verify which mode is supported by the video hardware, using the
 252 .Fl i Cm mode
 253 option.
 254 .Pp
 255 The VESA BIOS support must be linked to the kernel
 256 or loaded as a KLD module if you wish to use VESA video modes
 257 or 132 column modes
 258 (see
 259 .Xr vga 4 ) .
 260 .Pp
 261 You need to compile your kernel with the
 262 .Ar VGA_WIDTH90
 263 option if you wish to use VGA 90 column modes
 264 (see
 265 .Xr vga 4 ) .
 266 .Pp
 267 Video modes other than 25 and 30 line modes may require specific size of font.
 268 Use
 269 .Fl f
 270 option above to load a font file to the kernel.
 271 If the required size of font has not been loaded to the kernel,
 272 .Nm
 273 will fail if the user attempts to set a new video mode.
 274 .Pp
 275 .Bl -column "25 line modes" "8x16 (VGA), 8x14 (EGA)" -compact
 276 .Sy Modes Ta Sy Font size
 277 .Li 25 line modes Ta 8x16 (VGA), 8x14 (EGA)
 278 .Li 30 line modes Ta 8x16
 279 .Li 43 line modes Ta 8x8
 280 .Li 50 line modes Ta 8x8
 281 .Li 60 line modes Ta 8x8
 282 .El
 283 .Pp
 284 It is better to always load all three sizes (8x8, 8x14 and 8x16)
 285 of the same font.
 286 .Pp
 287 You may set variables in
 288 .Pa /etc/rc.conf
 289 or
 290 .Pa /etc/rc.conf.local
 291 so that desired font files will be automatically loaded
 292 when the system starts up.
 293 See below.
 294 .Pp
 295 If you want to use the raster text mode
 296 .Ar VESA_800x600 ,
 297 you need to recompile your kernel with the
 298 .Dv SC_PIXEL_MODE
 299 option.
 300 See
 301 .Xr syscons 4
 302 for more details on this kernel option.
 303 .Ss Format of Video Buffer Dump
 304 The
 305 .Nm
 306 utility uses the
 307 .Xr syscons 4
 308 .Dv CONS_SCRSHOT
 309 .Xr ioctl 2
 310 to capture the current contents of the video buffer.
 311 The
 312 .Nm
 313 utility writes version and additional information to the standard
 314 output, followed by the contents of the terminal device.
 315 .Pp
 316 VGA video memory is typically arranged in two byte tuples,
 317 one per character position.
 318 In each tuple, the first byte will be the character code,
 319 and the second byte is the character's color attribute.
 320 .Pp
 321 The VGA color attribute byte looks like this:
 322 .Pp
 323 .Bl -column "X:X" "<00000000>" "width" "bright foreground color"
 324 .Sy "bits#              width   meaning"
 325 .Li "7  <X0000000>      1       character blinking"
 326 .Li "6:4        <0XXX0000>      3       background color"
 327 .Li "3  <0000X000>      1       bright foreground color"
 328 .Li "2:0        <00000XXX>      3       foreground color"
 329 .El
 330 .Pp
 331 Here is a list of the three bit wide base colors:
 332 .Pp
 333 .Bl -hang -offset indent -compact
 334 .It 0
 335 Black
 336 .It 1
 337 Blue
 338 .It 2
 339 Green
 340 .It 3
 341 Cyan
 342 .It 4
 343 Red
 344 .It 5
 345 Magenta
 346 .It 6
 347 Brown
 348 .It 7
 349 Light Grey
 350 .El
 351 .Pp
 352 Base colors with bit 3 (the bright foreground flag) set:
 353 .Pp
 354 .Bl -hang -offset indent -compact
 355 .It 0
 356 Dark Grey
 357 .It 1
 358 Light Blue
 359 .It 2
 360 Light Green
 361 .It 3
 362 Light Cyan
 363 .It 4
 364 Light Red
 365 .It 5
 366 Light Magenta
 367 .It 6
 368 Yellow
 369 .It 7
 370 White
 371 .El
 372 .Pp
 373 For example, the two bytes
 374 .Pp
 375 .Dl "65 158"
 376 .Pp
 377 specify an uppercase A (character code 65), blinking
 378 (bit 7 set) in yellow (bits 3:0) on a blue background
 379 (bits 6:4).
 380 .Pp
 381 The
 382 .Nm
 383 output contains a small header which includes additional
 384 information which may be useful to utilities processing
 385 the output.
 386 .Pp
 387 The first 10 bytes are always arranged as follows:
 388 .Bl -column "Byte range" "Contents" -offset indent
 389 .It Sy "Byte Range      Contents"
 390 .It "1 thru 8   Literal text" Dq Li SCRSHOT_
 391 .It "9  File format version number"
 392 .It "10 Remaining number of bytes in the header"
 393 .El
 394 .Pp
 395 Subsequent bytes depend on the version number.
 396 .Bl -column "Version" "13 and up" -offset indent
 397 .It Sy "Version Byte    Meaning"
 398 .It "1  11      Terminal width, in characters"
 399 .It "   12      Terminal depth, in characters"
 400 .It "   13 and up       The snapshot data"
 401 .El
 402 .Pp
 403 So a dump of an 80x25 screen would start (in hex)
 404 .Bd -literal -offset indent
 405 53 43 52 53 48 4f 54 5f 01 02 50 19
 406 ----------------------- -- -- -- --
 407           |              |  |  |  ` 25 decimal
 408           |              |  |  `--- 80 decimal
 409           |              |  `------ 2 remaining bytes of header data
 410           |              `--------- File format version 1
 411           `------------------------ Literal "SCRSHOT_"
 412 .Ed
 413 .Sh VIDEO OUTPUT CONFIGURATION
 414 .Ss Boot Time Configuration
 415 You may set the following variables in
 416 .Pa /etc/rc.conf
 417 or
 418 .Pa /etc/rc.conf.local
 419 in order to configure the video output at boot time.
 420 .Pp
 421 .Bl -tag -width foo_bar_var -compact
 422 .It Ar blanktime
 423 Sets the timeout value for the
 424 .Fl t
 425 option.
 426 .It Ar font8x16 , font8x14 , font8x8
 427 Specifies font files for the
 428 .Fl f
 429 option.
 430 .It Ar scrnmap
 431 Specifies a screen output map file for the
 432 .Fl l
 433 option.
 434 .El
 435 .Pp
 436 See
 437 .Xr rc.conf 5
 438 for more details.
 439 .Ss Driver Configuration
 440 The video card driver may let you change default configuration
 441 options, such as the default font, so that you do not need to set up
 442 the options at boot time.
 443 See video card driver manuals, (e.g.\&
 444 .Xr vga 4 )
 445 for details.
 446 .Sh FILES
 447 .Bl -tag -width /usr/share/syscons/scrnmaps/foo-bar -compact
 448 .It Pa /usr/share/syscons/fonts/*
 449 font files.
 450 .It Pa /usr/share/syscons/scrnmaps/*
 451 screen output map files.
 452 .El
 453 .Sh EXAMPLES
 454 If you want to load
 455 .Pa /usr/share/syscons/fonts/iso-8x16.fnt
 456 to the kernel, run
 457 .Nm
 458 as:
 459 .Pp
 460 .Dl vidcontrol -f 8x16 /usr/share/syscons/fonts/iso-8x16.fnt
 461 .Pp
 462 So long as the font file is in
 463 .Pa /usr/share/syscons/fonts ,
 464 you may abbreviate the file name as
 465 .Pa iso-8x16 :
 466 .Pp
 467 .Dl vidcontrol -f 8x16 iso-8x16
 468 .Pp
 469 Furthermore, you can also omit font size
 470 .Dq Li 8x16 :
 471 .Pp
 472 .Dl vidcontrol -f iso-8x16
 473 .Pp
 474 Moreover, the suffix specifying the font size can be also omitted; in
 475 this case,
 476 .Nm
 477 will use the size of the currently displayed font to construct the
 478 suffix:
 479 .Pp
 480 .Dl vidcontrol -f iso
 481 .Pp
 482 Likewise, you can also abbreviate the screen output map file name for
 483 the
 484 .Fl l
 485 option if the file is found in
 486 .Pa /usr/share/syscons/scrnmaps .
 487 .Pp
 488 .Dl vidcontrol -l iso-8859-1_to_cp437
 489 .Pp
 490 The above command will load
 491 .Pa /usr/share/syscons/scrnmaps/iso-8859-1_to_cp437.scm .
 492 .Pp
 493 The following command will set-up a 100x37 raster text mode (useful for
 494 some LCD models):
 495 .Pp
 496 .Dl vidcontrol -g 100x37 VESA_800x600
 497 .Pp
 498 The following command will capture the contents of the first virtual
 499 terminal, and redirect the output to the
 500 .Pa shot.scr
 501 file:
 502 .Pp
 503 .Dl vidcontrol -p < /dev/ttyv0 > shot.scr
 504 .Pp
 505 The following command will dump contents of the fourth virtual terminal
 506 to the standard output in the human readable format:
 507 .Pp
 508 .Dl vidcontrol -P < /dev/ttyv3
 509 .Sh SEE ALSO
 510 .Xr kbdcontrol 1 ,
 511 .Xr vidfont 1 ,
 512 .Xr keyboard 4 ,
 513 .Xr screen 4 ,
 514 .Xr syscons 4 ,
 515 .Xr vga 4 ,
 516 .Xr rc.conf 5 ,
 517 .Xr kldload 8 ,
 518 .Xr moused 8 ,
 519 .Xr watch 8
 520 .Pp
 521 The various
 522 .Li scr2*
 523 utilities in the
 524 .Li graphics
 525 and
 526 .Li textproc
 527 categories of the
 528 .Em "Ports Collection" .
 529 .Sh AUTHORS
 530 .An S\(/oren Schmidt Aq sos@FreeBSD.org
 531 .Sh CONTRIBUTORS
 532 .An Maxim Sobolev Aq sobomax@FreeBSD.org ,
 533 .An Nik Clayton Aq nik@FreeBSD.org