xref: /netbsd-src/share/man/man4/wskbd.4 (revision de1dfb1250df962f1ff3a011772cf58e605aed11)
1.\" $NetBSD: wskbd.4,v 1.10 2003/02/17 20:07:06 drochner Exp $
2.\"
3.\" Copyright (c) 1999
4.\" 	Matthias Drochner.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd March 20, 1999
28.Os
29.Dt WSKBD 4
30.Sh NAME
31.Nm wskbd
32.Nd generic keyboard support in wscons
33.Sh SYNOPSIS
34.Cd "wskbd* at pckbd? console ? mux 1"
35(standard PC keyboard)
36.Cd "wskbd* at ukbd? console ? mux 1"
37(USB keyboard)
38.Cd "wskbd* at lkkbd? console ? mux 1"
39(DEC LK200/400 serial keyboard)
40.Cd "wskbd0 at akbd? console ? mux 1"
41(Apple ADB keyboard)
42.Cd "wskbd0 at nextkbd? console ? mux 1"
43(NeXT keyboard)
44.Cd "wskbd* at vrkiu? console ? mux 1"
45(NEC VR4000 series HPC keyboard)
46.Cd "wskbd* at skbd? console ? mux 1"
47(keyboard of misc hpcmips handheld devices)
48.Sh DESCRIPTION
49The
50.Nm
51driver handles common tasks for keyboards within the
52.Xr wscons 4
53framework. It is attached to the hardware specific keyboard drivers and
54provides their connection to
55.Dq wsdisplay
56devices and a character device interface.
57.Pp
58The common keyboard support consists of:
59.Bl -bullet
60.It
61Mapping from keycodes (defined by the specific keyboard driver) to
62keysyms (hardware independent, defined in
63.Pa /usr/include/dev/wscons/wsksymdef.h ) .
64.It
65Handling of
66.Dq compose
67sequences. Characters commonly not present as separate key on keyboards
68can be generated after either a special
69.Dq compose
70key is pressed or a
71.Dq dead accent
72character is used.
73.It
74Certain translations, like turning an
75.Dq ALT
76modifier into an
77.Dq ESC
78prefix.
79.It
80Automatic key repetition
81.Pq Dq typematic .
82.It
83Parameter handling for
84.Dq keyboard bells .
85.It
86Generation of
87.Dq keyboard events
88for use by X servers.
89.El
90.Pp
91The
92.Nm
93driver provides a number of ioctl functions to control key maps
94and other parameters. These functions are accessible though the
95associated
96.Dq wsdisplay
97device as well. A complete list is in
98.Pa /usr/include/dev/wscons/wsconsio.h .
99The
100.Xr wsconsctl 8
101utility allows to access key maps and other variables.
102.Pp
103The
104.Em console
105locator in the configuration line refers to the device's use as input
106part of the operating system console. A device specification containing
107a positive value here will only match if the device is in use as system
108console. (The console device selection in early system startup is not
109influenced.) This way, the console device can be connected to a known
110wskbd device instance.
111.Sh FILES
112.Bl -item
113.It
114.Pa /dev/wskbd*
115.It
116.Pa /usr/include/dev/wscons/wsksymdef.h
117.It
118.Pa /usr/include/dev/wscons/wsconsio.h .
119.El
120.Sh SEE ALSO
121.Xr pckbd 4 ,
122.Xr ukbd 4 ,
123.Xr wscons 4 ,
124.Xr wsmux 4 ,
125.Xr wsconsctl 8 ,
126.Xr wskbd 9
127