share/man/man4/syscons.4

   1 .\"
   2 .\" Copyright (c) 1999
   3 .\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer as
  11 .\"    the first lines of this file unmodified.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man4/syscons.4,v 1.10.2.14 2003/04/25 21:21:36 brueffer Exp $
  28 .\"
  29 .Dd July 21, 2015
  30 .Dt SYSCONS 4
  31 .Os
  32 .Sh NAME
  33 .Nm syscons ,
  34 .Nm sc
  35 .Nd the console driver
  36 .Sh SYNOPSIS
  37 .Cd "options MAXCONS=N"
  38 .Cd "options SC_ALT_MOUSE_IMAGE"
  39 .Cd "options SC_DISABLE_DDBKEY"
  40 .Cd "options SC_DISABLE_REBOOT"
  41 .Cd "options SC_HISTORY_SIZE=N"
  42 .Cd "options SC_MOUSE_CHAR=C"
  43 .Cd "options SC_NO_CUTPASTE"
  44 .Cd "options SC_NO_FONT_LOADING"
  45 .Cd "options SC_NO_HISTORY"
  46 .Cd "options SC_NO_PALETTE_LOADING"
  47 .Cd "options SC_NO_SYSMOUSE"
  48 .Cd "options SC_PIXEL_MODE"
  49 .Cd "options SC_TWOBUTTON_MOUSE"
  50 .Cd "options SC_NORM_ATTR=_attribute_"
  51 .Cd "options SC_NORM_REV_ATTR=_attribute_"
  52 .Cd "options SC_KERNEL_CONS_ATTR=_attribute_"
  53 .Cd "options SC_KERNEL_CONS_REV_ATTR=_attribute_"
  54 .Cd "options SC_DFLT_FONT"
  55 .Cd "makeoptions SC_DFLT_FONT=_font_name_"
  56 .Cd "device sc0 at isa?" Op flags Ar flags
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 driver provides multiple virtual terminals.
  61 It resembles the SCO color console driver.
  62 .Pp
  63 The
  64 .Nm
  65 driver is implemented on top of the keyboard driver
  66 .Pq Xr atkbd 4
  67 and the video card drivers
  68 .Xr ( i915kms 4 ,
  69 .Xr radeonkms 4 ,
  70 or
  71 .Xr vga 4 ) .
  72 Please see
  73 .Sx Loader Tunables
  74 below on how to make the console work with
  75 .Xr i915kms 4
  76 or
  77 .Xr radeonkms 4 .
  78 .Pp
  79 There can be only one
  80 .Nm
  81 device defined in the system.
  82 .Ss Virtual Terminals
  83 The
  84 .Nm
  85 driver provides multiple virtual terminals which appear as if they were
  86 separate terminals.
  87 One virtual terminal is considered current and exclusively
  88 occupies the screen and the keyboard; the other virtual terminals
  89 are placed in the background.
  90 .Pp
  91 In order to use virtual terminals, they must be individually
  92 marked ``on'' in
  93 .Pa /etc/ttys
  94 so that
  95 .Xr getty 8
  96 will recognize them to be active and run
  97 .Xr login 1
  98 to let the user log in to the system.
  99 By default, only the first eight virtual terminals are activated in
 100 .Pa /etc/ttys .
 101 .Pp
 102 You press the
 103 .Dv Alt
 104 key and a switch key to switch between
 105 virtual terminals.
 106 The following table summarizes the correspondence between the switch
 107 key and the virtual terminal.
 108 .Bd -literal -offset indent
 109 Alt-F1   ttyv0      Alt-F7   ttyv6      Shift-Alt-F1   ttyv10
 110 Alt-F2   ttyv1      Alt-F8   ttyv7      Shift-Alt-F2   ttyv11
 111 Alt-F3   ttyv2      Alt-F9   ttyv8      Shift-Alt-F3   ttyv12
 112 Alt-F4   ttyv3      Alt-F10  ttyv9      Shift-Alt-F4   ttyv13
 113 Alt-F5   ttyv4      Alt-F11  ttyv10     Shift-Alt-F5   ttyv14
 114 Alt-F6   ttyv5      Alt-F12  ttyv11     Shift-Alt-F6   ttyv15
 115 .Ed
 116 .Pp
 117 You can also use the ``nscr'' key (usually the
 118 .Dv PrintScreen
 119 key on the AT Enhanced keyboard) to cycle available virtual terminals.
 120 .Pp
 121 The default number of available virtual terminals is 16.
 122 This can be changed with the kernel configuration option
 123 .Dv MAXCONS
 124 (see below).
 125 .Pp
 126 Note that the X server usually requires a virtual terminal for display
 127 purposes, so at least one terminal must be left unused by
 128 .Xr getty 8
 129 so that it can be used by the X server.
 130 .Ss Key Definitions and Function Key Strings
 131 The
 132 .Nm
 133 driver, in conjunction with the keyboard driver, allows the user
 134 to change key definitions and function key strings.
 135 The
 136 .Xr kbdcontrol 1
 137 command will load a key definition file (known as ``keymap'' file),
 138 dump the current keymap, and assign a string to a function key.
 139 See
 140 .Xr keyboard 4
 141 and
 142 .Xr kbdmap 5
 143 for the keymap file.
 144 .Pp
 145 You may want to set the
 146 .Ar keymap
 147 variable in
 148 .Pa /etc/rc.conf.local
 149 to the desired keymap file so that it will be automatically loaded
 150 when the system starts up.
 151 .Ss Software Font
 152 For most modern video cards, e.g. VGA, the
 153 .Nm
 154 driver and the video card driver allow the user to change
 155 the font used on the screen.
 156 The
 157 .Xr vidcontrol 1
 158 command can be used to load a font file from
 159 .Pa /usr/share/syscons/fonts .
 160 .Pp
 161 The font comes in various sizes: 8x8, 8x14 and 8x16.
 162 The 8x16 font is typically used for the VGA card in the
 163 80-column-by-25-line mode.
 164 Other video modes may require different font sizes.
 165 It is better to always load all three sizes of the same font.
 166 .Pp
 167 You may set
 168 .Ar font8x8 ,
 169 .Ar font8x14
 170 and
 171 .Ar font8x16
 172 variables in
 173 .Pa /etc/rc.conf
 174 to the desired font files so that they will be automatically loaded
 175 when the system starts up.
 176 .Pp
 177 Optionally you can specify a particular font file as the default.
 178 See the
 179 .Dv SC_DFLT_FONT
 180 option below.
 181 .Ss Screen Map
 182 If your video card does not support software fonts, you may still be able
 183 to achieve a similar effect by re-mapping the font built into your video card.
 184 Use
 185 .Xr vidcontrol 1
 186 to load a screen map file which defines the mapping between character codes.
 187 .Ss Mouse Support and Copy-and-Paste
 188 You can use your mouse to copy text on the screen and paste it as if
 189 it was typed by hand.
 190 You must be running the mouse daemon
 191 .Xr moused 8
 192 and enable the mouse cursor in the virtual terminal via
 193 .Xr vidcontrol 1 .
 194 .Pp
 195 Pressing mouse button 1 (usually the left button) will start selection.
 196 Releasing button 1 will end the selection process.
 197 The selected text will be marked by inverting foreground and
 198 background colors.
 199 You can press button 3 (usually the right button) to extend
 200 the selected region.
 201 The selected text is placed in the copy buffer and can be pasted
 202 at the cursor position by pressing button 2 (usually the
 203 middle button) as many times as you like.
 204 .Pp
 205 If your mouse has only two buttons, you may want to use the
 206 .Dv SC_TWOBUTTON_MOUSE
 207 option below to make the right button to paste the text.
 208 Alternatively you can make the mouse daemon
 209 emulate the middle button.
 210 See the man page for
 211 .Xr moused 8
 212 for more details.
 213 .Ss Back Scrolling
 214 The
 215 .Nm
 216 driver allows the user to browse the output which has ``scrolled off''
 217 the top of the screen.
 218 .Pp
 219 Press the ``slock'' key (usually
 220 .Dv ScrllLock
 221 /
 222 .Dv Scroll Lock
 223 or
 224 .Dv Pause
 225 on many keyboards) and the terminal is
 226 in the ``scrollback'' mode.
 227 It is indicated by the
 228 .Dv Scroll Lock
 229 LED.
 230 Use the arrow keys, the
 231 .Dv Page Up/Down
 232 keys and the
 233 .Dv Home/End
 234 keys to scroll buffered terminal output.
 235 Press the ``slock'' key again to get back to the normal terminal mode.
 236 .Pp
 237 The size of the scrollback buffer can be set by the
 238 .Dv SC_HISTORY_SIZE
 239 option described below.
 240 .Ss Screen Saver
 241 The
 242 .Nm
 243 driver can be made to put up the screen saver if the current
 244 virtual terminal is idle, that is, the user is not typing
 245 on the keyboard nor moving the mouse.
 246 See
 247 .Xr splash 4
 248 and
 249 .Xr vidcontrol 1
 250 for more details.
 251 .Sh DRIVER CONFIGURATION
 252 .Ss Loader Tunables
 253 The following tunable is available and can be set in
 254 .Xr loader.conf 5 .
 255 .Bl -tag -width ".Va kern.kms_console"
 256 .It Va kern.kms_console
 257 Setting this tunable to 0 disables experimental framebuffer support
 258 in conjunction with the
 259 .Xr i915kms 4
 260 or
 261 .Xr radeonkms 4
 262 drivers.
 263 It is 1 by default.
 264 .It Va kern.kms_columns
 265 The number of columns to use in conjunction with the
 266 .Xr i915kms 4
 267 and
 268 .Xr radeonkms 4
 269 drivers.
 270 The font size is scaled to match the requested number of columns.
 271 This requires
 272 .Va kern.kms_console
 273 to be set to 1.
 274 By default,
 275 .Nm
 276 tries to find a more or less pleasant looking default.
 277 Setting
 278 .Va kern.kms_columns
 279 to a negative value turns off scaling.
 280 .El
 281 .Ss Kernel Configuration Options
 282 The following kernel configuration options control the
 283 .Nm
 284 driver.
 285 .Bl -tag -width MOUSE
 286 .It Dv MAXCONS=N
 287 This option sets the number of virtual terminals to
 288 .Fa N .
 289 The default value is 16.
 290 .It Dv SC_ALT_MOUSE_IMAGE
 291 This option selects the alternative way of displaying the mouse cursor
 292 in the virtual terminal.
 293 It may be expensive for some video cards to draw the arrow-shaped
 294 cursor, and you may want to try this option.
 295 However, the appearance of the alternative mouse cursor may not be
 296 very appealing.
 297 Note that if you use the
 298 .Dv SC_NO_FONT_LOADING
 299 option then you must also use this option if you wish to be able to use
 300 the mouse.
 301 .It Dv SC_DISABLE_DDBKEY
 302 This option disables the ``debug'' key combination (by default, it is
 303 .Dv Alt-Esc ,
 304 or
 305 .Dv Ctl-PrintScreen ) .
 306 It will prevent users from
 307 entering the kernel debugger (DDB) by pressing the key combination.
 308 DDB will still be invoked when the kernel panics or hits a break point
 309 if it is included in the kernel.
 310 .It Dv SC_DISABLE_REBOOT
 311 This option disables the ``reboot'' key (by default, it is
 312 .Dv Ctl-Alt-Del ) ,
 313 so that the casual user may not accidentally reboot the system.
 314 .It Dv SC_HISTORY_SIZE=N
 315 Sets the size of back scroll buffer to
 316 .Fa N
 317 lines.
 318 The default value is 100.
 319 .It Dv SC_MOUSE_CHAR=C
 320 Unless the
 321 .Dv SC_ALT_MOUSE_IMAGE
 322 option above is specified, the
 323 .Nm
 324 driver reserves four consecutive character codes in order to display the
 325 mouse cursor in the virtual terminals in some systems.
 326 This option specifies the first character code to
 327 .Fa C
 328 to be used for this purpose.
 329 The default value is 0xd0.
 330 A good candidate is 0x03.
 331 .It Dv SC_PIXEL_MODE
 332 Adds support for pixel (raster) mode console.
 333 This mode is useful on some laptop computers, but less so on
 334 most other systems, and it adds substantial amount of code to
 335 .Nm .
 336 If this option is NOT defined, you can reduce the kernel size a lot.
 337 See the
 338 .Dv VESA800X600
 339 flag below.
 340 .It Dv SC_TWOBUTTON_MOUSE
 341 If you have a two button mouse, you may want to add this option
 342 to use the right button of the mouse to paste text.
 343 See
 344 .Sx Mouse Support and Copy-and-Paste
 345 above.
 346 .It Dv SC_NORM_ATTR=_attribute_
 347 .It Dv SC_NORM_REV_ATTR=_attribute_
 348 .It Dv SC_KERNEL_CONS_ATTR=_attribute_
 349 .It Dv SC_KERNEL_CONS_REV_ATTR=_attribute_
 350 These options will set the default colors.
 351 Available colors are defined in
 352 .In machine/pc/display.h .
 353 See
 354 .Sx EXAMPLES
 355 below.
 356 .It Dv SC_DFLT_FONT
 357 This option will specify the default font.
 358 Available fonts are: iso, iso2, koi8-r, koi8-u, cp437, cp850, cp865,
 359 cp866 and cp866u.
 360 16-line, 14-line and 8-line font data will be compiled in.
 361 Without this option, the
 362 .Nm
 363 driver will use whatever font is already loaded in the video card,
 364 unless you explicitly load a software font at startup.
 365 See
 366 .Sx EXAMPLES
 367 below.
 368 .El
 369 .Pp
 370 The following options will remove some features from the
 371 .Nm
 372 driver and save kernel memory.
 373 .Bl -tag -width MOUSE
 374 .It Dv SC_NO_CUTPASTE
 375 This option disables ``copy and paste'' operation in virtual
 376 terminals.
 377 .It Dv SC_NO_FONT_LOADING
 378 The
 379 .Nm
 380 driver can load software fonts on some video cards.
 381 This option removes this feature.
 382 Note that if you still wish to use
 383 the mouse with this option then you must also use the
 384 .Dv SC_ALT_MOUSE_IMAGE
 385 option.
 386 .It Dv SC_NO_HISTORY
 387 This option disables back-scrolling in virtual terminals.
 388 .\".It Dv SC_NO_PALETTE_LOADING
 389 .It Dv SC_NO_SYSMOUSE
 390 This option removes mouse support in the
 391 .Nm
 392 driver.
 393 The mouse daemon
 394 .Xr moused 8
 395 will fail if this option is defined.
 396 This option implies the
 397 .Dv SC_NO_CUTPASTE
 398 option too.
 399 .El
 400 .Ss Driver Flags
 401 The following driver flags can be used to control the
 402 .Nm
 403 driver.
 404 They can be set either in the kernel configuration file
 405 (see
 406 .Xr config 8 ) ,
 407 or else in the User Configuration Menu at boot
 408 time
 409 (see
 410 .Xr boot 8 ) .
 411 .Bl -tag -width bit_0
 412 .\".It bit 0 (VISUAL_BELL)
 413 .\"Uses the ``visual'' bell.
 414 .\"The screen will blink instead of generating audible sound.
 415 .\".It bit 1,2 (CURSOR_TYPE)
 416 .\"This option specifies the cursor appearance.
 417 .\"Possible values are:
 418 .\".Bl -tag -width TYPE -compact
 419 .\".It Dv 0
 420 .\"normal block cursor
 421 .\".It Dv 2
 422 .\"blinking block cursor
 423 .\".It Dv 4
 424 .\"underline cursor
 425 .\".It Dv 6
 426 .\"blinking underline (aka destructive) cursor
 427 .\".El
 428 .\".It bit 6 (QUIET_BELL)
 429 .\"This option suppresses the bell, whether audible or visual,
 430 .\"if it is rung in a background virtual terminal.
 431 .It 0x0080 (VESA800X600)
 432 This option puts the video card in the VESA 800x600 pixel, 16 color
 433 mode.
 434 It may be useful for laptop computers for which the 800x600 mode
 435 is otherwise unsupported by the X server.
 436 Note that in order for this flag to work, the kernel must be
 437 compiled with the
 438 .Dv SC_PIXEL_MODE
 439 option explained above.
 440 .\"Note also that the ``copy-and-paste'' function is not currently supported
 441 .\"in this mode and the mouse pointer will not be displayed.
 442 .It 0x0100 (AUTODETECT_KBD)
 443 This option instructs the
 444 .Nm
 445 driver to periodically scan
 446 for a keyboard device if it is not currently attached to one.
 447 Otherwise, the driver only probes for a keyboard once during bootup.
 448 .El
 449 .Sh IOCTLS
 450 The following
 451 .Xr ioctl 2
 452 commands are defined for the
 453 .Nm
 454 driver in
 455 .In sys/consio.h .
 456 .Pp
 457 .Bl -tag -width CONS -compact
 458 .It Dv KDGETMODE Ar int *mode
 459 .It Dv KDSETMODE Ar int *mode
 460 Get or set the mode of the current (virtual) console. The
 461 .Dv mode
 462 can be one of:
 463 .Pp
 464 .Bl -tag -width KD_GRAPHICS -compact
 465 .It Dv KD_TEXT
 466 same as
 467 .Dv KD_TEXT0
 468 .It Dv KD_TEXT0
 469 Text mode, restore fonts and palette
 470 .It Dv KD_GRAPHICS
 471 Graphics mode
 472 .It Dv KD_TEXT1
 473 Text mode, don't restore fonts and palette
 474 .It Dv KD_PIXEL
 475 Raster (pixel) text mode
 476 .El
 477 .Pp
 478 .It Dv KDSBORDER Ar int *color
 479 Set the border color of the current (virtual) console.
 480 .Pp
 481 .It Dv KDRASTER Ar scr_size_t *sizes
 482 Set raster (pixel) text mode and adjust the current (virtual) console's
 483 geometry and font size. The
 484 .Vt scr_size_t
 485 argument structure is as follows:
 486 .Bd -literal
 487 struct _scr_size {
 488         int     scr_size[3];
 489 };
 490 .Ed
 491 .Pp
 492 .It Dv GIO_SCRNMAP Ar scrmap_t *map
 493 .It Dv PIO_SCRNMAP Ar scrmap_t *map
 494 Get or set the screen map for the current (virtual) console. The
 495 .Vt scrmap_t
 496 argument structure is defined as follows:
 497 .Bd -literal
 498 struct _scrmap {
 499         char    scrmap[256];
 500 };
 501 .Ed
 502 .Pp
 503 .It Dv GIO_ATTR Ar int *attr
 504 Get the current text attribute.
 505 .Pp
 506 .It Dv GIO_COLOR Ar int *color
 507 Get the current text color.
 508 .Pp
 509 .It Dv CONS_CURRENT Ar int *type
 510 Get the adapter type. This is equivalent to
 511 .Dv FBIO_ADPTYPE .
 512 .Pp
 513 .It Dv CONS_GET Ar int *mode
 514 Get the current video mode. This is equivalent to
 515 .Dv FBIO_GETMODE .
 516 .Pp
 517 .It Dv CONS_SET Ar int *mode
 518 Set the current video mode. This is equivalent to
 519 .Dv FBIO_SETMODE .
 520 .Pp
 521 .It Dv CONS_BLANKTIME Ar int *time
 522 Set the screen saver blank interval (in seconds).
 523 .Pp
 524 .It Dv CONS_CURSORTYPE Ar int *type
 525 Set the text cursor shape. The argument
 526 .Dv type
 527 can be one or more of the following:
 528 .Pp
 529 .Bl -tag -width CONS_BLINK_CURSOR -compact
 530 .It Dv CONS_BLINK_CURSOR
 531 Set for a blinking cursor, unset for a non-blinking cursor.
 532 .It Dv CONS_CHAR_CURSOR
 533 Set for an underscore-shaped cursor, unset for a rectangle.
 534 .El
 535 .Pp
 536 .It Dv CONS_BELLTYPE Ar int *type
 537 Set the bell type. The argument
 538 .Dv type
 539 is one or more of:
 540 .Pp
 541 .Bl -tag -width CONS_VISUAL_BELL -compact
 542 .It Dv CONS_VISUAL_BELL
 543 Set for a visual bell, unset for an audible bell.
 544 .It Dv CONS_QUIET_BELL
 545 Set to enable the bell, unset to disable it.
 546 .El
 547 .Pp
 548 .It Dv CONS_HISTORY Ar int *size
 549 Set the history (scroll back) buffer size (in lines).
 550 .Pp
 551 .It Dv CONS_CLRHIST
 552 Clear the history (scroll back) buffer.
 553 .Pp
 554 .It Dv CONS_IDLE Ar int *idle
 555 Check if the (virtual) console has been idle.
 556 .Pp
 557 .It Dv CONS_SAVERMODE Ar int *mode
 558 Set the screen saver mode. The argument
 559 .Dv mode
 560 can be one of:
 561 .Pp
 562 .Bl -tag -width CONS_LKM_SAVER -compact
 563 .It Dv CONS_NO_SAVER
 564 Disable screen saver
 565 .It Dv CONS_USR_SAVER
 566 Enable screen saver
 567 .It Dv CONS_LKM_SAVER
 568 Add a new screen saver
 569 .El
 570 .Pp
 571 .It Dv CONS_SAVERSTART Ar int *start
 572 Start or stop the screen saver.
 573 .Pp
 574 .It Dv PIO_FONT8x8 Ar fnt8_t *font
 575 .It Dv GIO_FONT8x8 Ar fnt8_t *font
 576 Get or set the 8x8 font. The
 577 .Vt fnt8_t
 578 argument structure is defined as follows:
 579 .Bd -literal
 580 struct fnt8 {
 581         char    fnt8x8[8*256];
 582 };
 583 .Ed
 584 .Pp
 585 .It Dv PIO_FONT8x14 Ar fnt14_t *font
 586 .It Dv GIO_FONT8x14 Ar fnt14_t *font
 587 Get or set the 8x14 font. The
 588 .Vt fnt14_t
 589 argument structure is defined as follows:
 590 .Bd -literal
 591 struct fnt14 {
 592         char    fnt8x14[14*256];
 593 };
 594 .Ed
 595 .Pp
 596 .It Dv PIO_FONT8x16 Ar fnt16_t *font
 597 .It Dv GIO_FONT8x16 Ar fnt16_t *font
 598 Get or set the 8x16 font. The
 599 .Vt fnt16_t
 600 argument structure is defined as follows:
 601 .Bd -literal
 602 struct fnt16 {
 603         char    fnt8x16[16*256];
 604 };
 605 .Ed
 606 .Pp
 607 .It Dv CONS_GETINFO Ar vid_info_t *info
 608 Get information about the current video mode. The
 609 .Vt vid_info_t
 610 structure is defined as follows:
 611 .Bd -literal
 612 struct vid_info {
 613         short           size;
 614         short           m_num;
 615         u_short         font_size;
 616         u_short         mv_row, mv_col;
 617         u_short         mv_rsz, mv_csz;
 618         struct colors   mv_norm,
 619                         mv_rev,
 620                         mv_grfc;
 621         u_char          mv_ovscan;
 622         u_char          mk_keylock;
 623 };
 624 .Ed
 625 .Pp
 626 .It Dv CONS_GETVERS Ar int *version
 627 Get the version of the driver.
 628 .Pp
 629 .It Dv CONS_CURRENTADP Ar int *adapter
 630 Get the video adapter index. This is equivalent to
 631 .Dv FBIO_ADAPTER .
 632 .Pp
 633 .It Dv CONS_ADPINFO Ar video_adapter_info_t *info
 634 Get the video adapter information. This is equivalent to
 635 .Dv FBIO_ADPINFO .
 636 .Pp
 637 .It Dv CONS_MODEINFO Ar video_info_t *info
 638 Get the video mode information. This is equivalent to
 639 .Dv FBIO_MODEINFO .
 640 .Pp
 641 .It Dv CONS_FINDMODE Ar video_info_t *info
 642 Find a video mode. This is equivalent to
 643 .Dv FBIO_FINDMODE .
 644 .Pp
 645 .It Dv CONS_SETWINORG Ar u_int *origin
 646 Set the frame buffer window origin. This is equivalent to
 647 .Dv FBIO_SETWINORG .
 648 .Pp
 649 .It Dv CONS_SETKBD Ar int *kbd
 650 Set a new keyboard.
 651 .Pp
 652 .It Dv CONS_RELKBD
 653 Release the current keyboard.
 654 .Pp
 655 .It Dv CONS_SCRSHOT Ar scrshot_t *data
 656 Make a snapshot of the current video buffer. The
 657 .Vt scrshot_t
 658 structure is defined as:
 659 .Bd -literal
 660 struct scrshot {
 661         int             xsize;
 662         int             ysize;
 663         u_int16_t*      buf;
 664 };
 665 .Ed
 666 .Pp
 667 .It Dv CONS_GETTERM Ar term_info_t *info
 668 .It Dv CONS_SETTERM Ar term_info_t *info
 669 Get or set terminal characteristics. The
 670 .Vt term_info_t
 671 structure is defined as:
 672 .Bd -literal
 673 struct term_info {
 674         int             ti_index;
 675         int             ti_flags;
 676         u_char          ti_name[TI_NAME_LEN];
 677         u_char          ti_desc[TI_DESC_LEN];
 678 };
 679 .Ed
 680 .Pp
 681 .It Dv VT_OPENQRY Ar int *term
 682 Get the next available terminal.
 683 .Pp
 684 .It Dv VT_SETMODE Ar vtmode_t *mode
 685 .It Dv VT_GETMODE Ar vtmode_t *mode
 686 Get or set the terminal switching mode. The
 687 .Vt vtmode_t
 688 argument structure is defined as follows:
 689 .Bd -literal
 690 struct vt_mode {
 691         char            mode;
 692         char            waitv;
 693         short           relsig;
 694         short           acqsig;
 695         short           frsig;
 696 };
 697 .Ed
 698 .Pp
 699 .It Dv VT_RELDISP Ar int *ack
 700 Acknowledge the release or acquisition of a terminal. The
 701 .Dv ack
 702 argument can be one of:
 703 .Pp
 704 .Bl -tag -width VT_ACKACQ -compact
 705 .It Dv VT_FALSE
 706 The user refuses to release the screen, abort
 707 .It Dv VT_TRUE
 708 The user has released the screen, go on
 709 .It Dv VT_ACKACQ
 710 Acquisition of the screen acknowledged, switch completed
 711 .El
 712 .Pp
 713 .It Dv VT_ACTIVATE Ar int *term
 714 Activate the specified terminal.
 715 .Pp
 716 .It Dv VT_WAITACTIVE Ar int *term
 717 Wait until the specified terminal is active.
 718 .Pp
 719 .It Dv VT_GETACTIVE Ar int *term
 720 Get the currently active terminal.
 721 .Pp
 722 .It Dv VT_GETINDEX Ar int *index
 723 Get the index of the terminal.
 724 .Pp
 725 .It Dv VT_LOCKSWITCH Ar int *lock
 726 Prevent or permit terminal switching.
 727 .El
 728 .Sh FILES
 729 .Bl -tag -width /usr/share/syscons/xxxxyyyyzzz -compact
 730 .It Pa /dev/console
 731 .It Pa /dev/consolectl
 732 .It Pa /dev/ttyv?
 733 virtual terminals
 734 .It Pa /etc/ttys
 735 terminal initialization information
 736 .It Pa /usr/share/syscons/fonts/*
 737 font files
 738 .It Pa /usr/share/syscons/keymaps/*
 739 key map files
 740 .It Pa /usr/share/syscons/scrmaps/*
 741 screen map files
 742 .El
 743 .Sh EXAMPLES
 744 As the
 745 .Nm
 746 driver requires the keyboard driver and the video card driver,
 747 the kernel configuration file should contain the following lines.
 748 .Pp
 749 .D1 Cd device atkbdc0 at isa? port IO_KBD
 750 .D1 Cd device atkbd0 at atkbdc? irq 1
 751 .D1 Cd device vga0 at isa?
 752 .D1 Cd device sc0 at isa?
 753 .D1 Cd pseudo-device splash
 754 .Pp
 755 If you do not intend to load the splash image or use the screen saver,
 756 the last line is not necessary, and can be omitted.
 757 .Pp
 758 Note that the keyboard controller driver
 759 .Nm atkbdc
 760 is required by the keyboard driver
 761 .Nm atkbd .
 762 .Pp
 763 The following lines will set the default colors.
 764 The normal text will be green on black background.
 765 The reversed text will be yellow on green background.
 766 Note that you cannot put any white space inside the quoted string,
 767 because of the current implementation of
 768 .Xr config 8 .
 769 .Pp
 770 .D1 Cd "options SC_NORM_ATTR=(FG_GREEN|BG_BLACK)"
 771 .D1 Cd "options SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)"
 772 .Pp
 773 The following lines will set the default colors of the kernel message.
 774 The kernel message will be printed bright red on black background.
 775 The reversed message will be black on red background.
 776 .Pp
 777 .D1 Cd "options SC_KERNEL_CONS_ATTR=(FG_LIGHTRED|BG_BLACK)"
 778 .D1 Cd "options SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)"
 779 .Pp
 780 The following example adds the font files
 781 .Pa cp850-8x16.fnt ,
 782 .Pa cp850-8x14.font
 783 and
 784 .Pa cp850-8x8.font
 785 to the kernel.
 786 .Pp
 787 .D1 Cd "options SC_DFLT_FONT"
 788 .D1 Cd "makeoptions SC_DFLT_FONT=cp850"
 789 .D1 Cd "device sc0 at isa?"
 790 .\".Sh DIAGNOSTICS
 791 .Sh CAVEATS
 792 The amount of data that is possible to insert from the cut buffer is limited
 793 by the
 794 .Brq Dv MAX_INPUT ,
 795 a system limit on the number of bytes that may be stored in the terminal
 796 input queue - usually 1024 bytes
 797 (see
 798 .Xr termios 4 ) .
 799 .Sh SEE ALSO
 800 .Xr kbdcontrol 1 ,
 801 .Xr login 1 ,
 802 .Xr vidcontrol 1 ,
 803 .Xr atkbd 4 ,
 804 .Xr atkbdc 4 ,
 805 .Xr keyboard 4 ,
 806 .Xr screen 4 ,
 807 .Xr splash 4 ,
 808 .Xr sysmouse 4 ,
 809 .Xr ukbd 4 ,
 810 .Xr vga 4 ,
 811 .Xr kbdmap 5 ,
 812 .Xr rc.conf 5 ,
 813 .Xr ttys 5 ,
 814 .Xr config 8 ,
 815 .Xr getty 8 ,
 816 .Xr kldload 8 ,
 817 .Xr moused 8
 818 .Sh HISTORY
 819 The
 820 .Nm
 821 driver first appeared in
 822 .Fx 1.0 .
 823 .Sh AUTHORS
 824 .An -nosplit
 825 The
 826 .Nm
 827 driver was written by
 828 .An S\(/oren Schmidt Aq Mt sos@FreeBSD.org .
 829 This manual page was written by
 830 .An Kazutaka Yokota Aq Mt yokota@FreeBSD.org
 831 and
 832 .An Sascha Wildner .
 833 .Sh BUGS
 834 This manual page is incomplete and needs revision.