mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-11-27 08:00:11 +00:00
Code Issues Releases Activity

- Add atkbd.4, atkbdc.4, splash.4 and vga.4.

Browse Source 
- Update pcvt.4 and psm.4 to reflect recent keyboard driver changes.
This commit is contained in:
Kazutaka YOKOTA 1999-02-07 05:40:14 +00:00
parent 9c3f00c738
commit ded0cfef98
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=43725
13 changed files with 1304 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
share/man/man4/atkbd.4 Normal file
View File

@ -0,0 +1,104 @@
.\"
.\" 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 6, 1999
.Dt ATKBD 4 i386
.Os FreeBSD
.Sh NAME
.Nm atkbd
.Nd
the AT keyboard interface
.Sh SYNOPSIS
.Cd "device atkbd0 at isa? tty irq 1"
.Sh DESCRIPTION
The
.Nm
driver, together with the
.Nm atkbdc
driver, provides access to the AT 84 keyboard or the AT enhanced keyboard
which is connected to the AT keyboard controller.
.Pp
This driver is required for the console drivers
.Xr syscons 4
and
.Xr pcvt 4 .
.Pp
There can be only one
.Nm
device in the system and the keyboard controller
.Nm atkbdc
must be configured in the kernel too.
.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
.Pq see Xr boot 8 .
.Bl -tag -width MOUSE
.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
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
keyboard is reset.
.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
.\".Sh FILES
.\".Sh EXAMPLE
.\".Sh DIAGNOSTICS
.\".Sh CAVEATS
.\".Sh BUGS
.Sh SEE ALSO
.Xr atkbdc 4 ,
.Xr pcvt 4 ,
.Xr psm 4 .
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 3.1 .
.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
.An Kazutaka Yokota Aq yokota@FreeBSD.org .

112
share/man/man4/atkbdc.4 Normal file
View File

@ -0,0 +1,112 @@
.\"
.\" 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 6, 1999
.Dt ATKBDC 4 i386
.Os FreeBSD
.Sh NAME
.Nm atkbdc
.Nd
the AT keyboard controller interface
.Sh SYNOPSIS
.Cd "options" \&"KBD_RESETDELAY=N\&"
.Cd "options" \&"KBD_MAXWAIT=N\&"
.Cd "options" \&"KBDIO_DEBUG=N\&"
.Cd "controller atkbdc0 at isa? port IO_KBD tty"
.Sh DESCRIPTION
The keyboard controller
.Nm
provides I/O services for the AT keyboard and PS/2 mouse style
pointing devices.
This controller is required for the keyboard driver
.Nm atkbd
and the PS/2 pointing device driver
.Nm psm
to operate.
.Pp
There can be only one
.Nm
device in the system.
.Sh DRIVER CONFIGURATION
.Ss Kernel Configuration Options
There are following kernel configuration options to control the
.Nm
driver.
They may be set in the kernel configuration file
.Pq see Xr config 8 .
.Bl -tag -width MOUSE
.It Em KBD_RESETDELAY=X, KBD_MAXWAIT=Y
The keyboard driver
.Nm atkbd
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
the reset command.
These options control how long the
.Nm
driver should
wait before it eventually gives up waiting. The driver will wait
.Fa X
*
.Fa Y
msecs at most. If the drivers seem unable to detect
devices, you may want to increase these values. The default values are
200 msec for
.Fa X
and 5
for
.Fa Y .
.It Em KBDIO_DEBUG=N
Sets the debug level to
.Fa N .
The default debug level is zero.
.El
.\".Ss Driver Flags
.\".Sh FILES
.\".Sh EXAMPLE
.\".Sh DIAGNOSTICS
.\".Sh CAVEATS
.\".Sh BUGS
.Sh SEE ALSO
.Xr atkbd 4 ,
.Xr psm 4 .
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 3.1 .
It is based on the kbdio module in
.Fx 2.2 .
.Sh AUTHORS
The kbdio module and the
.Nm
driver and this manual page were written by
.An Kazutaka Yokota Aq yokota@FreeBSD.org .

12
share/man/man4/man4.i386/Makefile
View File

