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