add some manpages for wscons framework and devices

This commit is contained in:
drochner 1999-03-22 19:15:01 +00:00
parent 61c3516908
commit fba9742963
8 changed files with 531 additions and 32 deletions

View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.85 1999/03/16 19:20:15 jwise Exp $
# $NetBSD: Makefile,v 1.86 1999/03/22 19:15:03 drochner Exp $
# @(#)Makefile 8.1 (Berkeley) 6/18/93
MAN= ahb.4 ahc.4 aria.4 atalk.4 audio.4 bha.4 bpf.4 ccd.4 cd.4 ch.4 \
@ -6,11 +6,11 @@ MAN= ahb.4 ahc.4 aria.4 atalk.4 audio.4 bha.4 bpf.4 ccd.4 cd.4 ch.4 \
exphy.4 fd.4 fpa.4 fxp.4 gre.4 icmp.4 icsphy.4 idp.4 ifmedia.4 \
inet.4 inphy.4 ip.4 iso.4 isp.4 lc.4 lkm.4 lo.4 lxtphy.4 md.4 \
midi.4 mii.4 mtio.4 ncr.4 ne.4 netintro.4 ns.4 nsip.4 nsphy.4 \
null.4 opl.4 options.4 pciide.4 pcscp.4 ppp.4 pty.4 puc.4 qsphy.4 \
raid.4 rnd.4 route.4 rtpphy.4 scsi.4 sd.4 sl.4 sm.4 spp.4 sqphy.4 \
ss.4 st.4 sv.4 strip.4 tb.4 tcp.4 termios.4 tl.4 tlphy.4 tp.4 \
tty.4 tun.4 udp.4 uha.4 uk.4 unix.4 vnd.4 wd.4 wdc.4 wscons.4 \
ym.4 zstty.4
null.4 opl.4 options.4 pcdisplay.4 pciide.4 pckbd.4 pcscp.4 ppp.4 \
pty.4 puc.4 qsphy.4 raid.4 rnd.4 route.4 rtpphy.4 scsi.4 sd.4 sl.4 \
sm.4 spp.4 sqphy.4 ss.4 st.4 sv.4 strip.4 tb.4 tcp.4 termios.4 tl.4 \
tlphy.4 tp.4 tty.4 tun.4 udp.4 uha.4 uk.4 unix.4 vga.4 vnd.4 wd.4 \
wdc.4 wscons.4 wsdisplay.4 wskbd.4 wsmouse.4 ym.4 zstty.4
# USB devices
MAN+= uaudio.4 ugen.4 uhid.4 ukbd.4 ulpt.4 ums.4 usb.4
@ -31,7 +31,6 @@ MLINKS+=fd.4 stderr.4 fd.4 stdin.4 fd.4 stdout.4
MLINKS+=fpa.4 fea.4 fpa.4 fta.4
MLINKS+=netintro.4 networking.4
MLINKS+=si.4 sw.4
MLINKS+=wscons.4 wsdisplay.4 wscons.4 wskbd.4 wscons.4 wsmouse.4
SUBDIR= man4.amiga man4.arm32 man4.atari man4.hp300 man4.i386 \
man4.mac68k man4.pc532 man4.pmax man4.sparc man4.sun3 \

View File

@ -0,0 +1,37 @@
.\" $NetBSD: pcdisplay.4,v 1.1 1999/03/22 19:15:03 drochner Exp $
.Dd March 20, 1999
.Os
.Dt PCDISPLAY 4
.Sh NAME
.Nm pcdisplay
.Nd PC display adapter driver for wscons
.Sh SYNOPSIS
.Cd "pcdisplay0 at isa?"
.Cd "wsdisplay* at pcdisplay? console ?"
.Sh DESCRIPTION
This driver supports PC display adapter hardware within the
.Xr wscons 4
console framework. It doesn't provide direct device
driver entry points but makes its functions available via
the internal
.Xr wsdisplay 4
interface.
.Pp
The
.Nm
driver is indended as a minimal
.Dq catch-all
driver for the different kinds of
.Tn MDA
or
.Tn CGA
compatible adapters. It doesn't support multiple screens, nor
colors or font loading.
.Sh SEE ALSO
.Xr isa 4 ,
.Xr wscons 4 ,
.Xr vga 4