@ -1,13 +1,13 @@
# $Id: Makefile,v 1.94 1999/01/09 18:12:06 wpaul Exp $
# $Id: Makefile,v 1.95 1999/01/20 11:36:26 jkh Exp $
MAN4= adv.4 adw.4 aha.4 ahb.4 ahc.4 aic.4 apm.4 ar.4 asc.4 ax.4 \
bktr.4 bt.4 cs.4 cx.4 cy.4 de.4 \
MAN4= adv.4 adw.4 aha.4 ahb.4 ahc.4 aic.4 apm.4 ar.4 asc.4 atkbd.4 \
atkbdc.4 ax.4 bktr.4 bt.4 cs.4 cx.4 cy.4 de.4 \
dgb.4 dpt.4 ed.4 el.4 en.4 ep.4 ex.4 fdc.4 fe.4 fxp.4 gsc.4 ie.4 \
io.4 joy.4 keyboard.4 labpc.4 le.4 lnc.4 lp.4 lpt.4 matcd.4 mcd.4 \
mem.4 meteor.4 mouse.4 mse.4 mtio.4 mx.4 ncr.4 npx.4 \
pcf.4 pcm.4 pcvt.4 perfmon.4 pn.4 pnp.4 ppc.4 psm.4 \
rdp.4 rl.4 sb.4 scd.4 screen.4 si.4 sio.4 \
spkr.4 sr.4 sysmouse.4 tl.4 tw.4 tx.4 vr.4 vx.4 \
spkr.4 splash.4 sr.4 sysmouse.4 tl.4 tw.4 tx.4 vga.4 vr.4 vx.4 \
wb.4 wd.4 wfd.4 wl.4 wt.4 xl.4 ze.4 zp.4
MLINKS= adv.4 ../adv.4
@ -19,6 +19,8 @@ MLINKS+= aic.4 ../aic.4
MLINKS+= apm.4 ../apm.4
MLINKS+= ar.4 ../ar.4
MLINKS+= asc.4 ../asc.4
MLINKS+= atkbd.4 ../atkbd.4
MLINKS+= atkbdc.4 ../atkbdc.4
MLINKS+= ax.4 ../ax.4
MLINKS+= bktr.4 ../bktr.4
MLINKS+= bt.4 ../bt.4
@ -72,11 +74,13 @@ MLINKS+= screen.4 ../screen.4
MLINKS+= si.4 ../si.4
MLINKS+= sio.4 ../sio.4
MLINKS+= spkr.4 ../spkr.4 spkr.4 speaker.4 spkr.4 ../speaker.4
MLINKS+= splash.4 ../splash.4 splash.4 screensaver.4 splash.4 ../screensaver.4
MLINKS+= sr.4 ../sr.4
MLINKS+= sysmouse.4 ../sysmouse.4
MLINKS+= tl.4 ../tl.4
MLINKS+= tw.4 ../tw.4
MLINKS+= tx.4 ../tx.4
MLINKS+= vga.4 ../vga.4
MLINKS+= vr.4 ../vr.4
MLINKS+= vx.4 ../vx.4
MLINKS+= wb.4 ../wb.4

104
share/man/man4/man4.i386/atkbd.4 Normal file
View File

@ -0,0 +1,104 @@
.\"
.\" 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 6, 1999
.Dt ATKBD 4 i386
.Os FreeBSD
.Sh NAME
.Nm atkbd
.Nd
the AT keyboard interface
.Sh SYNOPSIS
.Cd "device atkbd0 at isa? tty irq 1"
.Sh DESCRIPTION
The
.Nm
driver, together with the
.Nm atkbdc
driver, provides access to the AT 84 keyboard or the AT enhanced keyboard
which is connected to the AT keyboard controller.
.Pp
This driver is required for the console drivers
.Xr syscons 4
and
.Xr pcvt 4 .
.Pp
There can be only one
.Nm
device in the system and the keyboard controller
.Nm atkbdc
must be configured in the kernel too.
.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
.Pq see Xr boot 8 .
.Bl -tag -width MOUSE
.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
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
keyboard is reset.
.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
.\".Sh FILES
.\".Sh EXAMPLE
.\".Sh DIAGNOSTICS
.\".Sh CAVEATS
.\".Sh BUGS
.Sh SEE ALSO
.Xr atkbdc 4 ,
.Xr pcvt 4 ,
.Xr psm 4 .
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 3.1 .
.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
.An Kazutaka Yokota Aq yokota@FreeBSD.org .

112
share/man/man4/man4.i386/atkbdc.4 Normal file
View File

