xref: /netbsd-src/share/man/man4/pckbd.4 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.\" $NetBSD: pckbd.4,v 1.21 2011/08/02 10:04:07 wiz 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 July 22, 2011
28.Dt PCKBD 4
29.Os
30.Sh NAME
31.Nm pckbd
32.Nd PC keyboard driver for wscons
33.Sh SYNOPSIS
34.Cd pckbc* at isa?
35.Cd pckbd* at pckbc?
36.Cd "wskbd* at pckbd? console ?"
37.Cd options PCKBD_LAYOUT=XXX
38.Sh DESCRIPTION
39This driver supports PC/AT keyboards within the
40.Xr wscons 4
41console framework.
42It doesn't provide direct device driver entry points but makes its
43functions available via the internal
44.Xr wskbd 4
45interface.
46.Pp
47The
48.Nm
49driver supports a number of different key mappings which
50can be chosen from with the kernel option
51.Li PCKBD_LAYOUT
52at compile time or with the utility
53.Xr wsconsctl 8
54(variable:
55.Dq encoding )
56at runtime.
57Other mappings can be used if the whole keymap is replaced by means of
58.Xr wsconsctl 8 .
59The builtin mappings are at this time:
60.Bl -column " KB_US|KB_COLEMAK" "wsconsctl" "language"
61.It Sy "option" Ta Sy "wsconsctl" Ta Sy "language"
62.It Li KB_US Ta us Ta English/US keyboard mapping (default)
63.It Li KB_UK Ta uk Ta English/UK keyboard mapping
64.It Li KB_BE Ta be Ta Belgian
65.It Li KB_CZ Ta cz Ta Czech (QWERTY)
66.It Li KB_DK Ta dk Ta Danish with
67.Dq dead accents
68.It Li KB_NL Ta nl Ta Dutch
69.It Li KB_FI Ta fi Ta Finnish
70.It Li KB_FR Ta fr Ta French
71.It Li KB_DE Ta de Ta German with
72.Dq dead accents
73.It Li KB_GR Ta gr Ta Greek
74.It Li KB_HU Ta hu Ta Hungarian
75.It Li KB_IT Ta it Ta Italian
76.It Li KB_JP Ta jp Ta Japanese
77.It Li KB_NO Ta no Ta Norwegian with
78.Dq dead accents
79.It Li KB_PL Ta pl Ta Polish
80.It Li KB_PT Ta pt Ta Portuguese
81.It Li KB_RU Ta ru Ta Russian
82.It Li KB_ES Ta es Ta Spanish
83.It Li KB_SV Ta sv Ta Swedish with
84.Dq dead accents
85.It Li KB_SF Ta sf Ta Swiss French
86.It Li KB_SG Ta sg Ta Swiss German
87.It Li KB_UA Ta ua Ta Ukrainian
88.It Li "KB_US|KB_DECLK" Ta \&us.declk Ta English/US mapping for Tn DEC
89.It Ta Ta LK400-style keyboards with PC keyboard
90.It Ta Ta interface (e.g., LK461)
91.It Li "KB_US|KB_DVORAK" Ta us.dvorak Ta English/US keyboard with
92.It Ta Ta Do Dvorak Dc layout
93.It Li "KB_US|KB_COLEMAK" Ta us.colemak Ta English/US keyboard with
94.It Ta Ta Do Colemak Dc layout
95.El
96.Pp
97The
98.Li KB_DE ,
99.Li KB_DK ,
100.Li KB_NO
101and
102.Li KB_SV
103mappings can be used in the
104.Li KB_NODEAD (
105.Dq .nodead )
106variant.
107This switches off the
108.Dq dead accents .
109.Pp
110The
111.Li KB_US ,
112.Li KB_JP
113and
114.Li KB_US|KB_DVORAK
115mappings can be modified
116to swap the left CTRL and the CAPS LOCK keys by the
117.Li KB_SWAPCTRLCAPS
118variant bit or the
119.Dq .swapctrlcaps
120suffix.
121.Pp
122The
123.Li KB_METAESC (
124.Dq .metaesc )
125option can be applied to any layout.
126If set, keys pressed together
127with the ALT modifier are prefixed by an ESC character.
128(Standard behaviour is to add 128 to the ASCII value.)
129.Pp
130Because PC keyboard hardware doesn't contain a beeper, requests for
131.Dq keyboard beeps
132cannot be handled directly.
133On alpha and i386 a helper device attached
134to the
135.Xr pcppi 4
136driver allows the use of the standard ISA speaker for this purpose.
137On acorn32,
138.Xr vidcaudio 4
139performs this function.
140.Sh EXAMPLES
141To set a German keyboard layout without
142.Dq dead accents
143and sending an ESC character before the key symbol if the ALT
144key is pressed simultaneously, use
145.Ic wsconsctl Fl w Ar encoding=de.nodead.metaesc .
146To set it at kernel build time, add
147.D1 Cd options PCKBD_LAYOUT="(KB_DE | KB_NODEAD | KB_METAESC)"
148to the kernel configuration file.
149.Sh SEE ALSO
150.Xr isa 4 ,
151.Xr pcppi 4 ,
152.Xr wskbd 4 ,
153.Xr wsconsctl 8
154.Sh BUGS
155The list of builtin mappings doesn't follow any logic.
156It grew as people submitted what they needed.
157