110
share/man/man4/pckbd.4 Normal file
View File

@ -0,0 +1,110 @@
.\" $NetBSD: pckbd.4,v 1.1 1999/03/22 19:15:02 drochner Exp $
.Dd March 20, 1999
.Os
.Dt PCKBD 4
.Sh NAME
.Nm pckbd
.Nd PC keyboard driver for wscons
.Sh SYNOPSIS
.Cd "pckbc0 at isa?"
.Cd "pckbd* at pckbc?"
.Cd "wskbd* at pckbd? console ?"
.Cd "options PCKBD_LAYOUT=XXX"
.Sh DESCRIPTION
This driver supports PC/AT keyboards within the
.Xr wscons 4
console framework. It doesn't provide direct device
driver entry points but makes its functions available via
the internal
.Xr wskbd 4
interface.
.Pp
The
.Nm
driver supports a number of different key mappings which
can be chosen from with the kernel option
.Dq PCKBD_LAYOUT
at compile time or with the utility
.Xr wsconsctl 8
(variable:
.Dq encoding
) at runtime.
Other mappings can be used if the whole keymap is replaced by means of
.Xr wsconsctl 8 .
The builtin mappings are at this time:
.Bl -hang
.It KB_US
(for wsconsctl:
.Dq us
) English / US keyboard mapping (default).
.It KB_DE
(
.Dq de
) German with
.Dq dead accents .
.It KB_DE | KB_NODEAD
(
.Dq de.nodead
) German without
.Dq dead accents .
.It KB_FR
(
.Dq fr
) French.
.It KB_DK
(
.Dq dk
) Danish with
.Dq dead accents .
.It KB_DK | KB_NODEAD
(
.Dq dk.nodead
) Danish without
.Dq dead accents .
.It KB_IT
(
.Dq it
) Italian.
.It KB_UK
(
.Dq uk
) British.
.It KB_JP
(
.Dq jp
) Japanese.
.It KB_US | KB_DECLK
(
.Dq us.declk
) English / US mapping for
.Tn DEC
LK400-style keyboards with PC keyboard interface (eg LK461).
.It KB_US | KB_SWAPCTRLCAPS
(
.Dq us.swapctrlcaps
) English / US mapping with swapped
.Dq Control
and
.Dq Caps Lock
keys.
.It KB_JP | KB_SWAPCTRLCAPS
(
.Dq jp.swapctrlcaps
) Japanese mapping with swapped
.Dq Control
and
.Dq Caps Lock
keys.
.El
.Sh BUGS
The list of builtin mappings doesn't follow any logics.
It grew as people submitted what they needed.
.Sh SEE ALSO
.Xr isa 4 ,
.Xr wskbd 4 ,
.Xr wsconsctl 8

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