@ -0,0 +1,112 @@
.\"
.\" 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 6, 1999
.Dt ATKBDC 4 i386
.Os FreeBSD
.Sh NAME
.Nm atkbdc
.Nd
the AT keyboard controller interface
.Sh SYNOPSIS
.Cd "options" \&"KBD_RESETDELAY=N\&"
.Cd "options" \&"KBD_MAXWAIT=N\&"
.Cd "options" \&"KBDIO_DEBUG=N\&"
.Cd "controller atkbdc0 at isa? port IO_KBD tty"
.Sh DESCRIPTION
The keyboard controller
.Nm
provides I/O services for the AT keyboard and PS/2 mouse style
pointing devices.
This controller is required for the keyboard driver
.Nm atkbd
and the PS/2 pointing device driver
.Nm psm
to operate.
.Pp
There can be only one
.Nm
device in the system.
.Sh DRIVER CONFIGURATION
.Ss Kernel Configuration Options
There are following kernel configuration options to control the
.Nm
driver.
They may be set in the kernel configuration file
.Pq see Xr config 8 .
.Bl -tag -width MOUSE
.It Em KBD_RESETDELAY=X, KBD_MAXWAIT=Y
The keyboard driver
.Nm atkbd
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
the reset command.
These options control how long the
.Nm
driver should
wait before it eventually gives up waiting. The driver will wait
.Fa X
*
.Fa Y
msecs at most. If the drivers seem unable to detect
devices, you may want to increase these values. The default values are
200 msec for
.Fa X
and 5
for
.Fa Y .
.It Em KBDIO_DEBUG=N
Sets the debug level to
.Fa N .
The default debug level is zero.
.El
.\".Ss Driver Flags
.\".Sh FILES
.\".Sh EXAMPLE
.\".Sh DIAGNOSTICS
.\".Sh CAVEATS
.\".Sh BUGS
.Sh SEE ALSO
.Xr atkbd 4 ,
.Xr psm 4 .
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 3.1 .
It is based on the kbdio module in
.Fx 2.2 .
.Sh AUTHORS
The kbdio module and the
.Nm
driver and this manual page were written by
.An Kazutaka Yokota Aq yokota@FreeBSD.org .

11
share/man/man4/man4.i386/pcvt.4
View File

@ -31,7 +31,7 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" @(#)pcvt.4, 3.20, Last Edit-Date: [Sun Apr 2 18:23:39 1995]
.\" $Id: pcvt.4,v 1.12 1998/10/22 14:29:03 bde Exp $
.\" $Id: pcvt.4,v 1.14 1999/01/01 08:48:31 peter Exp $
.\"
.\" Man page pcvt(4) created after pcvt_ioctl.h on 13-Jan-93
.\" by Joerg Wunsch
@ -65,7 +65,7 @@ see
below
.Pc
.Pp
.Cd "device vt0 at isa? port IO_KBD tty irq 1"
.Cd "device vt0 at isa? tty"
.Sh DESCRIPTION
.Ss Overview
The
@ -81,6 +81,12 @@ of DEC VT-220
functionality. See
.Sx Features
for a detailed description.
.Pp
The
.Nm pcvt
driver requires the keyboard driver
.Nm atkbd
to be also configured in the kernel.
.Ss Features
.Bl -bullet
@ -859,6 +865,7 @@ implementation
.Sh SEE ALSO
.Xr intro 2 ,
.Xr ioctl 2 ,
.Xr atkbd 4 ,
.Xr keyboard 4 ,
.Xr screen 4 ,
.Xr config 8 ,

37
share/man/man4/man4.i386/psm.4
View File

