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 August 11, 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 DRIVER CONFIGURATION
  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 tunables are 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 Sysctl Variables
 282 The following
 283 .Xr sysctl 8
 284 variable is available and can be either set via
 285 .Xr sysctl.conf 5
 286 or from the command line.
 287 .Bl -tag -width ".Va kern.syscons_async"
 288 .It Va kern.syscons_async
 289 Set to 1 to enable asynchronous bulk framebuffer updates.
 290 It is intended to help with
 291 .Xr sound 4
 292 stuttering when a high resolution
 293 .Nm
 294 scrolls during playback.
 295 It is not enabled by default because on certain machines it has lead to
 296 subtle issues with for example
 297 .Xr ddb 4 .
 298 .El
 299 .Ss Kernel Configuration Options
 300 The following kernel configuration options control the
 301 .Nm
 302 driver.
 303 .Bl -tag -width MOUSE
 304 .It Dv MAXCONS=N
 305 This option sets the number of virtual terminals to
 306 .Fa N .
 307 The default value is 16.
 308 .It Dv SC_ALT_MOUSE_IMAGE
 309 This option selects the alternative way of displaying the mouse cursor
 310 in the virtual terminal.
 311 It may be expensive for some video cards to draw the arrow-shaped
 312 cursor, and you may want to try this option.
 313 However, the appearance of the alternative mouse cursor may not be
 314 very appealing.
 315 Note that if you use the
 316 .Dv SC_NO_FONT_LOADING
 317 option then you must also use this option if you wish to be able to use
 318 the mouse.
 319 .It Dv SC_DISABLE_DDBKEY
 320 This option disables the ``debug'' key combination (by default, it is
 321 .Dv Alt-Esc ,
 322 or
 323 .Dv Ctl-PrintScreen ) .
 324 It will prevent users from
 325 entering the kernel debugger (DDB) by pressing the key combination.
 326 DDB will still be invoked when the kernel panics or hits a break point
 327 if it is included in the kernel.
 328 .It Dv SC_DISABLE_REBOOT
 329 This option disables the ``reboot'' key (by default, it is
 330 .Dv Ctl-Alt-Del ) ,
 331 so that the casual user may not accidentally reboot the system.
 332 .It Dv SC_HISTORY_SIZE=N
 333 Sets the size of back scroll buffer to
 334 .Fa N
 335 lines.
 336 The default value is 100.
 337 .It Dv SC_MOUSE_CHAR=C
 338 Unless the
 339 .Dv SC_ALT_MOUSE_IMAGE
 340 option above is specified, the
 341 .Nm
 342 driver reserves four consecutive character codes in order to display the
 343 mouse cursor in the virtual terminals in some systems.
 344 This option specifies the first character code to
 345 .Fa C
 346 to be used for this purpose.
 347 The default value is 0xd0.
 348 A good candidate is 0x03.
 349 .It Dv SC_PIXEL_MODE
 350 Adds support for pixel (raster) mode console.
 351 This mode is useful on some laptop computers, but less so on
 352 most other systems, and it adds substantial amount of code to
 353 .Nm .
 354 If this option is NOT defined, you can reduce the kernel size a lot.
 355 See the
 356 .Dv VESA800X600
 357 flag below.
 358 .It Dv SC_TWOBUTTON_MOUSE
 359 If you have a two button mouse, you may want to add this option
 360 to use the right button of the mouse to paste text.
 361 See
 362 .Sx Mouse Support and Copy-and-Paste
 363 above.
 364 .It Dv SC_NORM_ATTR=_attribute_
 365 .It Dv SC_NORM_REV_ATTR=_attribute_
 366 .It Dv SC_KERNEL_CONS_ATTR=_attribute_
 367 .It Dv SC_KERNEL_CONS_REV_ATTR=_attribute_
 368 These options will set the default colors.
 369 Available colors are defined in
 370 .In machine/pc/display.h .
 371 See
 372 .Sx EXAMPLES
 373 below.
 374 .It Dv SC_DFLT_FONT
 375 This option will specify the default font.
 376 Available fonts are: iso, iso2, koi8-r, koi8-u, cp437, cp850, cp865,
 377 cp866 and cp866u.
 378 16-line, 14-line and 8-line font data will be compiled in.
 379 Without this option, the
 380 .Nm
 381 driver will use whatever font is already loaded in the video card,
 382 unless you explicitly load a software font at startup.
 383 See
 384 .Sx EXAMPLES
 385 below.
 386 .El
 387 .Pp
 388 The following options will remove some features from the
 389 .Nm
 390 driver and save kernel memory.
 391 .Bl -tag -width MOUSE
 392 .It Dv SC_NO_CUTPASTE
 393 This option disables ``copy and paste'' operation in virtual
 394 terminals.
 395 .It Dv SC_NO_FONT_LOADING
 396 The
 397 .Nm
 398 driver can load software fonts on some video cards.
 399 This option removes this feature.
 400 Note that if you still wish to use
 401 the mouse with this option then you must also use the
 402 .Dv SC_ALT_MOUSE_IMAGE
 403 option.
 404 .It Dv SC_NO_HISTORY
 405 This option disables back-scrolling in virtual terminals.
 406 .\".It Dv SC_NO_PALETTE_LOADING
 407 .It Dv SC_NO_SYSMOUSE
 408 This option removes mouse support in the
 409 .Nm
 410 driver.
 411 The mouse daemon
 412 .Xr moused 8
 413 will fail if this option is defined.
 414 This option implies the
 415 .Dv SC_NO_CUTPASTE
 416 option too.
 417 .El
 418 .Ss Driver Flags
 419 The following driver flags can be used to control the
 420 .Nm
 421 driver.
 422 They can be set either in the kernel configuration file
 423 (see
 424 .Xr config 8 ) ,
 425 or else in the User Configuration Menu at boot
 426 time
 427 (see
 428 .Xr boot 8 ) .
 429 .Bl -tag -width bit_0
 430 .\".It bit 0 (VISUAL_BELL)
 431 .\"Uses the ``visual'' bell.
 432 .\"The screen will blink instead of generating audible sound.
 433 .\".It bit 1,2 (CURSOR_TYPE)
 434 .\"This option specifies the cursor appearance.
 435 .\"Possible values are:
 436 .\".Bl -tag -width TYPE -compact
 437 .\".It Dv 0
 438 .\"normal block cursor
 439 .\".It Dv 2
 440 .\"blinking block cursor
 441 .\".It Dv 4
 442 .\"underline cursor
 443 .\".It Dv 6
 444 .\"blinking underline (aka destructive) cursor
 445 .\".El
 446 .\".It bit 6 (QUIET_BELL)
 447 .\"This option suppresses the bell, whether audible or visual,
 448 .\"if it is rung in a background virtual terminal.
 449 .It 0x0080 (VESA800X600)
 450 This option puts the video card in the VESA 800x600 pixel, 16 color
 451 mode.
 452 It may be useful for laptop computers for which the 800x600 mode
 453 is otherwise unsupported by the X server.
 454 Note that in order for this flag to work, the kernel must be
 455 compiled with the
 456 .Dv SC_PIXEL_MODE
 457 option explained above.
 458 .\"Note also that the ``copy-and-paste'' function is not currently supported
 459 .\"in this mode and the mouse pointer will not be displayed.
 460 .It 0x0100 (AUTODETECT_KBD)
 461 This option instructs the
 462 .Nm
 463 driver to periodically scan
 464 for a keyboard device if it is not currently attached to one.
 465 Otherwise, the driver only probes for a keyboard once during bootup.
 466 .El
 467 .Sh IOCTLS
 468 The following
 469 .Xr ioctl 2
 470 commands are defined for the
 471 .Nm
 472 driver in
 473 .In sys/consio.h .
 474 .Pp
 475 .Bl -tag -width CONS -compact
 476 .It Dv KDGETMODE Ar int *mode
 477 .It Dv KDSETMODE Ar int *mode
 478 Get or set the mode of the current (virtual) console. The
 479 .Dv mode
 480 can be one of:
 481 .Pp
 482 .Bl -tag -width KD_GRAPHICS -compact
 483 .It Dv KD_TEXT
 484 same as
 485 .Dv KD_TEXT0
 486 .It Dv KD_TEXT0
 487 Text mode, restore fonts and palette
 488 .It Dv KD_GRAPHICS
 489 Graphics mode
 490 .It Dv KD_TEXT1
 491 Text mode, don't restore fonts and palette
 492 .It Dv KD_PIXEL
 493 Raster (pixel) text mode
 494 .El
 495 .Pp
 496 .It Dv KDSBORDER Ar int *color
 497 Set the border color of the current (virtual) console.
 498 .Pp
 499 .It Dv KDRASTER Ar scr_size_t *sizes
 500 Set raster (pixel) text mode and adjust the current (virtual) console's
 501 geometry and font size. The
 502 .Vt scr_size_t
 503 argument structure is as follows:
 504 .Bd -literal
 505 struct _scr_size {
 506         int     scr_size[3];
 507 };
 508 .Ed
 509 .Pp
 510 .It Dv GIO_SCRNMAP Ar scrmap_t *map
 511 .It Dv PIO_SCRNMAP Ar scrmap_t *map
 512 Get or set the screen map for the current (virtual) console. The
 513 .Vt scrmap_t
 514 argument structure is defined as follows:
 515 .Bd -literal
 516 struct _scrmap {
 517         char    scrmap[256];
 518 };
 519 .Ed
 520 .Pp
 521 .It Dv GIO_ATTR Ar int *attr
 522 Get the current text attribute.
 523 .Pp
 524 .It Dv GIO_COLOR Ar int *color
 525 Get the current text color.
 526 .Pp
 527 .It Dv CONS_CURRENT Ar int *type
 528 Get the adapter type. This is equivalent to
 529 .Dv FBIO_ADPTYPE .
 530 .Pp
 531 .It Dv CONS_GET Ar int *mode
 532 Get the current video mode. This is equivalent to
 533 .Dv FBIO_GETMODE .
 534 .Pp
 535 .It Dv CONS_SET Ar int *mode
 536 Set the current video mode. This is equivalent to
 537 .Dv FBIO_SETMODE .
 538 .Pp
 539 .It Dv CONS_BLANKTIME Ar int *time
 540 Set the screen saver blank interval (in seconds).
 541 .Pp
 542 .It Dv CONS_CURSORTYPE Ar int *type
 543 Set the text cursor shape. The argument
 544 .Dv type
 545 can be one or more of the following:
 546 .Pp
 547 .Bl -tag -width CONS_BLINK_CURSOR -compact
 548 .It Dv CONS_BLINK_CURSOR
 549 Set for a blinking cursor, unset for a non-blinking cursor.
 550 .It Dv CONS_CHAR_CURSOR
 551 Set for an underscore-shaped cursor, unset for a rectangle.
 552 .El
 553 .Pp
 554 .It Dv CONS_BELLTYPE Ar int *type
 555 Set the bell type. The argument
 556 .Dv type
 557 is one or more of:
 558 .Pp
 559 .Bl -tag -width CONS_VISUAL_BELL -compact
 560 .It Dv CONS_VISUAL_BELL
 561 Set for a visual bell, unset for an audible bell.
 562 .It Dv CONS_QUIET_BELL
 563 Set to enable the bell, unset to disable it.
 564 .El
 565 .Pp
 566 .It Dv CONS_HISTORY Ar int *size
 567 Set the history (scroll back) buffer size (in lines).
 568 .Pp
 569 .It Dv CONS_CLRHIST
 570 Clear the history (scroll back) buffer.
 571 .Pp
 572 .It Dv CONS_IDLE Ar int *idle
 573 Check if the (virtual) console has been idle.
 574 .Pp
 575 .It Dv CONS_SAVERMODE Ar int *mode
 576 Set the screen saver mode. The argument
 577 .Dv mode
 578 can be one of:
 579 .Pp
 580 .Bl -tag -width CONS_LKM_SAVER -compact
 581 .It Dv CONS_NO_SAVER
 582 Disable screen saver
 583 .It Dv CONS_USR_SAVER
 584 Enable screen saver
 585 .It Dv CONS_LKM_SAVER
 586 Add a new screen saver
 587 .El
 588 .Pp
 589 .It Dv CONS_SAVERSTART Ar int *start
 590 Start or stop the screen saver.
 591 .Pp
 592 .It Dv PIO_FONT8x8 Ar fnt8_t *font
 593 .It Dv GIO_FONT8x8 Ar fnt8_t *font
 594 Get or set the 8x8 font. The
 595 .Vt fnt8_t
 596 argument structure is defined as follows:
 597 .Bd -literal
 598 struct fnt8 {
 599         char    fnt8x8[8*256];
 600 };
 601 .Ed
 602 .Pp
 603 .It Dv PIO_FONT8x14 Ar fnt14_t *font
 604 .It Dv GIO_FONT8x14 Ar fnt14_t *font
 605 Get or set the 8x14 font. The
 606 .Vt fnt14_t
 607 argument structure is defined as follows:
 608 .Bd -literal
 609 struct fnt14 {
 610         char    fnt8x14[14*256];
 611 };
 612 .Ed
 613 .Pp
 614 .It Dv PIO_FONT8x16 Ar fnt16_t *font
 615 .It Dv GIO_FONT8x16 Ar fnt16_t *font
 616 Get or set the 8x16 font. The
 617 .Vt fnt16_t
 618 argument structure is defined as follows:
 619 .Bd -literal
 620 struct fnt16 {
 621         char    fnt8x16[16*256];
 622 };
 623 .Ed
 624 .Pp
 625 .It Dv CONS_GETINFO Ar vid_info_t *info
 626 Get information about the current video mode. The
 627 .Vt vid_info_t
 628 structure is defined as follows:
 629 .Bd -literal
 630 struct vid_info {
 631         short           size;
 632         short           m_num;
 633         u_short         font_size;
 634         u_short         mv_row, mv_col;
 635         u_short         mv_rsz, mv_csz;
 636         struct colors   mv_norm,
 637                         mv_rev,
 638                         mv_grfc;
 639         u_char          mv_ovscan;
 640         u_char          mk_keylock;
 641 };
 642 .Ed
 643 .Pp
 644 .It Dv CONS_GETVERS Ar int *version
 645 Get the version of the driver.
 646 .Pp
 647 .It Dv CONS_CURRENTADP Ar int *adapter
 648 Get the video adapter index. This is equivalent to
 649 .Dv FBIO_ADAPTER .
 650 .Pp
 651 .It Dv CONS_ADPINFO Ar video_adapter_info_t *info
 652 Get the video adapter information. This is equivalent to
 653 .Dv FBIO_ADPINFO .
 654 .Pp
 655 .It Dv CONS_MODEINFO Ar video_info_t *info
 656 Get the video mode information. This is equivalent to
 657 .Dv FBIO_MODEINFO .
 658 .Pp
 659 .It Dv CONS_FINDMODE Ar video_info_t *info
 660 Find a video mode. This is equivalent to
 661 .Dv FBIO_FINDMODE .
 662 .Pp
 663 .It Dv CONS_SETWINORG Ar u_int *origin
 664 Set the frame buffer window origin. This is equivalent to
 665 .Dv FBIO_SETWINORG .
 666 .Pp
 667 .It Dv CONS_SETKBD Ar int *kbd
 668 Set a new keyboard.
 669 .Pp
 670 .It Dv CONS_RELKBD
 671 Release the current keyboard.
 672 .Pp
 673 .It Dv CONS_SCRSHOT Ar scrshot_t *data
 674 Make a snapshot of the current video buffer. The
 675 .Vt scrshot_t
 676 structure is defined as:
 677 .Bd -literal
 678 struct scrshot {
 679         int             xsize;
 680         int             ysize;
 681         u_int16_t*      buf;
 682 };
 683 .Ed
 684 .Pp
 685 .It Dv CONS_GETTERM Ar term_info_t *info
 686 .It Dv CONS_SETTERM Ar term_info_t *info
 687 Get or set terminal characteristics. The
 688 .Vt term_info_t
 689 structure is defined as:
 690 .Bd -literal
 691 struct term_info {
 692         int             ti_index;
 693         int             ti_flags;
 694         u_char          ti_name[TI_NAME_LEN];
 695         u_char          ti_desc[TI_DESC_LEN];
 696 };
 697 .Ed
 698 .Pp
 699 .It Dv VT_OPENQRY Ar int *term
 700 Get the next available terminal.
 701 .Pp
 702 .It Dv VT_SETMODE Ar vtmode_t *mode
 703 .It Dv VT_GETMODE Ar vtmode_t *mode
 704 Get or set the terminal switching mode. The
 705 .Vt vtmode_t
 706 argument structure is defined as follows:
 707 .Bd -literal
 708 struct vt_mode {
 709         char            mode;
 710         char            waitv;
 711         short           relsig;
 712         short           acqsig;
 713         short           frsig;
 714 };
 715 .Ed
 716 .Pp
 717 .It Dv VT_RELDISP Ar int *ack
 718 Acknowledge the release or acquisition of a terminal. The
 719 .Dv ack
 720 argument can be one of:
 721 .Pp
 722 .Bl -tag -width VT_ACKACQ -compact
 723 .It Dv VT_FALSE
 724 The user refuses to release the screen, abort
 725 .It Dv VT_TRUE
 726 The user has released the screen, go on
 727 .It Dv VT_ACKACQ
 728 Acquisition of the screen acknowledged, switch completed
 729 .El
 730 .Pp
 731 .It Dv VT_ACTIVATE Ar int *term
 732 Activate the specified terminal.
 733 .Pp
 734 .It Dv VT_WAITACTIVE Ar int *term
 735 Wait until the specified terminal is active.
 736 .Pp
 737 .It Dv VT_GETACTIVE Ar int *term
 738 Get the currently active terminal.
 739 .Pp
 740 .It Dv VT_GETINDEX Ar int *index
 741 Get the index of the terminal.
 742 .Pp
 743 .It Dv VT_LOCKSWITCH Ar int *lock
 744 Prevent or permit terminal switching.
 745 .El
 746 .Sh FILES
 747 .Bl -tag -width /usr/share/syscons/xxxxyyyyzzz -compact
 748 .It Pa /dev/console
 749 .It Pa /dev/consolectl
 750 .It Pa /dev/ttyv?
 751 virtual terminals
 752 .It Pa /etc/ttys
 753 terminal initialization information
 754 .It Pa /usr/share/syscons/fonts/*
 755 font files
 756 .It Pa /usr/share/syscons/keymaps/*
 757 key map files
 758 .It Pa /usr/share/syscons/scrmaps/*
 759 screen map files
 760 .El
 761 .Sh EXAMPLES
 762 As the
 763 .Nm
 764 driver requires the keyboard driver and the video card driver,
 765 the kernel configuration file should contain the following lines.
 766 .Pp
 767 .D1 Cd device atkbdc0 at isa? port IO_KBD
 768 .D1 Cd device atkbd0 at atkbdc? irq 1
 769 .D1 Cd device vga0 at isa?
 770 .D1 Cd device sc0 at isa?
 771 .D1 Cd pseudo-device splash
 772 .Pp
 773 If you do not intend to load the splash image or use the screen saver,
 774 the last line is not necessary, and can be omitted.
 775 .Pp
 776 Note that the keyboard controller driver
 777 .Nm atkbdc
 778 is required by the keyboard driver
 779 .Nm atkbd .
 780 .Pp
 781 The following lines will set the default colors.
 782 The normal text will be green on black background.
 783 The reversed text will be yellow on green background.
 784 Note that you cannot put any white space inside the quoted string,
 785 because of the current implementation of
 786 .Xr config 8 .
 787 .Pp
 788 .D1 Cd "options SC_NORM_ATTR=(FG_GREEN|BG_BLACK)"
 789 .D1 Cd "options SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)"
 790 .Pp
 791 The following lines will set the default colors of the kernel message.
 792 The kernel message will be printed bright red on black background.
 793 The reversed message will be black on red background.
 794 .Pp
 795 .D1 Cd "options SC_KERNEL_CONS_ATTR=(FG_LIGHTRED|BG_BLACK)"
 796 .D1 Cd "options SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)"
 797 .Pp
 798 The following example adds the font files
 799 .Pa cp850-8x16.fnt ,
 800 .Pa cp850-8x14.font
 801 and
 802 .Pa cp850-8x8.font
 803 to the kernel.
 804 .Pp
 805 .D1 Cd "options SC_DFLT_FONT"
 806 .D1 Cd "makeoptions SC_DFLT_FONT=cp850"
 807 .D1 Cd "device sc0 at isa?"
 808 .\".Sh DIAGNOSTICS
 809 .Sh CAVEATS
 810 The amount of data that is possible to insert from the cut buffer is limited
 811 by the
 812 .Brq Dv MAX_INPUT ,
 813 a system limit on the number of bytes that may be stored in the terminal
 814 input queue - usually 1024 bytes
 815 (see
 816 .Xr termios 4 ) .
 817 .Sh SEE ALSO
 818 .Xr kbdcontrol 1 ,
 819 .Xr login 1 ,
 820 .Xr vidcontrol 1 ,
 821 .Xr atkbd 4 ,
 822 .Xr atkbdc 4 ,
 823 .Xr keyboard 4 ,
 824 .Xr screen 4 ,
 825 .Xr splash 4 ,
 826 .Xr sysmouse 4 ,
 827 .Xr ukbd 4 ,
 828 .Xr vga 4 ,
 829 .Xr kbdmap 5 ,
 830 .Xr rc.conf 5 ,
 831 .Xr ttys 5 ,
 832 .Xr config 8 ,
 833 .Xr getty 8 ,
 834 .Xr kldload 8 ,
 835 .Xr moused 8
 836 .Sh HISTORY
 837 The
 838 .Nm
 839 driver first appeared in
 840 .Fx 1.0 .
 841 .Sh AUTHORS
 842 .An -nosplit
 843 The
 844 .Nm
 845 driver was written by
 846 .An S\(/oren Schmidt Aq Mt sos@FreeBSD.org .
 847 This manual page was written by
 848 .An Kazutaka Yokota Aq Mt yokota@FreeBSD.org
 849 and
 850 .An Sascha Wildner .
 851 .Sh BUGS
 852 This manual page is incomplete and needs revision.