@ -0,0 +1,102 @@
.\" $NetBSD: vga.4,v 1.1 1999/03/22 19:15:01 drochner Exp $
.Dd March 20, 1999
.Os
.Dt VGA 4
.Sh NAME
.Nm vga
.Nd VGA graphics driver for wscons
.Sh SYNOPSIS
.Cd "vga0 at isa?"
.Cd "vga* at pci?"
.Cd "wsdisplay* at vga? console ?"
.Sh DESCRIPTION
This driver handles
.Tn VGA
graphics hardware within the
.Xr wscons 4
console framework. It doesn't provide direct device
driver entry points but makes its functions available via
the internal
.Xr wsdisplay 4
interface.
.Pp
The
.Nm
driver supports multiple virtual screens on one physical
display. The screens allocated on one display can be of different
.Dq types ,
where a type refers to various display properties. The type is
determined at the time the virtual screen is created and can't
be changed later. Screens are either created at kernel startup
(then the default type is used) or later with help of the
.Xr wsconscfg 8
utility.
.Pp
Currently, the following screen types are supported:
.Bl -hang
.It 80x25
This is the standard
.Tn VGA
text mode with 80 columns and 25 rows. 16 different colors
can be displayed at the same time. Characters are 8 x 16
Pixels large, and a font consists of 256 characters. A builtin
font of this size is always present on a
.Tn VGA
card. It's also possible to use a downloaded font instead.
.It 80x25bf
is a modified version of the previous. It only allows 8
colors to be displayed. In exchange, it can access two
fonts at the same time, so that 512 different characters
can be displayed.
.It 80x50
A text mode with 80 colums and 50 rows. Similar to the
standard mode, 16 colors and 256 characters are available.
Characters are 8 x 8 pixels large. For this mode to be useful,
a font of that character size must be downloaded.
.It 80x50bf
is analogously to
.Dq 80x25bf
a version with 512 displayable characters but 8 colors only.
.El
.Pp
The
.Nm
driver can display fonts of the original
.Tn IBM
type and ISO-8859-1 encoded fonts. As an experimental feature, the
.Dq higher half
fonts of the NetBSD/i386
.Xr pcvt 4
driver distribution can be used too if the kernel option
.Dq WSCONS_SUPPORT_PCVTFONTS
was set at compile time. This is only useful with the
.Dq *bf
screen types; a font containing the
.Tn ASCII
range of characters must be available too on this screen.
.Sh BUGS
Only a subset of the possible text modes is supported.
.Pp
.Tn VGA
cards are supposed to emulate an
.Tn MDA
if a monochrome display is connected. In this case, the
device will naturally not support colors at all, but
offer the capability to display underlined characters instead.
The
.Dq 80x25bf
and
.Dq 80x50bf
screen types will not be available. This mode of operation
is not tested.
.Sh SEE ALSO
.Xr isa 4 ,
.Xr pci 4 ,
.Xr wscons 4 ,
.Xr wsconscfg 8 ,
.Xr wsfontload 8

View File

@ -1,4 +1,4 @@
.\" $NetBSD: wscons.4,v 1.4 1999/02/03 21:27:02 augustss Exp $
.\" $NetBSD: wscons.4,v 1.5 1999/03/22 19:15:03 drochner Exp $
.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
@ -40,29 +40,17 @@
.Sh SYNOPSIS
.Cd "options WSEMUL_SUN"
.Cd "options WSEMUL_VT100"
.Cd options WSEMUL_NO_DUMB
.Cd options \&"WSEMUL_DEFAULT=\e"xxx\e""
.Cd "options WS_KERNEL_FG=WSCOL_XXX"
.Cd "options WSDISPLAY_COMPAT_PCVT"
.Cd "options WSDISPLAY_COMPAT_SYSCONS"
.Cd "options WSDISPLAY_COMPAT_USL"
.Cd "options WSDISPLAY_COMPAT_RAWKBD"
.Cd "options PCKBD_LAYOUT=XXX"
.Cd "pckbc0 at isa?"
.Cd "pckbd* at pckbc?"
.Cd "pms* at pckbc?"
.Cd "vga0 at isa?"
.Cd "vga* at pci?"
.Cd "pcdisplay0 at isa?"
.Cd "wsdisplay* at vga? console ?"
.Cd "wsdisplay* at pcdisplay? console ?"
.Cd "lms0 at isa? port 0x23c irq 5"
.Cd "mms0 at isa? port 0x23c irq 5"
.Cd "wskbd* at pckbd? console ?"
.Cd "wskbd* at ukbd? console ?"
.Cd "wsmouse* at pms?"
.Cd "wsmouse* at lms?"
.Cd "wsmouse* at mms?"
.Cd "wsmouse* at ums?"
.Cd wsdisplay* at ...
.Cd wskbd* at ...
.Cd wsmouse* at ...
.Pp
.Sh DESCRIPTION
The
@ -71,13 +59,9 @@ driver provides support for machine independent access to the console.
.Sh BUGS
This man page is extremely incomplete.
.Sh SEE ALSO
.Xr isa 4 ,
.Xr pci 4 ,
.Xr ukbd 4 ,
.Xr lms 4 ,
.Xr mms 4 ,
.Xr pms 4 ,
.Xr ums 4 ,
.Xr wsdisplay 4 ,
.Xr wskbd 4 ,
.Xr wsmouse 4 ,
.Xr wsconscfg 8 ,
.Xr wsconsctl 8 ,
.Xr wsfontload 8

