xref: /openbsd-src/share/man/man4/hilkbd.4 (revision 49f728ab4f63e763e7f8bf81b8f95d8914d13507)
1.\"	$OpenBSD: hilkbd.4,v 1.13 2011/01/30 07:53:57 jmc Exp $
2.\"
3.\" Copyright (c) 2003 Miodrag Vallat.
4.\" 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. Redistribution 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 ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\"
27.Dd $Mdocdate: January 30 2011 $
28.Dt HILKBD 4
29.Os
30.Sh NAME
31.Nm hilkbd
32.Nd HIL keyboard device
33.Sh SYNOPSIS
34.Cd "hilkbd* at hil?"
35.Cd "wskbd* at hilkbd?"
36.Cd "option HILKBD_LAYOUT=XXX"
37.Sh DESCRIPTION
38This driver supports HIL keyboards within the
39.Xr wscons 4
40framework.
41It doesn't provide direct device driver entry points, but makes its
42functions available through the internal
43.Xr wskbd 4
44interface.
45.Pp
46The
47.Nm
48driver supports a number of different key mappings.
49By default, the layout corresponding to the keyboard model as probed
50by the
51.Nm
52driver will be used.
53A different layout can be chosen either with the kernel option
54.Dq HILKBD_LAYOUT
55at compile time, or with the
56.Xr wsconsctl 8
57utility (variable:
58.Dq keyboard.encoding )
59at runtime.
60.Pp
61The supported key mappings are at this time:
62.Pp
63.Bl -tag -width Ds -offset indent -compact
64.It KB_DE
65.Pq de
66German with
67.Dq dead accents .
68.It KB_FR
69.Pq fr
70French with
71.Dq dead accents .
72.It KB_SV
73.Pq sv
74Swedish.
75.It KB_UK
76.Pq uk
77British.
78.It KB_US
79.Pq us
80English/US keyboard mapping.
81.El
82.Pp
83The KB_DE mapping can be used in the KB_NODEAD
84.Pq .nodead
85variant.
86This switches off the
87.Dq dead accents .
88.Sh EXAMPLES
89To set a Swedish keyboard mapping, use
90.Ic wsconsctl keyboard.encoding=sv .
91To set it at kernel build time, regardless of what keyboard is plugged, add
92the following to the kernel configuration file:
93.Bd -literal -offset indent
94option HILKBD_LAYOUT="KB_SV"
95.Ed
96.Sh SEE ALSO
97.Xr hil 4 ,
98.Xr intro 4 ,
99.Xr wskbd 4 ,
100.Xr wsconsctl 8
101.Sh BUGS
102The list of built-in mappings is incomplete and has grown as people submitted
103information about their particular layout.
104.Pp
105The Swedish and British layout have been reconstructed from tables in the old
106HIL code present in the hp300 port, and have not been tested.
107