3 .\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
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.
27 .\" $FreeBSD: src/share/man/man4/syscons.4,v 1.10.2.14 2003/04/25 21:21:36 brueffer Exp $
28 .\" $DragonFly: src/share/man/man4/syscons.4,v 1.8 2007/08/19 11:39:11 swildner Exp $
36 .Nd the console driver
38 .Cd "options MAXCONS=N"
39 .Cd "options SC_ALT_MOUSE_IMAGE"
40 .Cd "options SC_DISABLE_DDBKEY"
41 .Cd "options SC_DISABLE_REBOOT"
42 .Cd "options SC_HISTORY_SIZE=N"
43 .Cd "options SC_MOUSE_CHAR=C"
44 .Cd "options SC_NO_CUTPASTE"
45 .Cd "options SC_NO_FONT_LOADING"
46 .Cd "options SC_NO_HISTORY"
47 .Cd "options SC_NO_PALETTE_LOADING"
48 .Cd "options SC_NO_SYSMOUSE"
49 .Cd "options SC_PIXEL_MODE"
50 .Cd "options SC_TWOBUTTON_MOUSE"
51 .Cd "options SC_NORM_ATTR=_attribute_"
52 .Cd "options SC_NORM_REV_ATTR=_attribute_"
53 .Cd "options SC_KERNEL_CONS_ATTR=_attribute_"
54 .Cd "options SC_KERNEL_CONS_REV_ATTR=_attribute_"
55 .Cd "options SC_DFLT_FONT"
56 .Cd "makeoptions SC_DFLT_FONT=_font_name_"
57 .Cd "device sc0 at isa?" Op flags Ar flags
61 driver provides multiple virtual terminals.
62 It resembles the SCO color console driver.
66 driver is implemented on top of the keyboard driver
68 and the video card driver
70 and so requires both of them to be configured in the system.
74 device defined in the system.
78 driver provides multiple virtual terminals which appear as if they were
80 One virtual terminal is considered current and exclusively
81 occupies the screen and the keyboard; the other virtual terminals
82 are placed in the background.
84 In order to use virtual terminals, they must be individually
89 will recognize them to be active and run
91 to let the user log in to the system.
92 By default, only the first eight virtual terminals are activated in
97 key and a switch key to switch between
99 The following table summarizes the correspondence between the switch
100 key and the virtual terminal.
101 .Bd -literal -offset indent
102 Alt-F1 ttyv0 Alt-F7 ttyv6 Shift-Alt-F1 ttyv10
103 Alt-F2 ttyv1 Alt-F8 ttyv7 Shift-Alt-F2 ttyv11
104 Alt-F3 ttyv2 Alt-F9 ttyv8 Shift-Alt-F3 ttyv12
105 Alt-F4 ttyv3 Alt-F10 ttyv9 Shift-Alt-F4 ttyv13
106 Alt-F5 ttyv4 Alt-F11 ttyv10 Shift-Alt-F5 ttyv14
107 Alt-F6 ttyv5 Alt-F12 ttyv11 Shift-Alt-F6 ttyv15
110 You can also use the ``nscr'' key (usually the
112 key on the AT Enhanced keyboard) to cycle available virtual terminals.
114 The default number of available virtual terminals is 16.
115 This can be changed with the kernel configuration option
119 Note that the X server usually requires a virtual terminal for display
120 purposes, so at least one terminal must be left unused by
122 so that it can be used by the X server.
123 .Ss Key Definitions and Function Key Strings
126 driver, in conjunction with the keyboard driver, allows the user
127 to change key definitions and function key strings.
130 command will load a key definition file (known as ``keymap'' file),
131 dump the current keymap, and assign a string to a function key.
138 You may want to set the
141 .Pa /etc/rc.conf.local
142 to the desired keymap file so that it will be automatically loaded
143 when the system starts up.
145 For most modern video cards, e.g. VGA, the
147 driver and the video card driver allow the user to change
148 the font used on the screen.
151 command can be used to load a font file from
152 .Pa /usr/share/syscons/fonts .
154 The font comes in various sizes: 8x8, 8x14 and 8x16.
155 The 8x16 font is typically used for the VGA card in the
156 80-column-by-25-line mode.
157 Other video modes may require different font sizes.
158 It is better to always load all three sizes of the same font.
167 to the desired font files so that they will be automatically loaded
168 when the system starts up.
170 Optionally you can specify a particular font file as the default.
175 If your video card does not support software fonts, you may still be able
176 to achieve a similar effect by re-mapping the font built into your video card.
179 to load a screen map file which defines the mapping between character codes.
180 .Ss Mouse Support and Copy-and-Paste
181 You can use your mouse to copy text on the screen and paste it as if
182 it was typed by hand.
183 You must be running the mouse daemon
185 and enable the mouse cursor in the virtual terminal via
188 Pressing mouse button 1 (usually the left button) will start selection.
189 Releasing button 1 will end the selection process.
190 The selected text will be marked by inverting foreground and
192 You can press button 3 (usually the right button) to extend
194 The selected text is placed in the copy buffer and can be pasted
195 at the cursor position by pressing button 2 (usually the
196 middle button) as many times as you like.
198 If your mouse has only two buttons, you may want to use the
199 .Dv SC_TWOBUTTON_MOUSE
200 option below to make the right button to paste the text.
201 Alternatively you can make the mouse daemon
202 emulate the middle button.
209 driver allows the user to browse the output which has ``scrolled off''
210 the top of the screen.
212 Press the ``slock'' key (usually
218 on many keyboards) and the terminal is
219 in the ``scrollback'' mode.
220 It is indicated by the
223 Use the arrow keys, the
227 keys to scroll buffered terminal output.
228 Press the ``slock'' key again to get back to the normal terminal mode.
230 The size of the scrollback buffer can be set by the
232 option described below.
236 driver can be made to put up the screen saver if the current
237 virtual terminal is idle, that is, the user is not typing
238 on the keyboard nor moving the mouse.
244 .Sh DRIVER CONFIGURATION
245 .Ss Kernel Configuration Options
246 The following kernel configuration options control the
249 .Bl -tag -width MOUSE
251 This option sets the number of virtual terminals to
253 The default value is 16.
254 .It Dv SC_ALT_MOUSE_IMAGE
255 This option selects the alternative way of displaying the mouse cursor
256 in the virtual terminal.
257 It may be expensive for some video cards to draw the arrow-shaped
258 cursor, and you may want to try this option.
259 However, the appearance of the alternative mouse cursor may not be
261 Note that if you use the
262 .Dv SC_NO_FONT_LOADING
263 option then you must also use this option if you wish to be able to use
265 .It Dv SC_DISABLE_DDBKEY
266 This option disables the ``debug'' key combination (by default, it is
269 .Dv Ctl-PrintScreen ) .
270 It will prevent users from
271 entering the kernel debugger (DDB) by pressing the key combination.
272 DDB will still be invoked when the kernel panics or hits a break point
273 if it is included in the kernel.
274 .It Dv SC_DISABLE_REBOOT
275 This option disables the ``reboot'' key (by default, it is
277 so that the casual user may not accidentally reboot the system.
278 .It Dv SC_HISTORY_SIZE=N
279 Sets the size of back scroll buffer to
282 The default value is 100.
283 .It Dv SC_MOUSE_CHAR=C
285 .Dv SC_ALT_MOUSE_IMAGE
286 option above is specified, the
288 driver reserves four consecutive character codes in order to display the
289 mouse cursor in the virtual terminals in some systems.
290 This option specifies the first character code to
292 to be used for this purpose.
293 The default value is 0xd0.
294 A good candidate is 0x03.
296 Adds support for pixel (raster) mode console.
297 This mode is useful on some laptop computers, but less so on
298 most other systems, and it adds substantial amount of code to
300 If this option is NOT defined, you can reduce the kernel size a lot.
304 .It Dv SC_TWOBUTTON_MOUSE
305 If you have a two button mouse, you may want to add this option
306 to use the right button of the mouse to paste text.
308 .Sx Mouse Support and Copy-and-Paste
310 .It Dv SC_NORM_ATTR=_attribute_
311 .It Dv SC_NORM_REV_ATTR=_attribute_
312 .It Dv SC_KERNEL_CONS_ATTR=_attribute_
313 .It Dv SC_KERNEL_CONS_REV_ATTR=_attribute_
314 These options will set the default colors.
315 Available colors are defined in
316 .In machine/pc/display.h .
321 This option will specify the default font.
322 Available fonts are: iso, iso2, koi8-r, koi8-u, cp437, cp850, cp865,
324 16-line, 14-line and 8-line font data will be compiled in.
325 Without this option, the
327 driver will use whatever font is already loaded in the video card,
328 unless you explicitly load a software font at startup.
334 The following options will remove some features from the
336 driver and save kernel memory.
337 .Bl -tag -width MOUSE
338 .It Dv SC_NO_CUTPASTE
339 This option disables ``copy and paste'' operation in virtual
341 .It Dv SC_NO_FONT_LOADING
344 driver can load software fonts on some video cards.
345 This option removes this feature.
346 Note that if you still wish to use
347 the mouse with this option then you must also use the
348 .Dv SC_ALT_MOUSE_IMAGE
351 This option disables back-scrolling in virtual terminals.
352 .\".It Dv SC_NO_PALETTE_LOADING
353 .It Dv SC_NO_SYSMOUSE
354 This option removes mouse support in the
359 will fail if this option is defined.
360 This option implies the
365 The following driver flags can be used to control the
368 They can be set either in the kernel configuration file
371 or else in the User Configuration Menu at boot
375 .Bl -tag -width bit_0
376 .\".It bit 0 (VISUAL_BELL)
377 .\"Uses the ``visual'' bell.
378 .\"The screen will blink instead of generating audible sound.
379 .\".It bit 1,2 (CURSOR_TYPE)
380 .\"This option specifies the cursor appearance.
381 .\"Possible values are:
382 .\".Bl -tag -width TYPE -compact
384 .\"normal block cursor
386 .\"blinking block cursor
390 .\"blinking underline (aka destructive) cursor
392 .\".It bit 6 (QUIET_BELL)
393 .\"This option suppresses the bell, whether audible or visual,
394 .\"if it is rung in a background virtual terminal.
395 .It 0x0080 (VESA800X600)
396 This option puts the video card in the VESA 800x600 pixel, 16 color
398 It may be useful for laptop computers for which the 800x600 mode
399 is otherwise unsupported by the X server.
400 Note that in order for this flag to work, the kernel must be
403 option explained above.
404 .\"Note also that the ``copy-and-paste'' function is not currently supported
405 .\"in this mode and the mouse pointer will not be displayed.
406 .It 0x0100 (AUTODETECT_KBD)
407 This option instructs the
409 driver to periodically scan
410 for a keyboard device if it is not currently attached to one.
411 Otherwise, the driver only probes for a keyboard once during bootup.
416 commands are defined for the
421 .Bl -tag -width CONS -compact
422 .It Dv KDGETMODE Ar int *mode
423 .It Dv KDSETMODE Ar int *mode
424 Get or set the mode of the current (virtual) console. The
428 .Bl -tag -width KD_GRAPHICS -compact
433 Text mode, restore fonts and palette
437 Text mode, don't restore fonts and palette
439 Raster (pixel) text mode
442 .It Dv KDSBORDER Ar int *color
443 Set the border color of the current (virtual) console.
445 .It Dv KDRASTER Ar scr_size_t *sizes
446 Set raster (pixel) text mode and adjust the current (virtual) console's
447 geometry and font size. The
449 argument structure is as follows:
456 .It Dv GIO_SCRNMAP Ar scrmap_t *map
457 .It Dv PIO_SCRNMAP Ar scrmap_t *map
458 Get or set the screen map for the current (virtual) console. The
460 argument structure is defined as follows:
467 .It Dv GIO_ATTR Ar int *attr
468 Get the current text attribute.
470 .It Dv GIO_COLOR Ar int *color
471 Get the current text color.
473 .It Dv CONS_CURRENT Ar int *type
474 Get the adapter type. This is equivalent to
477 .It Dv CONS_GET Ar int *mode
478 Get the current video mode. This is equivalent to
481 .It Dv CONS_SET Ar int *mode
482 Set the current video mode. This is equivalent to
485 .It Dv CONS_BLANKTIME Ar int *time
486 Set the screen saver blank interval (in seconds).
488 .It Dv CONS_CURSORTYPE Ar int *type
489 Set the text cursor shape. The argument
491 can be one or more of the following:
493 .Bl -tag -width CONS_BLINK_CURSOR -compact
494 .It Dv CONS_BLINK_CURSOR
495 Set for a blinking cursor, unset for a non-blinking cursor.
496 .It Dv CONS_CHAR_CURSOR
497 Set for an underscore-shaped cursor, unset for a rectangle.
500 .It Dv CONS_BELLTYPE Ar int *type
501 Set the bell type. The argument
505 .Bl -tag -width CONS_VISUAL_BELL -compact
506 .It Dv CONS_VISUAL_BELL
507 Set for a visual bell, unset for an audible bell.
508 .It Dv CONS_QUIET_BELL
509 Set to enable the bell, unset to disable it.
512 .It Dv CONS_HISTORY Ar int *size
513 Set the history (scroll back) buffer size (in lines).
516 Clear the history (scroll back) buffer.
518 .It Dv CONS_IDLE Ar int *idle
519 Check if the (virtual) console has been idle.
521 .It Dv CONS_SAVERMODE Ar int *mode
522 Set the screen saver mode. The argument
526 .Bl -tag -width CONS_LKM_SAVER -compact
529 .It Dv CONS_USR_SAVER
531 .It Dv CONS_LKM_SAVER
532 Add a new screen saver
535 .It Dv CONS_SAVERSTART Ar int *start
536 Start or stop the screen saver.
538 .It Dv PIO_FONT8x8 Ar fnt8_t *font
539 .It Dv GIO_FONT8x8 Ar fnt8_t *font
540 Get or set the 8x8 font. The
542 argument structure is defined as follows:
549 .It Dv PIO_FONT8x14 Ar fnt14_t *font
550 .It Dv GIO_FONT8x14 Ar fnt14_t *font
551 Get or set the 8x14 font. The
553 argument structure is defined as follows:
556 char fnt8x14[14*256];
560 .It Dv PIO_FONT8x16 Ar fnt16_t *font
561 .It Dv GIO_FONT8x16 Ar fnt16_t *font
562 Get or set the 8x16 font. The
564 argument structure is defined as follows:
567 char fnt8x16[16*256];
571 .It Dv CONS_GETINFO Ar vid_info_t *info
572 Get information about the current video mode. The
574 structure is defined as follows:
580 u_short mv_row, mv_col;
581 u_short mv_rsz, mv_csz;
582 struct colors mv_norm,
590 .It Dv CONS_GETVERS Ar int *version
591 Get the version of the driver.
593 .It Dv CONS_CURRENTADP Ar int *adapter
594 Get the video adapter index. This is equivalent to
597 .It Dv CONS_ADPINFO Ar video_adapter_info_t *info
598 Get the video adapter information. This is equivalent to
601 .It Dv CONS_MODEINFO Ar video_info_t *info
602 Get the video mode information. This is equivalent to
605 .It Dv CONS_FINDMODE Ar video_info_t *info
606 Find a video mode. This is equivalent to
609 .It Dv CONS_SETWINORG Ar u_int *origin
610 Set the frame buffer window origin. This is equivalent to
613 .It Dv CONS_SETKBD Ar int *kbd
617 Release the current keyboard.
619 .It Dv CONS_SCRSHOT Ar scrshot_t *data
620 Make a snapshot of the current video buffer. The
622 structure is defined as:
631 .It Dv CONS_GETTERM Ar term_info_t *info
632 .It Dv CONS_SETTERM Ar term_info_t *info
633 Get or set terminal characteristics. The
635 structure is defined as:
640 u_char ti_name[TI_NAME_LEN];
641 u_char ti_desc[TI_DESC_LEN];
645 .It Dv VT_OPENQRY Ar int *term
646 Get the next available terminal.
648 .It Dv VT_SETMODE Ar vtmode_t *mode
649 .It Dv VT_GETMODE Ar vtmode_t *mode
650 Get or set the terminal switching mode. The
652 argument structure is defined as follows:
663 .It Dv VT_RELDISP Ar int *ack
664 Acknowledge the release or acquisition of a terminal. The
666 argument can be one of:
668 .Bl -tag -width VT_ACKACQ -compact
670 The user refuses to release the screen, abort
672 The user has released the screen, go on
674 Acquisition of the screen acknowledged, switch completed
677 .It Dv VT_ACTIVATE Ar int *term
678 Activate the specified terminal.
680 .It Dv VT_WAITACTIVE Ar int *term
681 Wait until the specified terminal is active.
683 .It Dv VT_GETACTIVE Ar int *term
684 Get the currently active terminal.
686 .It Dv VT_GETINDEX Ar int *index
687 Get the index of the terminal.
689 .It Dv VT_LOCKSWITCH Ar int *lock
690 Prevent or permit terminal switching.
693 .Bl -tag -width /usr/share/syscons/xxxxyyyyzzz -compact
695 .It Pa /dev/consolectl
699 terminal initialization information
700 .It Pa /usr/share/syscons/fonts/*
702 .It Pa /usr/share/syscons/keymaps/*
704 .It Pa /usr/share/syscons/scrmaps/*
710 driver requires the keyboard driver and the video card driver,
711 the kernel configuration file should contain the following lines.
713 .D1 Cd device atkbdc0 at isa? port IO_KBD
714 .D1 Cd device atkbd0 at atkbdc? irq 1
715 .D1 Cd device vga0 at isa?
716 .D1 Cd device sc0 at isa?
717 .D1 Cd pseudo-device splash
719 If you do not intend to load the splash image or use the screen saver,
720 the last line is not necessary, and can be omitted.
722 Note that the keyboard controller driver
724 is required by the keyboard driver
727 The following lines will set the default colors.
728 The normal text will be green on black background.
729 The reversed text will be yellow on green background.
730 Note that you cannot put any white space inside the quoted string,
731 because of the current implementation of
734 .D1 Cd "options SC_NORM_ATTR=(FG_GREEN|BG_BLACK)"
735 .D1 Cd "options SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)"
737 The following lines will set the default colors of the kernel message.
738 The kernel message will be printed bright red on black background.
739 The reversed message will be black on red background.
741 .D1 Cd "options SC_KERNEL_CONS_ATTR=(FG_LIGHTRED|BG_BLACK)"
742 .D1 Cd "options SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)"
744 The following example adds the font files
751 .D1 Cd "options SC_DFLT_FONT"
752 .D1 Cd "makeoptions SC_DFLT_FONT=cp850"
753 .D1 Cd "device sc0 at isa?"
756 The amount of data that is possible to insert from the cut buffer is limited
759 a system limit on the number of bytes that may be stored in the terminal
760 input queue - usually 1024 bytes
785 driver first appeared in
791 driver was written by
792 .An S\(/oren Schmidt Aq sos@FreeBSD.org .
793 This manual page was written by
794 .An Kazutaka Yokota Aq yokota@FreeBSD.org
798 This manual page is incomplete and needs revision.