109
share/man/man4/wsdisplay.4 Normal file
View File

@ -0,0 +1,109 @@
.\" $NetBSD: wsdisplay.4,v 1.1 1999/03/22 19:15:03 drochner Exp $
.Dd March 20, 1999
.Os
.Dt WSDISPLAY 4
.Sh NAME
.Nm wsdisplay
.Nd generic display device support in wscons
.Sh SYNOPSIS
.Cd wsdisplay* at vga? console ?
(VGA display on ISA or PCI)
.Cd wsdisplay* at pcdisplay? console ?
(generic PC (ISA) display)
.Cd wsdisplay* at tga? console ?
(DEC TGA display, alpha only)
.Cd wsdisplay* at pfb? console ?
(PCI framebuffer, bebox only)
.Cd wsdisplay0 at ofb? console ?
(Open Firmware framebuffer, macppc only)
.Cd wsdisplay* at nextdisplay? console ?
(NeXT display)
.Cd wsdisplay0 at smg0
(VAXstation small monochrome display)
.Cd options WSDISPLAY_DEFAULTSCREENS=N
.Sh DESCRIPTION
The
.Nm
driver is an abstraction layer for display devices within the
.Xr wscons 4
framework. It attaches to the hardware specific display device
driver and and makes it available as text terminal or graphics
interface.
.Pp
A display device can have the ability to display characters on it
(without help of an X server), either directly by hardware or through
software putting pixel data into the display memory.
Such displays are called
.Dq emulating ,
the
.Nm
driver will connect a terminal emulation module and provide a
tty-like software interface. In contrary, non-emulating displays can only
be used by special programs like X servers.
.Pp
The logical unit of an independant contents displayed on a display
(sometimes referred to as
.Dq virtual terminal
) is called a
.Dq screen
here. If the underlying device driver supports it, multiple screens can
be used on one display. (As of this writing, only the
.Xr vga 4
and the
.Tn VAX
.Dq smg
display drivers provide this ability.)
Screens have different minor device numbers and separate tty instances.
One screen posesses the
.Dq focus ,
this means it is displayed on the display and its tty device will get
the keyboard input. (In some cases - if no screen is set up or if a screen
was just deleted - it is possible that no focus is present at all.)
The focus can be switched by either special keyboard input (typically
CTL-ALT-Fn) or an ioctl command issued by a user program.
Screens are set up or deleted through the
.Pa /dev/ttyEcfg
control decice (preferrably using the
.Xr wsconscfg 8
utility). Alternatively, the compile-time option
.Cd WSDISPLAY_DEFAULTSCREENS=N
will set up N screens of the display driver's default type and using
the system's default terminal emulator at autoconfiguration time.
.Sh FILES
.Bl -item
.It
.Pa /dev/ttyE*
Terminal devices (per screen).
.It
.Pa /dev/ttyEcfg
Control device.
.It
.Pa /usr/include/dev/wscons/wsconsio.h
.El
.Sh BUGS
The
.Nm
code currently limits the number of screens on one display to 8.
.Pp
The terms
.Dq wscons
and
.Dq wsdisplay
are not cleanly distinguished in the code and in manual pages.
.Pp
.Dq non-emulating
display devices are not tested.
.Sh SEE ALSO
.Xr wscons 4 ,
.Xr wsconscfg 8 ,
.Xr wsconsctl 8 ,
.Xr wsloadfont 8 ,
.Xr vga 4 ,
.Xr pcdisplay 4 ,
.Xr tty 4

95
share/man/man4/wskbd.4 Normal file
View File