@ -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: psm.4,v 1.13 1998/10/22 14:36:55 bde Exp $
.\" $Id: psm.4,v 1.14 1999/01/26 10:01:01 yokota Exp $
.\"
.Dd December 3, 1997
.Dd January 30, 1999
.Dt PSM 4 i386
.Os FreeBSD
.Sh NAME
@ -40,7 +40,7 @@ PS/2 mouse style pointing device driver
.Cd "options" \&"KBD_MAXWAIT=N\&"
.Cd "options" \&"PSM_DEBUG=N\&"
.Cd "options" \&"KBDIO_DEBUG=N\&"
.Cd "device psm0 at isa? port IO_KBD conflicts tty irq 12"
.Cd "device psm0 at isa? tty irq 12"
.Sh DESCRIPTION
The
.Nm
@ -48,15 +48,12 @@ driver provides support for the PS/2 mouse style pointing device.
Currently there can be only one
.Nm
device node in the system.
.Em port IO_KBD
and
.Em conflicts
are required,
as the PS/2 mouse port is located
at the auxiliary port of the keyboard controller; the
.Nm
driver has to share the same I/O ports with the keyboard driver.
Note also that there is currently no provision of changing the
As the PS/2 mouse port is located
at the auxiliary port of the keyboard controller,
the keyboard controller driver,
.Nm atkbdc ,
must also be configured in the kernel.
Note that there is currently no provision of changing the
.Em irq
number.
.Pp
@ -597,24 +594,21 @@ movement counts as described in
.Sh FILES
.Bl -tag -width /dev/npsm0 -compact
.It Pa /dev/psm0
`non-blocking' device node in the system without
.Em devfs ,
`blocking' under
.Em devfs .
.It Pa /dev/npsm0
`non-blocking' device node under
`non-blocking' device node
.It Pa /dev/bpsm0
`blocking' device node under
.Em devfs .
.El
.Sh EXAMPLE
.Dl "options" \&"PSM_HOOKAPM\&"
.Dl "device psm0 at isa? port IO_KBD conflicts tty irq 12"
.Dl "device psm0 at isa? tty irq 12"
.Pp
Add the
.Nm
driver to the kernel with the optional code to stimulate the pointing device
after the `resume' event.
.Pp
.Dl "device psm0 at isa? port IO_KBD conflicts tty flags 0x024 irq 12"
.Dl "device psm0 at isa? tty flags 0x024 irq 12"
.Pp
Set the device resolution high (4) and the acceleration factor to 2.
.Sh DIAGNOSTICS
@ -644,7 +638,7 @@ kbdio: RESET_AUX status:00aa
kbdio: RESET_AUX ID:0000
[...]
psm: status 00 02 64
psm0 at 0x60-0x64 irq 12 on motherboard
psm0 irq 12 on isa
psm0: model AAAA, device ID X, N buttons
psm0: config:00000www, flags:0000uuuu, packet size:M
psm0: syncmask:xx, syncbits:yy
@ -743,6 +737,7 @@ has been removed. It was never functional anyway.
.Sh SEE ALSO
.Xr ioctl 2 ,
.Xr syslog 3 ,
.Xr atkbdc 4 ,
.Xr mouse 4 ,
.Xr mse 4 ,
.Xr sysmouse 4 ,

233
share/man/man4/man4.i386/splash.4 Normal file
View File

