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