@ -0,0 +1,95 @@
.\" $NetBSD: wskbd.4,v 1.1 1999/03/22 19:15:02 drochner Exp $
.Dd March 20, 1999
.Os
.Dt WSKBD 4
.Sh NAME
.Nm wskbd
.Nd generic keyboard support in wscons
.Sh SYNOPSIS
.Cd "wskbd* at pckbd? console ?"
(standard PC keyboard)
.Cd "wskbd* at ukbd? console ?"
(USB keyboard)
.Cd "wskbd0 at akbd? console ?"
(Apple ADB keyboard)
.Cd "wskbd0 at nextkbd? console ?"
(NeXT keyboard)
.Sh DESCRIPTION
The
.Nm
driver handles common tasks for keyboards within the
.Xr wscons 4
framework. It is attached to the hardware specific keyboard drivers and
provides their connection to
.Dq wsdisplay
devices and a character device interface.
.Pp
The common keyboard support consists of:
.Bl -bullet
.It
Mapping from keycodes (defined by the specific keyboard driver) to
keysyms (hardware independant, defined in
.Pa /usr/include/dev/wscons/wsksymdef.h .
.It
Handling of
.Dq compose
sequences. Characters commonly not present as separate key on keyboards
can be generated after either a special
.Dq compose
key is pressed or a
.Dq dead accent
character is used.
.It
Automatic key repetition (
.Dq typematic
).
.It
Parameter handling for
.Dq keyboard bells .
.It
Generation of
.Dq keyboard events
for use by X servers.
.El
.Pp
The
.Nm
driver provides a number of ioctl functions to control key maps
and other parameters. These functions are accessible though the
associated
.Dq wsdisplay
device as well. A complete list is in
.Pa /usr/include/dev/wscons/wsconsio.h .
The
.Xr wsconsctl 8
utility allows to access key maps and other variables.
.Sh FILES
.Bl -item
.It
.Pa /dev/wskbd*
.It
.Pa /usr/include/dev/wscons/wsksymdef.h
.It
.Pa /usr/include/dev/wscons/wsconsio.h .
.El
.Sh BUGS
.Dq wskbd
devices are connected logically to
.Dq wsdisplay
devices at boot time. There is little support for hot insertion and
removal. It is not possible to feed a
.Dq wsdisplay
from multiple
.Dq wskbd
devices.
.Sh SEE ALSO
.Xr wscons 4 ,
.Xr wsconsctl 8 ,
.Xr pckbd 4 ,
.Xr ukbd 4

63
share/man/man4/wsmouse.4 Normal file
View File

@ -0,0 +1,63 @@
.\" $NetBSD: wsmouse.4,v 1.1 1999/03/22 19:15:03 drochner Exp $
.Dd March 20, 1999
.Os
.Dt WSMOUSE 4
.Sh NAME
.Nm wsmouse
.Nd generic mouse support in wscons
.Sh SYNOPSIS
.Cd "wsmouse* at pms?"
(PS/2 mouse)
.Cd "wsmouse* at pmsi?"
(
.Dq Intellimouse
-compatible wheel mouse with PS/2 interface)
.Cd "wsmouse* at ums?"
(USB mouse)
.Cd "wsmouse* at lms?"
(Logitech bus mouse, i386 only)
.Cd "wsmouse* at mms?"
(Microsoft InPort mouse, i386 only)
.Cd "wsmouse0 at ams?"
(Apple ADB mouse)
.Sh DESCRIPTION
The
.Nm
driver is an abstraction layer for mice within the
.Xr wscons 4
framework. It is attached to the hardware specific keyboard drivers and
provides a character device interface. For use with X servers,
.Dq mouse events
can be generated.
.Pp
The
.Nm
driver provides a number of ioctl functions to control
various parameters. A complete list is in
.Pa /usr/include/dev/wscons/wsconsio.h .
The
.Xr wsconsctl 8
utility gives access to these variables.
.Sh FILES
.Bl -item
.It
.Pa /dev/wsmouse*
.It
.Pa /usr/include/dev/wscons/wsconsio.h .
.El
.Sh BUGS
There is little support for hot insertion and
removal.
.Sh SEE ALSO
.Xr wscons 4 ,
.Xr wsconsctl 8 ,
.Xr pms 4 ,
.Xr lms 4 ,
.Xr mms 4 ,
.Xr ums 4