@ -0,0 +1,233 @@
.\"
.\" 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 6, 1999
.Dt SPLASH 4 i386
.Os FreeBSD
.Sh NAME
.Nm splash
.Nd
splash screen / screen saver interface
.Sh SYNOPSIS
.Cd "pseudo-device splash"
.Sh DESCRIPTION
The
.Nm
pseudo device driver adds support for the splash screen and screen
savers to the kernel.
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.
.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).
.Pp
In order to display the bitmap, the bitmap file itself and
matching splash image decoder must be loaded by the boot loader.
Currently the following decoder module is available:
.Pp
.Bl -tag -width splash -compact
.It 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.
.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 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.
.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
This screen saver simply blanks the screen.
.It daemon_saver.ko
Animated BSD Daemon screen saver.
.It fade_saver.ko
The screen will gradually fade away.
.It green_saver.ko
If the monitor supports power saving mode, it will be turned off.
.It logo_saver.ko
Animated graphical BSD Daemon.
.It rain_saver.ko
Draws shower on the screen.
.It snake_saver.ko
Draws a snake of string.
.It star_saver.ko
Twinkling stars.
.It warp_saver.ko
Streaking stars.
.El
.Pp
Load a screen saver module via
.Xr kldload 1 .
.Pp
.Dl kldload logo_saver
.Pp
Then specify timeout value, in seconds, as follows:
.Pp
.Dl vidcontrol -t timeout
.Pp
Alternatively, you can set the
.Ar saver
variable in the
.Pa /etc/rc.conf
to the screen saver of your choice and
the timeout value to the
.Ar blanktime
variable so that the screen saver is automatically loaded
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
.Ar saver
key by modifying the keymap.
See
.Xr kbdcontrol 1
and
.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.
.Sh SPLASH SCREEN AS A SCREEN SAVER
If you load a splash image but don't load a screen saver,
you can continue using the splash module as a screen saver.
Specify the screen blanking interval as explained in the
.Sx SCREEN SAVER
section above, and
the splash screen image will come back after the specified time.
.\".Sh DRIVER CONFIGURATION
.Sh FILES
.Bl -tag -width /modules/splash_xxxx.ko -compact
.It /boot/loader.rc
boot loader script
.It /etc/rc.conf
system configuration information
.It /modules/splash_*.ko
splash image decoder modules
.It /modules/*_saver.ko
screen saver modules
.It /modules/vesa.ko
the VESA support module
.El
.Sh EXAMPLE
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
the boot loader script
.Pa /boot/loader.rc
.Pq see Xr loader.rc 5 .
.Bd -literal -offset indent
load kernel
load -t splash_image_data chuck.bmp
load splash_bmp
.Ed
.Pp
The second line loads a bitmap image file to be used in the splash screen.
In the above example, the file
.Pa chuck.bmp
is loaded.
It is extremely important to include the option
.Fl t Ar splash_image_data
in this line, as the splash image decoder module will search for
this tag name when looking up the preloaded bitmap data.
The third line loads the splash image decoder module
.Pa splash_bmp .
.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.
.Bd -literal -offset indent
load kernel
load vesa
load -t splash_image_data chuck.bmp
load splash_bmp
.Ed
.Pp
If the VESA support is statically linked to the kernel, it is not
necessary to load the VESA module.
Just load the bitmap file and the splash decoder module as in the
first example above.
.\".Sh DIAGNOSTICS
.Sh CAVEATS
Both the splash screen and the screen saver work with
.Xr syscons 4
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.
.Sh SEE ALSO
.Xr vidcontrol 1 ,
.Xr vga 4 ,
.Xr rc.conf 5 ,
.Xr kldload 8 ,
.Xr kldunload 8 .
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 3.1 .
.Sh AUTHORS
The
.Nm
driver and this manual page were written by
.An Kazutaka Yokota Aq yokota@FreeBSD.org .

174
share/man/man4/man4.i386/vga.4 Normal file
View File

@ -0,0 +1,174 @@
.\"
.\" 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 6, 1999
.Dt VGA 4 i386
.Os FreeBSD
.Sh NAME
.Nm vga
.Nd
generic video card interface
.Sh SYNOPSIS
.Cd "options" \&"VESA\&"
.Cd "options" \&"VESA_DEBUG=N\&"
.Cd "options" \&"VGA_ALT_SEQACCESS\&"
.Cd "options" \&"VGA_NO_FONT_LOADING\&"
.Cd "options" \&"VGA_NO_MODE_CHANGE\&"
.Cd "options" \&"VGA_SLOW_IOACCESS\&"
.Cd "options" \&"VM86\&"
.Cd "device vga0 at isa? port ? conflicts"
.Sh DESCRIPTION
The
.Nm
driver is a generic video card driver which provides access to
video cards. This driver is required for the console driver
.Xr syscons 4 .
The console driver will call the
.Nm
driver to manipulate video hardware (changing video modes, loading font, etc).
.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.
.Pp
In order to statically link the support to the kernel, define the
.Em VESA
option (see below) and the
.Em VM86
option in the kernel configuration file.
.Pp
The
.Nm vesa
module can be loaded to the kernel, without static VESA support, by
.Xr kldload 8 .
The
.Em VM86
option is required in the kernel configuration file in this case too.
.Sh DRIVER CONFIGURATION
.Ss Kernel Configuration Options
The following kernel configuration options 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.
.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.
However, it may cause flicker on some systems.
.It Em VGA_SLOW_IOACCESS
Older VGA cards may require this option for proper operation.
It makes the driver perform byte-wide I/O to VGA registers and
slow down a little.
.El
.Pp
The following options add optional features to the driver.
.Bl -tag -width MOUSE
.It Em VESA
Add VESA BIOS support to the driver.
If the VGA card has the VESA BIOS extension 1.2 or later,
this option will utilize the VESA BIOS service to switch to high
resolution modes.
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).
.El
.Pp
The following options will remove some features from the
.Nm
driver and save kernel memory.
.Bl -tag -width MOUSE
.It Em VGA_NO_FONT_LOADING
The
.Nm
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.
.El
.\".Sh FILES
.Sh EXAMPLE
Your kernel configuration should normally have:
.Pp
.Dl "device vga0 at isa? port ? conflicts"
.Pp
The following lines should be included in the kernel configuration file
in order to enable the VESA BIOS Extension support.
.Pp
.Dl "options" \&"VM86\&"
.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
want to use occasionally, add the following lines to the kernel configuration
file.
.Pp
.Dl "options" \&"VM86\&"
.Dl "device vga0 at isa? port ? conflicts"
.Pp
And load the
.Nm vesa
module, when desired, as follows.
.Pp
.Dl kldload vesa
.Pp
.\".Sh DIAGNOSTICS
.\".Sh CAVEATS
.\".Sh BUGS
.Sh SEE ALSO
.Xr kldload 8 ,
.Xr kldunload 8 .
.Sh STANDARD
.Rs
.%T "VESA BIOS Extension (VBE)"
.%A Video Electronics Standards Association
.Re
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 3.1 .
.Sh AUTHORS
The
.Nm
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 .

11
share/man/man4/pcvt.4
View File

@ -31,7 +31,7 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" @(#)pcvt.4, 3.20, Last Edit-Date: [Sun Apr 2 18:23:39 1995]
.\" $Id: pcvt.4,v 1.12 1998/10/22 14:29:03 bde Exp $
.\" $Id: pcvt.4,v 1.14 1999/01/01 08:48:31 peter Exp $
.\"
.\" Man page pcvt(4) created after pcvt_ioctl.h on 13-Jan-93
.\" by Joerg Wunsch
@ -65,7 +65,7 @@ see
below
.Pc
.Pp
.Cd "device vt0 at isa? port IO_KBD tty irq 1"
.Cd "device vt0 at isa? tty"
.Sh DESCRIPTION
.Ss Overview
The
@ -81,6 +81,12 @@ of DEC VT-220
functionality. See
.Sx Features
for a detailed description.
.Pp
The
.Nm pcvt
driver requires the keyboard driver
.Nm atkbd
to be also configured in the kernel.
.Ss Features
.Bl -bullet
@ -859,6 +865,7 @@ implementation
.Sh SEE ALSO
.Xr intro 2 ,
.Xr ioctl 2 ,
.Xr atkbd 4 ,
.Xr keyboard 4 ,
.Xr screen 4 ,
.Xr config 8 ,

37
share/man/man4/psm.4
View File

@ -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: psm.4,v 1.13 1998/10/22 14:36:55 bde Exp $
.\" $Id: psm.4,v 1.14 1999/01/26 10:01:01 yokota Exp $
.\"
.Dd December 3, 1997
.Dd January 30, 1999
.Dt PSM 4 i386
.Os FreeBSD
.Sh NAME
@ -40,7 +40,7 @@ PS/2 mouse style pointing device driver
.Cd "options" \&"KBD_MAXWAIT=N\&"
.Cd "options" \&"PSM_DEBUG=N\&"
.Cd "options" \&"KBDIO_DEBUG=N\&"
.Cd "device psm0 at isa? port IO_KBD conflicts tty irq 12"
.Cd "device psm0 at isa? tty irq 12"
.Sh DESCRIPTION
The
.Nm
@ -48,15 +48,12 @@ driver provides support for the PS/2 mouse style pointing device.
Currently there can be only one
.Nm
device node in the system.
.Em port IO_KBD
and
.Em conflicts
are required,
as the PS/2 mouse port is located
at the auxiliary port of the keyboard controller; the
.Nm
driver has to share the same I/O ports with the keyboard driver.
Note also that there is currently no provision of changing the
As the PS/2 mouse port is located
at the auxiliary port of the keyboard controller,
the keyboard controller driver,
.Nm atkbdc ,
must also be configured in the kernel.
Note that there is currently no provision of changing the
.Em irq
number.
.Pp
@ -597,24 +594,21 @@ movement counts as described in
.Sh FILES
.Bl -tag -width /dev/npsm0 -compact
.It Pa /dev/psm0
`non-blocking' device node in the system without
.Em devfs ,
`blocking' under
.Em devfs .
.It Pa /dev/npsm0
`non-blocking' device node under
`non-blocking' device node
.It Pa /dev/bpsm0
`blocking' device node under
.Em devfs .
.El
.Sh EXAMPLE
.Dl "options" \&"PSM_HOOKAPM\&"
.Dl "device psm0 at isa? port IO_KBD conflicts tty irq 12"
.Dl "device psm0 at isa? tty irq 12"
.Pp
Add the
.Nm
driver to the kernel with the optional code to stimulate the pointing device
after the `resume' event.
.Pp
.Dl "device psm0 at isa? port IO_KBD conflicts tty flags 0x024 irq 12"
.Dl "device psm0 at isa? tty flags 0x024 irq 12"
.Pp
Set the device resolution high (4) and the acceleration factor to 2.
.Sh DIAGNOSTICS
@ -644,7 +638,7 @@ kbdio: RESET_AUX status:00aa
kbdio: RESET_AUX ID:0000
[...]
psm: status 00 02 64
psm0 at 0x60-0x64 irq 12 on motherboard
psm0 irq 12 on isa
psm0: model AAAA, device ID X, N buttons
psm0: config:00000www, flags:0000uuuu, packet size:M
psm0: syncmask:xx, syncbits:yy
@ -743,6 +737,7 @@ has been removed. It was never functional anyway.
.Sh SEE ALSO
.Xr ioctl 2 ,
.Xr syslog 3 ,
.Xr atkbdc 4 ,
.Xr mouse 4 ,
.Xr mse 4 ,
.Xr sysmouse 4 ,

233
share/man/man4/splash.4 Normal file
View File

@ -0,0 +1,233 @@
.\"
.\" 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 6, 1999
.Dt SPLASH 4 i386
.Os FreeBSD
.Sh NAME
.Nm splash
.Nd
splash screen / screen saver interface
.Sh SYNOPSIS
.Cd "pseudo-device splash"
.Sh DESCRIPTION
The
.Nm
pseudo device driver adds support for the splash screen and screen
savers to the kernel.
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.
.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).
.Pp
In order to display the bitmap, the bitmap file itself and
matching splash image decoder must be loaded by the boot loader.
Currently the following decoder module is available:
.Pp
.Bl -tag -width splash -compact
.It 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.
.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 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.
.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
This screen saver simply blanks the screen.
.It daemon_saver.ko
Animated BSD Daemon screen saver.
.It fade_saver.ko
The screen will gradually fade away.
.It green_saver.ko
If the monitor supports power saving mode, it will be turned off.
.It logo_saver.ko
Animated graphical BSD Daemon.
.It rain_saver.ko
Draws shower on the screen.
.It snake_saver.ko
Draws a snake of string.
.It star_saver.ko
Twinkling stars.
.It warp_saver.ko
Streaking stars.
.El
.Pp
Load a screen saver module via
.Xr kldload 1 .
.Pp
.Dl kldload logo_saver
.Pp
Then specify timeout value, in seconds, as follows:
.Pp
.Dl vidcontrol -t timeout
.Pp
Alternatively, you can set the
.Ar saver
variable in the
.Pa /etc/rc.conf
to the screen saver of your choice and
the timeout value to the
.Ar blanktime
variable so that the screen saver is automatically loaded
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
.Ar saver
key by modifying the keymap.
See
.Xr kbdcontrol 1
and
.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.
.Sh SPLASH SCREEN AS A SCREEN SAVER
If you load a splash image but don't load a screen saver,
you can continue using the splash module as a screen saver.
Specify the screen blanking interval as explained in the
.Sx SCREEN SAVER
section above, and
the splash screen image will come back after the specified time.
.\".Sh DRIVER CONFIGURATION
.Sh FILES
.Bl -tag -width /modules/splash_xxxx.ko -compact
.It /boot/loader.rc
boot loader script
.It /etc/rc.conf
system configuration information
.It /modules/splash_*.ko
splash image decoder modules
.It /modules/*_saver.ko
screen saver modules
.It /modules/vesa.ko
the VESA support module
.El
.Sh EXAMPLE
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
the boot loader script
.Pa /boot/loader.rc
.Pq see Xr loader.rc 5 .
.Bd -literal -offset indent
load kernel
load -t splash_image_data chuck.bmp
load splash_bmp
.Ed
.Pp
The second line loads a bitmap image file to be used in the splash screen.
In the above example, the file
.Pa chuck.bmp
is loaded.
It is extremely important to include the option
.Fl t Ar splash_image_data
in this line, as the splash image decoder module will search for
this tag name when looking up the preloaded bitmap data.
The third line loads the splash image decoder module
.Pa splash_bmp .
.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.
.Bd -literal -offset indent
load kernel
load vesa
load -t splash_image_data chuck.bmp
load splash_bmp
.Ed
.Pp
If the VESA support is statically linked to the kernel, it is not
necessary to load the VESA module.
Just load the bitmap file and the splash decoder module as in the
first example above.
.\".Sh DIAGNOSTICS
.Sh CAVEATS
Both the splash screen and the screen saver work with
.Xr syscons 4
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.
.Sh SEE ALSO
.Xr vidcontrol 1 ,
.Xr vga 4 ,
.Xr rc.conf 5 ,
.Xr kldload 8 ,
.Xr kldunload 8 .
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 3.1 .
.Sh AUTHORS
The
.Nm
driver and this manual page were written by
.An Kazutaka Yokota Aq yokota@FreeBSD.org .

174
share/man/man4/vga.4 Normal file
View File

@ -0,0 +1,174 @@
.\"
.\" 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 6, 1999
.Dt VGA 4 i386
.Os FreeBSD
.Sh NAME
.Nm vga
.Nd
generic video card interface
.Sh SYNOPSIS
.Cd "options" \&"VESA\&"
.Cd "options" \&"VESA_DEBUG=N\&"
.Cd "options" \&"VGA_ALT_SEQACCESS\&"
.Cd "options" \&"VGA_NO_FONT_LOADING\&"
.Cd "options" \&"VGA_NO_MODE_CHANGE\&"
.Cd "options" \&"VGA_SLOW_IOACCESS\&"
.Cd "options" \&"VM86\&"
.Cd "device vga0 at isa? port ? conflicts"
.Sh DESCRIPTION
The
.Nm
driver is a generic video card driver which provides access to
video cards. This driver is required for the console driver
.Xr syscons 4 .
The console driver will call the
.Nm
driver to manipulate video hardware (changing video modes, loading font, etc).
.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.
.Pp
In order to statically link the support to the kernel, define the
.Em VESA
option (see below) and the
.Em VM86
option in the kernel configuration file.
.Pp
The
.Nm vesa
module can be loaded to the kernel, without static VESA support, by
.Xr kldload 8 .
The
.Em VM86
option is required in the kernel configuration file in this case too.
.Sh DRIVER CONFIGURATION
.Ss Kernel Configuration Options
The following kernel configuration options 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.
.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.
However, it may cause flicker on some systems.
.It Em VGA_SLOW_IOACCESS
Older VGA cards may require this option for proper operation.
It makes the driver perform byte-wide I/O to VGA registers and
slow down a little.
.El
.Pp
The following options add optional features to the driver.
.Bl -tag -width MOUSE
.It Em VESA
Add VESA BIOS support to the driver.
If the VGA card has the VESA BIOS extension 1.2 or later,
this option will utilize the VESA BIOS service to switch to high
resolution modes.
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).
.El
.Pp
The following options will remove some features from the
.Nm
driver and save kernel memory.
.Bl -tag -width MOUSE
.It Em VGA_NO_FONT_LOADING
The
.Nm
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.
.El
.\".Sh FILES
.Sh EXAMPLE
Your kernel configuration should normally have:
.Pp
.Dl "device vga0 at isa? port ? conflicts"
.Pp
The following lines should be included in the kernel configuration file
in order to enable the VESA BIOS Extension support.
.Pp
.Dl "options" \&"VM86\&"
.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
want to use occasionally, add the following lines to the kernel configuration
file.
.Pp
.Dl "options" \&"VM86\&"
.Dl "device vga0 at isa? port ? conflicts"
.Pp
And load the
.Nm vesa
module, when desired, as follows.
.Pp
.Dl kldload vesa
.Pp
.\".Sh DIAGNOSTICS
.\".Sh CAVEATS
.\".Sh BUGS
.Sh SEE ALSO
.Xr kldload 8 ,
.Xr kldunload 8 .
.Sh STANDARD
.Rs
.%T "VESA BIOS Extension (VBE)"
.%A Video Electronics Standards Association
.Re
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 3.1 .
.Sh AUTHORS
The
.Nm
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 .