diff options
author | yokota <yokota@FreeBSD.org> | 1999-02-10 14:25:03 +0000 |
---|---|---|
committer | yokota <yokota@FreeBSD.org> | 1999-02-10 14:25:03 +0000 |
commit | 8d9b8047a3f4381cb28d8751cef0c3d36b4db86c (patch) | |
tree | 4b03f0b8fdf0b43b7adeb3ac843a40eabacf80d2 /share/man/man4 | |
parent | b897dbf5fefd31449773c0bf237f97f7605ea816 (diff) | |
download | FreeBSD-src-8d9b8047a3f4381cb28d8751cef0c3d36b4db86c.zip FreeBSD-src-8d9b8047a3f4381cb28d8751cef0c3d36b4db86c.tar.gz |
- Revise text, and fix typos and grammatical errors.
- Add syscons.4.
If there still are errors, whether technical or grammatical, they are
entirely mine, not the reviewers'.
Reviewed by: sos, jkh, archie, Nick Hilliard <nick@iol.ie>
Diffstat (limited to 'share/man/man4')
-rw-r--r-- | share/man/man4/atkbd.4 | 49 | ||||
-rw-r--r-- | share/man/man4/atkbdc.4 | 26 | ||||
-rw-r--r-- | share/man/man4/man4.i386/atkbd.4 | 49 | ||||
-rw-r--r-- | share/man/man4/man4.i386/atkbdc.4 | 26 | ||||
-rw-r--r-- | share/man/man4/man4.i386/splash.4 | 125 | ||||
-rw-r--r-- | share/man/man4/man4.i386/syscons.4 | 418 | ||||
-rw-r--r-- | share/man/man4/man4.i386/vga.4 | 59 | ||||
-rw-r--r-- | share/man/man4/splash.4 | 125 | ||||
-rw-r--r-- | share/man/man4/syscons.4 | 418 | ||||
-rw-r--r-- | share/man/man4/vga.4 | 59 |
10 files changed, 1116 insertions, 238 deletions
diff --git a/share/man/man4/atkbd.4 b/share/man/man4/atkbd.4 index 01370c4..1c7de44 100644 --- a/share/man/man4/atkbd.4 +++ b/share/man/man4/atkbd.4 @@ -24,10 +24,10 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: $ +.\" $Id: atkbd.4,v 1.1 1999/02/07 05:40:14 yokota Exp $ .\" -.Dd February 6, 1999 -.Dt ATKBD 4 i386 +.Dd February 9, 1999 +.Dt ATKBD 4 .Os FreeBSD .Sh NAME .Nm atkbd @@ -48,35 +48,40 @@ This driver is required for the console drivers and .Xr pcvt 4 . .Pp -There can be only one +There can be only one .Nm -device in the system and the keyboard controller +device defined in the kernel configuration file. This device also +requires the .Nm atkbdc -must be configured in the kernel too. +keyboard controller to be present. +The +.Em irq +number must always be 1; there is no provision of changing the number. .Sh DRIVER CONFIGURATION .\".Ss Kernel Configuration Options .Ss Driver Flags The .Nm -driver accepts the following driver flags. Set them in the -kernel configuration file or in the User Configuration Menu at -the boot time +driver accepts the following driver flags. They can be set either in the +kernel configuration file +.Pq see Xr config 8 , +or else in the User Configuration Menu at boot time .Pq see Xr boot 8 . -.Bl -tag -width MOUSE -.It bit 0 FAIL_IF_NO_KBD +.Bl -tag -width FAIL +.It bit 0 (FAIL_IF_NO_KBD) By default the .Nm driver will install even if a keyboard is not actually connected to the system. -This option makes the driver not install in such situation. -.It bit 1 NO_RESET +This option prevents the driver from being installed in this situation. +.It bit 1 (NO_RESET) When this option is given, the .Nm driver will not reset the keyboard when initializing it. It may be useful for laptop computers whose function keys -have special features and these features are somewhat lost when the +have special functions and these functions are forgotten when the keyboard is reset. -.It bit 2 ALT_SCANCODESET +.It bit 2 (ALT_SCANCODESET) Certain keyboards, such as those on some ThinkPad models, behave like the old XT keyboard and require this option. .El @@ -88,7 +93,10 @@ like the old XT keyboard and require this option. .Sh SEE ALSO .Xr atkbdc 4 , .Xr pcvt 4 , -.Xr psm 4 . +.Xr psm 4 , +.Xr syscons 4 , +.Xr boot 8 , +.Xr config 8 . .Sh HISTORY The .Nm @@ -97,8 +105,9 @@ driver first appeared in .Sh AUTHORS The .Nm -driver is based on keyboard I/O routines in the console driver -code written by -.An Søren Schmidt Aq sos@FreeBSD.org . -This manual page was written by +driver was written by +.An Søren Schmidt Aq sos@FreeBSD.org +and .An Kazutaka Yokota Aq yokota@FreeBSD.org . +This manual page was written by +.An Kazutaka Yokota . diff --git a/share/man/man4/atkbdc.4 b/share/man/man4/atkbdc.4 index b28d503..e288a73 100644 --- a/share/man/man4/atkbdc.4 +++ b/share/man/man4/atkbdc.4 @@ -24,10 +24,10 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: $ +.\" $Id: atkbdc.4,v 1.1 1999/02/07 05:40:14 yokota Exp $ .\" -.Dd February 6, 1999 -.Dt ATKBDC 4 i386 +.Dd February 9, 1999 +.Dt ATKBDC 4 .Os FreeBSD .Sh NAME .Nm atkbdc @@ -46,15 +46,14 @@ pointing devices. This controller is required for the keyboard driver .Nm atkbd and the PS/2 pointing device driver -.Nm psm -to operate. +.Nm psm . .Pp There can be only one .Nm -device in the system. +device configured in the system. .Sh DRIVER CONFIGURATION .Ss Kernel Configuration Options -There are following kernel configuration options to control the +The following kernel configuration options can be used to control the .Nm driver. They may be set in the kernel configuration file @@ -67,13 +66,13 @@ and the pointing device driver .Nm psm may ask the .Nm -driver to reset devices during the boot process. -It sometimes takes a long while before these devices will respond to +driver to reset these devices during the boot process. +It sometimes takes a long time before these devices respond to the reset command. These options control how long the .Nm driver should -wait before it eventually gives up waiting. The driver will wait +wait before eventually giving up -- the driver will wait .Fa X * .Fa Y @@ -87,7 +86,7 @@ for .It Em KBDIO_DEBUG=N Sets the debug level to .Fa N . -The default debug level is zero. +The default value is zero, which suppresses all debugging output. .El .\".Ss Driver Flags .\".Sh FILES @@ -97,7 +96,8 @@ The default debug level is zero. .\".Sh BUGS .Sh SEE ALSO .Xr atkbd 4 , -.Xr psm 4 . +.Xr psm 4 , +.Xr config 8 . .Sh HISTORY The .Nm @@ -106,7 +106,7 @@ driver first appeared in It is based on the kbdio module in .Fx 2.2 . .Sh AUTHORS -The kbdio module and the +The kbdio module, the .Nm driver and this manual page were written by .An Kazutaka Yokota Aq yokota@FreeBSD.org . diff --git a/share/man/man4/man4.i386/atkbd.4 b/share/man/man4/man4.i386/atkbd.4 index 01370c4..1c7de44 100644 --- a/share/man/man4/man4.i386/atkbd.4 +++ b/share/man/man4/man4.i386/atkbd.4 @@ -24,10 +24,10 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: $ +.\" $Id: atkbd.4,v 1.1 1999/02/07 05:40:14 yokota Exp $ .\" -.Dd February 6, 1999 -.Dt ATKBD 4 i386 +.Dd February 9, 1999 +.Dt ATKBD 4 .Os FreeBSD .Sh NAME .Nm atkbd @@ -48,35 +48,40 @@ This driver is required for the console drivers and .Xr pcvt 4 . .Pp -There can be only one +There can be only one .Nm -device in the system and the keyboard controller +device defined in the kernel configuration file. This device also +requires the .Nm atkbdc -must be configured in the kernel too. +keyboard controller to be present. +The +.Em irq +number must always be 1; there is no provision of changing the number. .Sh DRIVER CONFIGURATION .\".Ss Kernel Configuration Options .Ss Driver Flags The .Nm -driver accepts the following driver flags. Set them in the -kernel configuration file or in the User Configuration Menu at -the boot time +driver accepts the following driver flags. They can be set either in the +kernel configuration file +.Pq see Xr config 8 , +or else in the User Configuration Menu at boot time .Pq see Xr boot 8 . -.Bl -tag -width MOUSE -.It bit 0 FAIL_IF_NO_KBD +.Bl -tag -width FAIL +.It bit 0 (FAIL_IF_NO_KBD) By default the .Nm driver will install even if a keyboard is not actually connected to the system. -This option makes the driver not install in such situation. -.It bit 1 NO_RESET +This option prevents the driver from being installed in this situation. +.It bit 1 (NO_RESET) When this option is given, the .Nm driver will not reset the keyboard when initializing it. It may be useful for laptop computers whose function keys -have special features and these features are somewhat lost when the +have special functions and these functions are forgotten when the keyboard is reset. -.It bit 2 ALT_SCANCODESET +.It bit 2 (ALT_SCANCODESET) Certain keyboards, such as those on some ThinkPad models, behave like the old XT keyboard and require this option. .El @@ -88,7 +93,10 @@ like the old XT keyboard and require this option. .Sh SEE ALSO .Xr atkbdc 4 , .Xr pcvt 4 , -.Xr psm 4 . +.Xr psm 4 , +.Xr syscons 4 , +.Xr boot 8 , +.Xr config 8 . .Sh HISTORY The .Nm @@ -97,8 +105,9 @@ driver first appeared in .Sh AUTHORS The .Nm -driver is based on keyboard I/O routines in the console driver -code written by -.An Søren Schmidt Aq sos@FreeBSD.org . -This manual page was written by +driver was written by +.An Søren Schmidt Aq sos@FreeBSD.org +and .An Kazutaka Yokota Aq yokota@FreeBSD.org . +This manual page was written by +.An Kazutaka Yokota . diff --git a/share/man/man4/man4.i386/atkbdc.4 b/share/man/man4/man4.i386/atkbdc.4 index b28d503..e288a73 100644 --- a/share/man/man4/man4.i386/atkbdc.4 +++ b/share/man/man4/man4.i386/atkbdc.4 @@ -24,10 +24,10 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: $ +.\" $Id: atkbdc.4,v 1.1 1999/02/07 05:40:14 yokota Exp $ .\" -.Dd February 6, 1999 -.Dt ATKBDC 4 i386 +.Dd February 9, 1999 +.Dt ATKBDC 4 .Os FreeBSD .Sh NAME .Nm atkbdc @@ -46,15 +46,14 @@ pointing devices. This controller is required for the keyboard driver .Nm atkbd and the PS/2 pointing device driver -.Nm psm -to operate. +.Nm psm . .Pp There can be only one .Nm -device in the system. +device configured in the system. .Sh DRIVER CONFIGURATION .Ss Kernel Configuration Options -There are following kernel configuration options to control the +The following kernel configuration options can be used to control the .Nm driver. They may be set in the kernel configuration file @@ -67,13 +66,13 @@ and the pointing device driver .Nm psm may ask the .Nm -driver to reset devices during the boot process. -It sometimes takes a long while before these devices will respond to +driver to reset these devices during the boot process. +It sometimes takes a long time before these devices respond to the reset command. These options control how long the .Nm driver should -wait before it eventually gives up waiting. The driver will wait +wait before eventually giving up -- the driver will wait .Fa X * .Fa Y @@ -87,7 +86,7 @@ for .It Em KBDIO_DEBUG=N Sets the debug level to .Fa N . -The default debug level is zero. +The default value is zero, which suppresses all debugging output. .El .\".Ss Driver Flags .\".Sh FILES @@ -97,7 +96,8 @@ The default debug level is zero. .\".Sh BUGS .Sh SEE ALSO .Xr atkbd 4 , -.Xr psm 4 . +.Xr psm 4 , +.Xr config 8 . .Sh HISTORY The .Nm @@ -106,7 +106,7 @@ driver first appeared in It is based on the kbdio module in .Fx 2.2 . .Sh AUTHORS -The kbdio module and the +The kbdio module, the .Nm driver and this manual page were written by .An Kazutaka Yokota Aq yokota@FreeBSD.org . diff --git a/share/man/man4/man4.i386/splash.4 b/share/man/man4/man4.i386/splash.4 index 1c9b9a2..1791966 100644 --- a/share/man/man4/man4.i386/splash.4 +++ b/share/man/man4/man4.i386/splash.4 @@ -24,9 +24,9 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: $ +.\" $Id: splash.4,v 1.1 1999/02/07 05:40:14 yokota Exp $ .\" -.Dd February 6, 1999 +.Dd February 9, 1999 .Dt SPLASH 4 i386 .Os FreeBSD .Sh NAME @@ -44,80 +44,78 @@ This driver is required if the splash bitmap image is to be loaded or any screen saver is to be used. .Sh SPLASH SCREEN You can load and display an arbitrary bitmap image file as welcome banner -on the screen when the system is about to start. -It stays on the screen while the system is being initialized, -and goes away when you hit any key (this may not work -immediately if the kernel is still probing devices), -when a screen saver is loaded and initialized, -or when the "Login" prompt first appears on the screen. +on the screen when the system is about to start. This image will remain on +the screen during kernel initialization process until the ``Login'' prompt +appears on the screen or until a screen saver is loaded and initialized. +The image will also disappear if you hit any key, although this may not work +immediately if the kernel is still probing devices. .Pp If you specify .Fl c or .Fl v -boot option when loading kernel, the splash image won't appear -(though is still loaded and can be used as a screen saver later; see below). +boot option when loading kernel, the splash image will not appear. However, it +is still loaded and can be used as a screen saver later: see below. .Pp -In order to display the bitmap, the bitmap file itself and -matching splash image decoder must be loaded by the boot loader. +In order to display the bitmap, the bitmap file itself and the +matching splash image decoder module must be loaded by the boot loader. Currently the following decoder module is available: .Pp -.Bl -tag -width splash -compact -.It splash_bmp.ko +.Bl -tag -width splash_decoder -compact +.It Pa splash_bmp.ko W*ndows BMP file decoder. -While the BMP file format allows various depth of colors, this decoder -can only handle 256 color bitmaps. -Other color depth won't work. +While the BMP file format allows images of various color depths, this +decoder currently only handles 256 color bitmaps. Bitmaps of other color +depths will not be displayed. .El .Pp The .Sx EXAMPLES section illustrates how to set up the splash screen. .Pp -The size of the bitmap must be 320x200 or less, -if the standard VGA video mode is used. +If the standard VGA video mode is used, +the size of the bitmap must be 320x200 or less. If you enable the VESA mode support in the kernel, either by statically linking the VESA module or by loading the VESA module .Pq see Xr vga 4 , -you can load as large bitmap as 1024x768, depending on the VESA BIOS -and the amount of video memory on the video card. +you can load bitmaps up to a resolution of 1024x768, depending on the VESA +BIOS and the amount of video memory on the video card. .Sh SCREEN SAVER -The screen saver will pop up -when the system is considered "idle", that is, the user has not typed -a key or moved the mouse, for the specified duration. -As the screen saver is an optional module, it must be explicitly loaded -to the memory. -Currently the following screen saver modules are available: -.Pp -.Bl -tag -width splash -compact -.It blank_saver.ko +The screen saver will activate when the system is considered idle: i.e. +when the user has not typed a key or moved the mouse for a specified period +of time. As the screen saver is an optional module, it must be explicitly +loaded into memory. Currently the following screen saver modules are +available: +.Pp +.Bl -tag -width splash_module.ko -compact +.It Pa blank_saver.ko This screen saver simply blanks the screen. -.It daemon_saver.ko +.It Pa daemon_saver.ko Animated BSD Daemon screen saver. -.It fade_saver.ko +.It Pa fade_saver.ko The screen will gradually fade away. -.It green_saver.ko +.It Pa green_saver.ko If the monitor supports power saving mode, it will be turned off. -.It logo_saver.ko +.It Pa logo_saver.ko Animated graphical BSD Daemon. -.It rain_saver.ko +.It Pa rain_saver.ko Draws shower on the screen. -.It snake_saver.ko +.It Pa snake_saver.ko Draws a snake of string. -.It star_saver.ko +.It Pa star_saver.ko Twinkling stars. -.It warp_saver.ko +.It Pa warp_saver.ko Streaking stars. .El .Pp -Load a screen saver module via -.Xr kldload 1 . +Screen saver modules can be loaded using +.Xr kldload 1 : .Pp .Dl kldload logo_saver .Pp -Then specify timeout value, in seconds, as follows: +The timeout value in seconds can be specified as follows: .Pp -.Dl vidcontrol -t timeout +.Dl vidcontrol -t N .Pp Alternatively, you can set the .Ar saver @@ -131,28 +129,25 @@ and the timeout value is set when the system starts. .Pp The screen saver may be instantly activated by hitting the .Ar saver -key (Shift-Pause on the AT enhanced keyboard, Shift-Ctrl-NumLock/Pause -on the AT 84 keyboard by default). -You can change the +key: the defaults are +.Em Shift-Pause + on the AT enhanced keyboard and +.Em Shift-Ctrl-NumLock/Pause +on the AT 84 keyboard. You can change the .Ar saver -key by modifying the keymap. -See -.Xr kbdcontrol 1 -and -.Xr keymap 5 , +key by modifying the keymap +.Pq see Xr kbdcontrol 1 , Xr keymap 5 , and assign the .Ar saver function to a key of your preference. .Pp -The screen saver won't run if the current screen is not in the -text mode. +The screen saver will not run if the screen is not in text mode. .Sh SPLASH SCREEN AS A SCREEN SAVER -If you load a splash image but don't load a screen saver, +If you load a splash image but do not load a screen saver, you can continue using the splash module as a screen saver. -Specify the screen blanking interval as explained in the +The screen blanking interval can be specified as described in the .Sx SCREEN SAVER -section above, and -the splash screen image will come back after the specified time. +section above. .\".Sh DRIVER CONFIGURATION .Sh FILES .Bl -tag -width /modules/splash_xxxx.ko -compact @@ -168,6 +163,11 @@ screen saver modules the VESA support module .El .Sh EXAMPLE +In order to load the splash screen or the screen saver, you must +have the following line in the kernel configuration file. +.Pp +.Dl pseudo-device splash +.Pp The following examples show how to load the splash screen image from the boot loader prompt. They may be typed by hand at the loader prompt or may be written in @@ -193,7 +193,7 @@ The third line loads the splash image decoder module .Pp In the following example, the VESA module is loaded so that a bitmap file which cannot be displayed in standard -VGA modes may be shown using one of VESA video modes. +VGA modes may be shown using one of the VESA video modes. .Bd -literal -offset indent load kernel load vesa @@ -213,10 +213,11 @@ only. They are not available for the alternative console driver .Xr pcvt 4 . .Sh BUGS If you load a screen saver while another screen saver has already -been loaded, the first screen saver won't be automatically unloaded -and remain in memory, wasting kernel memory space. +been loaded, the first screen saver will not be automatically unloaded +and will remain in memory, wasting kernel memory space. .Sh SEE ALSO .Xr vidcontrol 1 , +.Xr syscons 4 , .Xr vga 4 , .Xr rc.conf 5 , .Xr kldload 8 , @@ -231,3 +232,9 @@ The .Nm driver and this manual page were written by .An Kazutaka Yokota Aq yokota@FreeBSD.org . +The +.Pa splash_bmp +module was written by +.An Michael Smith Aq msmith@FreeBSD.org +and +.An Kazutaka Yokota . diff --git a/share/man/man4/man4.i386/syscons.4 b/share/man/man4/man4.i386/syscons.4 new file mode 100644 index 0000000..691737a --- /dev/null +++ b/share/man/man4/man4.i386/syscons.4 @@ -0,0 +1,418 @@ +.\" +.\" Copyright (c) 1999 +.\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer as +.\" the first lines of this file unmodified. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $Id: $ +.\" +.Dd February 9, 1999 +.Dt SYSCONS 4 +.Os FreeBSD +.Sh NAME +.Nm syscons , +.Nm sc +.Nd +the console driver +.Sh SYNOPSIS +.Cd "options" \&"MAXCONS=N\&" +.\".Cd "options" \&"SC_ALT_MOUSE_IMAGE\&" +.Cd "options" \&"SC_DISABLE_REBOOT\&" +.Cd "options" \&"SC_HISTORY_SIZE=N\&" +.Cd "options" \&"SC_MOUSE_CHAR=C\&" +.\".Cd "options" \&"SC_NO_CUTPASTE\&" +.\".Cd "options" \&"SC_NO_FONT_LOADING\&" +.\".Cd "options" \&"SC_NO_HISTORY\&" +.\".Cd "options" \&"SC_NO_SYSMOUSE\&" +.\".Cd "options" \&"SC_PIXEL_MODE\&" +.Cd "options" \&"STD8X16FONT\&" +.Cd "makeoptions" \&"STD8X16FONT\&"=\&"_font_name_\&" +.Cd "device sc0 at isa? tty" +.Sh DESCRIPTION +The +.Nm +driver provides multiple virtual terminals. +It resembles the SCO color console driver. +.Pp +The +.Nm +driver is implemented on top of the keyboard driver +.Pq Xr atkbd 4 +and the video card driver +.Pq Xr vga 4 +and so requires both of them to be configured in the system. +.Pp +There can be only one +.Nm +device defined in the system. +.Ss Virtual Terminals +The +.Nm +driver provides multiple virtual terminals which appear as if they were +separate terminals. +One virtual terminal is considered current and exclusively +occupies the screen and the keyboard; the other virtual terminals +are placed in the background. +.Pp +In order to use virtual terminals, they must be individually +marked ``on'' in +.Pa /etc/ttys +so that +.Xr getty 8 +will recognize them to be active and run +.Xr login 1 +to let the user to login to the system. +By default, only the first three virtual terminals are activated in +.Pa /etc/ttys . +.Pp +You press the +.Em Alt +key and a switch key to switch between +virtual terminals. +The following table summarizes the correspondence between the switch +key and the virtual terminal. +.Bd -literal -offset indent +Alt-F1 ttyv0 Alt-F7 ttyv6 Shift-Alt-F1 ttyv10 +Alt-F2 ttyv1 Alt-F8 ttyv7 Shift-Alt-F2 ttyv11 +Alt-F3 ttyv2 Alt-F9 ttyv8 Shift-Alt-F3 ttyv12 +Alt-F4 ttyv3 Alt-F10 ttyv9 Shift-Alt-F4 ttyv13 +Alt-F5 ttyv4 Alt-F11 ttyv10 Shift-Alt-F5 ttyv14 +Alt-F6 ttyv5 Alt-F12 ttyv11 Shift-Alt-F6 ttyv15 +.Ed +.Pp +You can also use the ``nscr'' key (usually the +.Em PrintScreen +key on the AT Enhanced keyboard) to cycle available virtual terminals. +.Pp +The default number of available virtual terminals is 16. +This can be changed by the kernel configuration option +.Em MAXCONS +(see below). +.Pp +Note that the X server usually requires a virtual terminal for display +purposes, so at least one terminal must be left unused by +.Xr getty 8 +so that it can be used by the X server. +.Ss Key Definitions and Function Key Strings +The +.Nm +driver, in conjunction with the keyboard driver, allows the user +to change key definitions and function key strings. +The +.Xr kbdcontrol 1 +command will load a key definition file (known as ``keymap'' file), +dump the current keymap, and assign a string to a function key. +See +.Xr keyboard 4 +and +.Xr keymap 5 +for the keymap file. +.Pp +You may want to set the +.Ar keymap +variable in +.Pa /etc/rc.conf +to the desired keymap file so that it will be automatically loaded +when the system starts up. +.Ss Software Font +For most modern video cards, e.g. VGA, the +.Nm +driver and the video card driver allow the user to change +the font used on the screen. +The +.Xr vidcontrol 1 +command can be used to load a font file from +.Pa /usr/share/syscons/fonts . +.Pp +The font comes in various sizes: 8x8, 8x14 and 8x16. +The 8x16 font is typically used for the VGA card in the 80-column- +by-25-line mode. +Other video modes may require different size of font. +It is better to always load these three sizes of the same font. +.Pp +You may set +.Ar font8x8 , +.Ar font8x14 +and +.Ar font8x16 +variables in +.Pa /etc/rc.conf +to the desired font files so that they will be automatically loaded +when the system starts up. +.Pp +Optionally you can make a particular font file as the default 8x16 font. +See the +.Em STD8X16FONT +option below. +.Ss Screen Map +If your video card does not support software font, you may still be able +to have similar effect by re-mapping font hard-wired in the video card. +Use +.Xr vidcontrol 1 +to load a screen map file which defines mapping between character codes. +.Ss Mouse Support and Copy-and-Paste +You can use your mouse to copy text on the screen and paste it as if +it is typed by hand. +You must be running the mouse daemon +.Xr moused 8 +and enable the mouse cursor in the virtual terminal via +.Xr vidcontrol 1 . +.Pp +Pressing the mouse button 1 (usually the left button) will start selection. +Releasing the button 1 will end the selection process. +The selected text will be marked by inverting foreground and +background colors. +You can press the button 3 (usually the right button) to extend +the selected region. +The selected text is placed in the copy buffer and can be pasted +at the cursor position by your pressing the button 2 (usually the +middle button) as many times as you like. +.Ss Back Scrolling +The +.Nm +driver allows the user to browse the output which has ``scrolled off'' +from the top of the screen. +.Pp +Press the ``slock'' key (usually +.Em ScrllLock +and/or +.Em Pause +keys on many AT Enhanced keyboards) and the terminal is +in the ``back scrolling'' mode. +It is indicated by the +.Em Scroll Lock +LED. +Use arrow keys, +.Em Page Up/Down +keys and +.Em Home/End +keys to scroll buffered terminal output. +Press the ``slock'' key again to get back to the normal terminal mode. +.Pp +The size of the back-scroll buffer can be set by the +.Em SC_HISTORY_SIZE +option below. +.Ss Screen Saver +The +.Nm +driver can be made to put up the screen saver if the current +virtual terminal is idle, that is, the user is not typing +on the keyboard nor moving mouse. +See +.Xr splash 4 +and +.Xr vidcontrol 1 +for more details. +.Sh DRIVER CONFIGURATION +.Ss Kernel Configuration Options +The following kernel configuration options control the +.Nm +driver. +.Bl -tag -width MOUSE +.It Em MAXCONS=N +This option sets the number of virtual terminals to +.Fa N . +The default value is 16. +.\".It Em SC_ALT_MOUSE_IMAGE +.\"This option selects the alternative way of displaying the mouse cursor +.\"in the virtual terminal. +.\"It may be vastly costly for some video cards to draw the arrow-shaped +.\"cursor and you may want to try this option. +.\"However, the appearance of the alternative mouse cursor may not be +.\"very appealing. +.It Em SC_DISABLE_REBOOT +This option disables the ``reboot'' key (by default, it is +.Em Ctl-Alt-Del ), +so that the casual user may not accidentally reboot the system. +.It Em SC_HISTORY_SIZE=N +Sets the size of back scroll buffer to +.Fa N +lines. +The default value is 100. +.It Em SC_MOUSE_CHAR=C +.\"Unless the +.\".Em SC_ALT_MOUSE_IMAGE +.\"option above is specified, the +The +.Nm +driver reserves four consecutive character codes in order to display the +mouse cursor in the virtual terminals in some systems. +This option specifies the first character code to +.Fa C +to be used for this purpose. +The default value is 0xd0. +A good candidate is 0x03. +.\".It Em SC_PIXEL_MODE +.It Em STD8X16FONT +This option will specify the default 8x16 font. +Without this option, the +.Nm +driver will use whatever font already loaded in the video card, +unless you explicitly load software font at startup. +See +.Sx EXAMPLE +below. +.El +.\".Pp +.\"The following options will remove some features from the +.\".Nm +.\"driver and save kernel memory. +.\".Bl -tag -width MOUSE +.\".It Em SC_NO_CUTPASTE +.\"This option disables ``copy and paste'' operation in virtual +.\"terminals. +.\".It Em SC_NO_FONT_LOADING +.\"The +.\".Nm +.\"driver can load software font on some video cards. +.\"This option removes this feature. +.\".It Em SC_NO_HISTORY +.\"This option disables back-scrolling in virtual terminals. +.\".It Em SC_NO_SYSMOUSE +.\"This option removes mouse support in the +.\".Nm +.\"driver. +.\"The mouse daemon +.\".Xr moused 8 +.\"will fail if this option is defined. +.\"This option implies the +.\".Em SC_NO_CUTPASTE +.\"option too. +.\".El +.Ss Driver Flags +The following driver flags can be used to control the +.Nm +driver. +They can be set either in the kernel configuration file +.Pq see Xr config 8 , +or else in the User Configuration Menu at boot +time +.Pq see Xr boot 8 . +.Bl -tag -width bit_0 +.It bit 0 (VISUAL_BELL) +Uses the ``visual'' bell. +The screen will blink instead of generating audible sound. +.It bit 1,2 (CURSOR_TYPE) +This option specifies the cursor appearance. +Possible values are: +.Bl -tag -width TYPE -compact +.It Em 0 +normal block cursor +.It Em 2 +blinking block cursor +.It Em 4 +underline cursor +.It Em 6 +blinking underline (aka destructive) cursor +.El +.It bit 6 (QUIET_BELL) +This option suppresses the bell, whether audible or visual, +if it is rung in a background virtual terminal. +.It bit 7 (VESA800X600) +This option puts the video card in the VESA 800x600 dots, 16 color +mode. +It may be useful for laptop computers for which the 800x600 mode +is otherwise unsupported by the X server. +Note that the ``copy-and-paste'' function is not currently supported in +this mode and the mouse pointer will not be displayed. +.El +.Sh FILES +.Bl -tag -width /usr/share/syscons/xxxxyyyyzzz -compact +.It Pa /dev/console +.It Pa /dev/consolectl +.It Pa /dev/ttyv? +virtual terminals +.It Pa /etc/ttys +terminal initialization information +.It Pa /usr/share/syscons/fonts/* +font files +.It Pa /usr/share/syscons/keymaps/* +key map files +.It Pa /usr/share/syscons/scrmaps/* +screen map files +.El +.Sh EXAMPLE +As the +.Nm +driver requires the keyboard driver and the video card driver, +the kernel configuration file should contain the following lines. +.Pp +.Bd -literal -offset indent +device atkbdc0 at isa? port IO_KBD tty +device atkbd0 at isa? tty irq 1 +device vga0 at isa? conflicts +device sc0 at isa? tty + +pseudo-device splash +.Ed +.Pp +If you do not intend to load the splash image or use the screen saver, +the last line is not necessary, and can be omitted. +.Pp +Note that the keyboard controller driver +.Nm atkbdc +is required by the keyboard driver +.Nm atkbd . +.Pp +The following example adds the font file +.Pa /usr/share/syscons/fonts/cp850-8x16.fnt +to the kernel as the default 8x16 font. +.Pp +.Dl "options" \&"STD8X16FONT\&" +.Dl "makeoptions" \&"STD8X16FONT\&"=\&"cp850\&" +.Dl "device sc0 at isa? tty" +.Pp +.\".Sh DIAGNOSTICS +.\".Sh CAVEATS +.Sh BUGS +This manual page is incomplete and urgently needs revision. +.Sh SEE ALSO +.Xr kbdcontrol 1 , +.Xr kldload 1 , +.Xr login 1 , +.Xr vidcontrol 1 , +.Xr atkbd 4 , +.Xr atkbdc 4 , +.Xr keyboard 4 , +.Xr screen 4 , +.Xr splash 4 , +.Xr vga 4 , +.Xr keymap 5 , +.Xr rc.conf 5 , +.Xr screenmap 5 , +.Xr ttys 5 , +.Xr config 8 , +.Xr getty 8 , +.Xr moused 8 . +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 1.0 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Søren Schmidt Aq sos@FreeBSD.org . +This manual page was written by +.An Kazutaka Yokota Aq yokota@FreeBSD.org . diff --git a/share/man/man4/man4.i386/vga.4 b/share/man/man4/man4.i386/vga.4 index a2d30c2..a14ff5d 100644 --- a/share/man/man4/man4.i386/vga.4 +++ b/share/man/man4/man4.i386/vga.4 @@ -24,10 +24,10 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: $ +.\" $Id: vga.4,v 1.1 1999/02/07 05:40:14 yokota Exp $ .\" -.Dd February 6, 1999 -.Dt VGA 4 i386 +.Dd February 9, 1999 +.Dt VGA 4 .Os FreeBSD .Sh NAME .Nm vga @@ -52,41 +52,43 @@ The console driver will call the .Nm driver to manipulate video hardware (changing video modes, loading font, etc). .Pp +The keyword +.Em conflicts +is required, as the video card may use I/O ports in the same range +as other drivers. +.Pp The .Nm -driver supports the standard video cards: MDA, CGA, EGA and VGA. -In addition, the driver can utilize the VESA BIOS extension, -if the video card has one. -VESA support can either be statically included in the kernel or -available as a separate module. +driver supports the standard video cards: MDA, CGA, EGA and VGA. In +addition, the driver can utilize VESA BIOS extensions if the video card +supports them. VESA support can either be statically included in the kernel +or can be loaded as a separate module. .Pp -In order to statically link the support to the kernel, define the +In order to statically link the support to the kernel, the .Em VESA option (see below) and the .Em VM86 -option in the kernel configuration file. +option must be defined in the kernel configuration file. .Pp The .Nm vesa -module can be loaded to the kernel, without static VESA support, by +module can be dynamically loaded into the kernel using .Xr kldload 8 . -The +This requires the .Em VM86 -option is required in the kernel configuration file in this case too. +option to be defined in the kernel configuration file. .Sh DRIVER CONFIGURATION .Ss Kernel Configuration Options -The following kernel configuration options control the +The following kernel configuration options +.Pq see Xr config 8 +can be used to control the .Nm driver. -They may be set in the kernel configuration file -.Pq see Xr config 8 . -.Pp -The following options are to provide compatibility with certain VGA -cards. +These options provide compatibility with certain VGA cards. .Bl -tag -width MOUSE .It Em VGA_ALT_SEQACCESS You may want to try this option if the mouse pointer is not drawn correctly -or font does not seem to be loaded properly on the VGA card. +or the font does not seem to be loaded properly on the VGA card. However, it may cause flicker on some systems. .It Em VGA_SLOW_IOACCESS Older VGA cards may require this option for proper operation. @@ -105,8 +107,9 @@ This option requires the .Em VM86 option. .It Em VESA_DEBUG=N -Set the VESA support debug level to N. -The default value is zero (all debugging output is suppressed). +Set the VESA support debug level to +.Fa N . +The default value is zero, which suppresses all debugging output. .El .Pp The following options will remove some features from the @@ -119,7 +122,7 @@ The driver can load software font to EGA and VGA cards. This option removes this feature. .It Em VGA_NO_MODE_CHANGE -This option disallows the driver to change video modes. +This option prevents the driver from changing video modes. .El .\".Sh FILES .Sh EXAMPLE @@ -134,16 +137,16 @@ in order to enable the VESA BIOS Extension support. .Dl "options" \&"VESA\&" .Dl "device vga0 at isa? port ? conflicts" .Pp -If you do not want the VESA support always included in the kernel, but +If you do not want VESA support included in the kernel, but want to use occasionally, add the following lines to the kernel configuration -file. +file: .Pp .Dl "options" \&"VM86\&" .Dl "device vga0 at isa? port ? conflicts" .Pp -And load the +Then load the .Nm vesa -module, when desired, as follows. +module as desired: .Pp .Dl kldload vesa .Pp @@ -151,6 +154,8 @@ module, when desired, as follows. .\".Sh CAVEATS .\".Sh BUGS .Sh SEE ALSO +.Xr syscons 4 , +.Xr config 8 , .Xr kldload 8 , .Xr kldunload 8 . .Sh STANDARD diff --git a/share/man/man4/splash.4 b/share/man/man4/splash.4 index 1c9b9a2..1791966 100644 --- a/share/man/man4/splash.4 +++ b/share/man/man4/splash.4 @@ -24,9 +24,9 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: $ +.\" $Id: splash.4,v 1.1 1999/02/07 05:40:14 yokota Exp $ .\" -.Dd February 6, 1999 +.Dd February 9, 1999 .Dt SPLASH 4 i386 .Os FreeBSD .Sh NAME @@ -44,80 +44,78 @@ This driver is required if the splash bitmap image is to be loaded or any screen saver is to be used. .Sh SPLASH SCREEN You can load and display an arbitrary bitmap image file as welcome banner -on the screen when the system is about to start. -It stays on the screen while the system is being initialized, -and goes away when you hit any key (this may not work -immediately if the kernel is still probing devices), -when a screen saver is loaded and initialized, -or when the "Login" prompt first appears on the screen. +on the screen when the system is about to start. This image will remain on +the screen during kernel initialization process until the ``Login'' prompt +appears on the screen or until a screen saver is loaded and initialized. +The image will also disappear if you hit any key, although this may not work +immediately if the kernel is still probing devices. .Pp If you specify .Fl c or .Fl v -boot option when loading kernel, the splash image won't appear -(though is still loaded and can be used as a screen saver later; see below). +boot option when loading kernel, the splash image will not appear. However, it +is still loaded and can be used as a screen saver later: see below. .Pp -In order to display the bitmap, the bitmap file itself and -matching splash image decoder must be loaded by the boot loader. +In order to display the bitmap, the bitmap file itself and the +matching splash image decoder module must be loaded by the boot loader. Currently the following decoder module is available: .Pp -.Bl -tag -width splash -compact -.It splash_bmp.ko +.Bl -tag -width splash_decoder -compact +.It Pa splash_bmp.ko W*ndows BMP file decoder. -While the BMP file format allows various depth of colors, this decoder -can only handle 256 color bitmaps. -Other color depth won't work. +While the BMP file format allows images of various color depths, this +decoder currently only handles 256 color bitmaps. Bitmaps of other color +depths will not be displayed. .El .Pp The .Sx EXAMPLES section illustrates how to set up the splash screen. .Pp -The size of the bitmap must be 320x200 or less, -if the standard VGA video mode is used. +If the standard VGA video mode is used, +the size of the bitmap must be 320x200 or less. If you enable the VESA mode support in the kernel, either by statically linking the VESA module or by loading the VESA module .Pq see Xr vga 4 , -you can load as large bitmap as 1024x768, depending on the VESA BIOS -and the amount of video memory on the video card. +you can load bitmaps up to a resolution of 1024x768, depending on the VESA +BIOS and the amount of video memory on the video card. .Sh SCREEN SAVER -The screen saver will pop up -when the system is considered "idle", that is, the user has not typed -a key or moved the mouse, for the specified duration. -As the screen saver is an optional module, it must be explicitly loaded -to the memory. -Currently the following screen saver modules are available: -.Pp -.Bl -tag -width splash -compact -.It blank_saver.ko +The screen saver will activate when the system is considered idle: i.e. +when the user has not typed a key or moved the mouse for a specified period +of time. As the screen saver is an optional module, it must be explicitly +loaded into memory. Currently the following screen saver modules are +available: +.Pp +.Bl -tag -width splash_module.ko -compact +.It Pa blank_saver.ko This screen saver simply blanks the screen. -.It daemon_saver.ko +.It Pa daemon_saver.ko Animated BSD Daemon screen saver. -.It fade_saver.ko +.It Pa fade_saver.ko The screen will gradually fade away. -.It green_saver.ko +.It Pa green_saver.ko If the monitor supports power saving mode, it will be turned off. -.It logo_saver.ko +.It Pa logo_saver.ko Animated graphical BSD Daemon. -.It rain_saver.ko +.It Pa rain_saver.ko Draws shower on the screen. -.It snake_saver.ko +.It Pa snake_saver.ko Draws a snake of string. -.It star_saver.ko +.It Pa star_saver.ko Twinkling stars. -.It warp_saver.ko +.It Pa warp_saver.ko Streaking stars. .El .Pp -Load a screen saver module via -.Xr kldload 1 . +Screen saver modules can be loaded using +.Xr kldload 1 : .Pp .Dl kldload logo_saver .Pp -Then specify timeout value, in seconds, as follows: +The timeout value in seconds can be specified as follows: .Pp -.Dl vidcontrol -t timeout +.Dl vidcontrol -t N .Pp Alternatively, you can set the .Ar saver @@ -131,28 +129,25 @@ and the timeout value is set when the system starts. .Pp The screen saver may be instantly activated by hitting the .Ar saver -key (Shift-Pause on the AT enhanced keyboard, Shift-Ctrl-NumLock/Pause -on the AT 84 keyboard by default). -You can change the +key: the defaults are +.Em Shift-Pause + on the AT enhanced keyboard and +.Em Shift-Ctrl-NumLock/Pause +on the AT 84 keyboard. You can change the .Ar saver -key by modifying the keymap. -See -.Xr kbdcontrol 1 -and -.Xr keymap 5 , +key by modifying the keymap +.Pq see Xr kbdcontrol 1 , Xr keymap 5 , and assign the .Ar saver function to a key of your preference. .Pp -The screen saver won't run if the current screen is not in the -text mode. +The screen saver will not run if the screen is not in text mode. .Sh SPLASH SCREEN AS A SCREEN SAVER -If you load a splash image but don't load a screen saver, +If you load a splash image but do not load a screen saver, you can continue using the splash module as a screen saver. -Specify the screen blanking interval as explained in the +The screen blanking interval can be specified as described in the .Sx SCREEN SAVER -section above, and -the splash screen image will come back after the specified time. +section above. .\".Sh DRIVER CONFIGURATION .Sh FILES .Bl -tag -width /modules/splash_xxxx.ko -compact @@ -168,6 +163,11 @@ screen saver modules the VESA support module .El .Sh EXAMPLE +In order to load the splash screen or the screen saver, you must +have the following line in the kernel configuration file. +.Pp +.Dl pseudo-device splash +.Pp The following examples show how to load the splash screen image from the boot loader prompt. They may be typed by hand at the loader prompt or may be written in @@ -193,7 +193,7 @@ The third line loads the splash image decoder module .Pp In the following example, the VESA module is loaded so that a bitmap file which cannot be displayed in standard -VGA modes may be shown using one of VESA video modes. +VGA modes may be shown using one of the VESA video modes. .Bd -literal -offset indent load kernel load vesa @@ -213,10 +213,11 @@ only. They are not available for the alternative console driver .Xr pcvt 4 . .Sh BUGS If you load a screen saver while another screen saver has already -been loaded, the first screen saver won't be automatically unloaded -and remain in memory, wasting kernel memory space. +been loaded, the first screen saver will not be automatically unloaded +and will remain in memory, wasting kernel memory space. .Sh SEE ALSO .Xr vidcontrol 1 , +.Xr syscons 4 , .Xr vga 4 , .Xr rc.conf 5 , .Xr kldload 8 , @@ -231,3 +232,9 @@ The .Nm driver and this manual page were written by .An Kazutaka Yokota Aq yokota@FreeBSD.org . +The +.Pa splash_bmp +module was written by +.An Michael Smith Aq msmith@FreeBSD.org +and +.An Kazutaka Yokota . diff --git a/share/man/man4/syscons.4 b/share/man/man4/syscons.4 new file mode 100644 index 0000000..691737a --- /dev/null +++ b/share/man/man4/syscons.4 @@ -0,0 +1,418 @@ +.\" +.\" Copyright (c) 1999 +.\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer as +.\" the first lines of this file unmodified. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $Id: $ +.\" +.Dd February 9, 1999 +.Dt SYSCONS 4 +.Os FreeBSD +.Sh NAME +.Nm syscons , +.Nm sc +.Nd +the console driver +.Sh SYNOPSIS +.Cd "options" \&"MAXCONS=N\&" +.\".Cd "options" \&"SC_ALT_MOUSE_IMAGE\&" +.Cd "options" \&"SC_DISABLE_REBOOT\&" +.Cd "options" \&"SC_HISTORY_SIZE=N\&" +.Cd "options" \&"SC_MOUSE_CHAR=C\&" +.\".Cd "options" \&"SC_NO_CUTPASTE\&" +.\".Cd "options" \&"SC_NO_FONT_LOADING\&" +.\".Cd "options" \&"SC_NO_HISTORY\&" +.\".Cd "options" \&"SC_NO_SYSMOUSE\&" +.\".Cd "options" \&"SC_PIXEL_MODE\&" +.Cd "options" \&"STD8X16FONT\&" +.Cd "makeoptions" \&"STD8X16FONT\&"=\&"_font_name_\&" +.Cd "device sc0 at isa? tty" +.Sh DESCRIPTION +The +.Nm +driver provides multiple virtual terminals. +It resembles the SCO color console driver. +.Pp +The +.Nm +driver is implemented on top of the keyboard driver +.Pq Xr atkbd 4 +and the video card driver +.Pq Xr vga 4 +and so requires both of them to be configured in the system. +.Pp +There can be only one +.Nm +device defined in the system. +.Ss Virtual Terminals +The +.Nm +driver provides multiple virtual terminals which appear as if they were +separate terminals. +One virtual terminal is considered current and exclusively +occupies the screen and the keyboard; the other virtual terminals +are placed in the background. +.Pp +In order to use virtual terminals, they must be individually +marked ``on'' in +.Pa /etc/ttys +so that +.Xr getty 8 +will recognize them to be active and run +.Xr login 1 +to let the user to login to the system. +By default, only the first three virtual terminals are activated in +.Pa /etc/ttys . +.Pp +You press the +.Em Alt +key and a switch key to switch between +virtual terminals. +The following table summarizes the correspondence between the switch +key and the virtual terminal. +.Bd -literal -offset indent +Alt-F1 ttyv0 Alt-F7 ttyv6 Shift-Alt-F1 ttyv10 +Alt-F2 ttyv1 Alt-F8 ttyv7 Shift-Alt-F2 ttyv11 +Alt-F3 ttyv2 Alt-F9 ttyv8 Shift-Alt-F3 ttyv12 +Alt-F4 ttyv3 Alt-F10 ttyv9 Shift-Alt-F4 ttyv13 +Alt-F5 ttyv4 Alt-F11 ttyv10 Shift-Alt-F5 ttyv14 +Alt-F6 ttyv5 Alt-F12 ttyv11 Shift-Alt-F6 ttyv15 +.Ed +.Pp +You can also use the ``nscr'' key (usually the +.Em PrintScreen +key on the AT Enhanced keyboard) to cycle available virtual terminals. +.Pp +The default number of available virtual terminals is 16. +This can be changed by the kernel configuration option +.Em MAXCONS +(see below). +.Pp +Note that the X server usually requires a virtual terminal for display +purposes, so at least one terminal must be left unused by +.Xr getty 8 +so that it can be used by the X server. +.Ss Key Definitions and Function Key Strings +The +.Nm +driver, in conjunction with the keyboard driver, allows the user +to change key definitions and function key strings. +The +.Xr kbdcontrol 1 +command will load a key definition file (known as ``keymap'' file), +dump the current keymap, and assign a string to a function key. +See +.Xr keyboard 4 +and +.Xr keymap 5 +for the keymap file. +.Pp +You may want to set the +.Ar keymap +variable in +.Pa /etc/rc.conf +to the desired keymap file so that it will be automatically loaded +when the system starts up. +.Ss Software Font +For most modern video cards, e.g. VGA, the +.Nm +driver and the video card driver allow the user to change +the font used on the screen. +The +.Xr vidcontrol 1 +command can be used to load a font file from +.Pa /usr/share/syscons/fonts . +.Pp +The font comes in various sizes: 8x8, 8x14 and 8x16. +The 8x16 font is typically used for the VGA card in the 80-column- +by-25-line mode. +Other video modes may require different size of font. +It is better to always load these three sizes of the same font. +.Pp +You may set +.Ar font8x8 , +.Ar font8x14 +and +.Ar font8x16 +variables in +.Pa /etc/rc.conf +to the desired font files so that they will be automatically loaded +when the system starts up. +.Pp +Optionally you can make a particular font file as the default 8x16 font. +See the +.Em STD8X16FONT +option below. +.Ss Screen Map +If your video card does not support software font, you may still be able +to have similar effect by re-mapping font hard-wired in the video card. +Use +.Xr vidcontrol 1 +to load a screen map file which defines mapping between character codes. +.Ss Mouse Support and Copy-and-Paste +You can use your mouse to copy text on the screen and paste it as if +it is typed by hand. +You must be running the mouse daemon +.Xr moused 8 +and enable the mouse cursor in the virtual terminal via +.Xr vidcontrol 1 . +.Pp +Pressing the mouse button 1 (usually the left button) will start selection. +Releasing the button 1 will end the selection process. +The selected text will be marked by inverting foreground and +background colors. +You can press the button 3 (usually the right button) to extend +the selected region. +The selected text is placed in the copy buffer and can be pasted +at the cursor position by your pressing the button 2 (usually the +middle button) as many times as you like. +.Ss Back Scrolling +The +.Nm +driver allows the user to browse the output which has ``scrolled off'' +from the top of the screen. +.Pp +Press the ``slock'' key (usually +.Em ScrllLock +and/or +.Em Pause +keys on many AT Enhanced keyboards) and the terminal is +in the ``back scrolling'' mode. +It is indicated by the +.Em Scroll Lock +LED. +Use arrow keys, +.Em Page Up/Down +keys and +.Em Home/End +keys to scroll buffered terminal output. +Press the ``slock'' key again to get back to the normal terminal mode. +.Pp +The size of the back-scroll buffer can be set by the +.Em SC_HISTORY_SIZE +option below. +.Ss Screen Saver +The +.Nm +driver can be made to put up the screen saver if the current +virtual terminal is idle, that is, the user is not typing +on the keyboard nor moving mouse. +See +.Xr splash 4 +and +.Xr vidcontrol 1 +for more details. +.Sh DRIVER CONFIGURATION +.Ss Kernel Configuration Options +The following kernel configuration options control the +.Nm +driver. +.Bl -tag -width MOUSE +.It Em MAXCONS=N +This option sets the number of virtual terminals to +.Fa N . +The default value is 16. +.\".It Em SC_ALT_MOUSE_IMAGE +.\"This option selects the alternative way of displaying the mouse cursor +.\"in the virtual terminal. +.\"It may be vastly costly for some video cards to draw the arrow-shaped +.\"cursor and you may want to try this option. +.\"However, the appearance of the alternative mouse cursor may not be +.\"very appealing. +.It Em SC_DISABLE_REBOOT +This option disables the ``reboot'' key (by default, it is +.Em Ctl-Alt-Del ), +so that the casual user may not accidentally reboot the system. +.It Em SC_HISTORY_SIZE=N +Sets the size of back scroll buffer to +.Fa N +lines. +The default value is 100. +.It Em SC_MOUSE_CHAR=C +.\"Unless the +.\".Em SC_ALT_MOUSE_IMAGE +.\"option above is specified, the +The +.Nm +driver reserves four consecutive character codes in order to display the +mouse cursor in the virtual terminals in some systems. +This option specifies the first character code to +.Fa C +to be used for this purpose. +The default value is 0xd0. +A good candidate is 0x03. +.\".It Em SC_PIXEL_MODE +.It Em STD8X16FONT +This option will specify the default 8x16 font. +Without this option, the +.Nm +driver will use whatever font already loaded in the video card, +unless you explicitly load software font at startup. +See +.Sx EXAMPLE +below. +.El +.\".Pp +.\"The following options will remove some features from the +.\".Nm +.\"driver and save kernel memory. +.\".Bl -tag -width MOUSE +.\".It Em SC_NO_CUTPASTE +.\"This option disables ``copy and paste'' operation in virtual +.\"terminals. +.\".It Em SC_NO_FONT_LOADING +.\"The +.\".Nm +.\"driver can load software font on some video cards. +.\"This option removes this feature. +.\".It Em SC_NO_HISTORY +.\"This option disables back-scrolling in virtual terminals. +.\".It Em SC_NO_SYSMOUSE +.\"This option removes mouse support in the +.\".Nm +.\"driver. +.\"The mouse daemon +.\".Xr moused 8 +.\"will fail if this option is defined. +.\"This option implies the +.\".Em SC_NO_CUTPASTE +.\"option too. +.\".El +.Ss Driver Flags +The following driver flags can be used to control the +.Nm +driver. +They can be set either in the kernel configuration file +.Pq see Xr config 8 , +or else in the User Configuration Menu at boot +time +.Pq see Xr boot 8 . +.Bl -tag -width bit_0 +.It bit 0 (VISUAL_BELL) +Uses the ``visual'' bell. +The screen will blink instead of generating audible sound. +.It bit 1,2 (CURSOR_TYPE) +This option specifies the cursor appearance. +Possible values are: +.Bl -tag -width TYPE -compact +.It Em 0 +normal block cursor +.It Em 2 +blinking block cursor +.It Em 4 +underline cursor +.It Em 6 +blinking underline (aka destructive) cursor +.El +.It bit 6 (QUIET_BELL) +This option suppresses the bell, whether audible or visual, +if it is rung in a background virtual terminal. +.It bit 7 (VESA800X600) +This option puts the video card in the VESA 800x600 dots, 16 color +mode. +It may be useful for laptop computers for which the 800x600 mode +is otherwise unsupported by the X server. +Note that the ``copy-and-paste'' function is not currently supported in +this mode and the mouse pointer will not be displayed. +.El +.Sh FILES +.Bl -tag -width /usr/share/syscons/xxxxyyyyzzz -compact +.It Pa /dev/console +.It Pa /dev/consolectl +.It Pa /dev/ttyv? +virtual terminals +.It Pa /etc/ttys +terminal initialization information +.It Pa /usr/share/syscons/fonts/* +font files +.It Pa /usr/share/syscons/keymaps/* +key map files +.It Pa /usr/share/syscons/scrmaps/* +screen map files +.El +.Sh EXAMPLE +As the +.Nm +driver requires the keyboard driver and the video card driver, +the kernel configuration file should contain the following lines. +.Pp +.Bd -literal -offset indent +device atkbdc0 at isa? port IO_KBD tty +device atkbd0 at isa? tty irq 1 +device vga0 at isa? conflicts +device sc0 at isa? tty + +pseudo-device splash +.Ed +.Pp +If you do not intend to load the splash image or use the screen saver, +the last line is not necessary, and can be omitted. +.Pp +Note that the keyboard controller driver +.Nm atkbdc +is required by the keyboard driver +.Nm atkbd . +.Pp +The following example adds the font file +.Pa /usr/share/syscons/fonts/cp850-8x16.fnt +to the kernel as the default 8x16 font. +.Pp +.Dl "options" \&"STD8X16FONT\&" +.Dl "makeoptions" \&"STD8X16FONT\&"=\&"cp850\&" +.Dl "device sc0 at isa? tty" +.Pp +.\".Sh DIAGNOSTICS +.\".Sh CAVEATS +.Sh BUGS +This manual page is incomplete and urgently needs revision. +.Sh SEE ALSO +.Xr kbdcontrol 1 , +.Xr kldload 1 , +.Xr login 1 , +.Xr vidcontrol 1 , +.Xr atkbd 4 , +.Xr atkbdc 4 , +.Xr keyboard 4 , +.Xr screen 4 , +.Xr splash 4 , +.Xr vga 4 , +.Xr keymap 5 , +.Xr rc.conf 5 , +.Xr screenmap 5 , +.Xr ttys 5 , +.Xr config 8 , +.Xr getty 8 , +.Xr moused 8 . +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 1.0 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Søren Schmidt Aq sos@FreeBSD.org . +This manual page was written by +.An Kazutaka Yokota Aq yokota@FreeBSD.org . diff --git a/share/man/man4/vga.4 b/share/man/man4/vga.4 index a2d30c2..a14ff5d 100644 --- a/share/man/man4/vga.4 +++ b/share/man/man4/vga.4 @@ -24,10 +24,10 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: $ +.\" $Id: vga.4,v 1.1 1999/02/07 05:40:14 yokota Exp $ .\" -.Dd February 6, 1999 -.Dt VGA 4 i386 +.Dd February 9, 1999 +.Dt VGA 4 .Os FreeBSD .Sh NAME .Nm vga @@ -52,41 +52,43 @@ The console driver will call the .Nm driver to manipulate video hardware (changing video modes, loading font, etc). .Pp +The keyword +.Em conflicts +is required, as the video card may use I/O ports in the same range +as other drivers. +.Pp The .Nm -driver supports the standard video cards: MDA, CGA, EGA and VGA. -In addition, the driver can utilize the VESA BIOS extension, -if the video card has one. -VESA support can either be statically included in the kernel or -available as a separate module. +driver supports the standard video cards: MDA, CGA, EGA and VGA. In +addition, the driver can utilize VESA BIOS extensions if the video card +supports them. VESA support can either be statically included in the kernel +or can be loaded as a separate module. .Pp -In order to statically link the support to the kernel, define the +In order to statically link the support to the kernel, the .Em VESA option (see below) and the .Em VM86 -option in the kernel configuration file. +option must be defined in the kernel configuration file. .Pp The .Nm vesa -module can be loaded to the kernel, without static VESA support, by +module can be dynamically loaded into the kernel using .Xr kldload 8 . -The +This requires the .Em VM86 -option is required in the kernel configuration file in this case too. +option to be defined in the kernel configuration file. .Sh DRIVER CONFIGURATION .Ss Kernel Configuration Options -The following kernel configuration options control the +The following kernel configuration options +.Pq see Xr config 8 +can be used to control the .Nm driver. -They may be set in the kernel configuration file -.Pq see Xr config 8 . -.Pp -The following options are to provide compatibility with certain VGA -cards. +These options provide compatibility with certain VGA cards. .Bl -tag -width MOUSE .It Em VGA_ALT_SEQACCESS You may want to try this option if the mouse pointer is not drawn correctly -or font does not seem to be loaded properly on the VGA card. +or the font does not seem to be loaded properly on the VGA card. However, it may cause flicker on some systems. .It Em VGA_SLOW_IOACCESS Older VGA cards may require this option for proper operation. @@ -105,8 +107,9 @@ This option requires the .Em VM86 option. .It Em VESA_DEBUG=N -Set the VESA support debug level to N. -The default value is zero (all debugging output is suppressed). +Set the VESA support debug level to +.Fa N . +The default value is zero, which suppresses all debugging output. .El .Pp The following options will remove some features from the @@ -119,7 +122,7 @@ The driver can load software font to EGA and VGA cards. This option removes this feature. .It Em VGA_NO_MODE_CHANGE -This option disallows the driver to change video modes. +This option prevents the driver from changing video modes. .El .\".Sh FILES .Sh EXAMPLE @@ -134,16 +137,16 @@ in order to enable the VESA BIOS Extension support. .Dl "options" \&"VESA\&" .Dl "device vga0 at isa? port ? conflicts" .Pp -If you do not want the VESA support always included in the kernel, but +If you do not want VESA support included in the kernel, but want to use occasionally, add the following lines to the kernel configuration -file. +file: .Pp .Dl "options" \&"VM86\&" .Dl "device vga0 at isa? port ? conflicts" .Pp -And load the +Then load the .Nm vesa -module, when desired, as follows. +module as desired: .Pp .Dl kldload vesa .Pp @@ -151,6 +154,8 @@ module, when desired, as follows. .\".Sh CAVEATS .\".Sh BUGS .Sh SEE ALSO +.Xr syscons 4 , +.Xr config 8 , .Xr kldload 8 , .Xr kldunload 8 . .Sh STANDARD |