xref: /openbsd/share/man/man4/akbd.4 (revision 36153d3d)
1.\"
2.\" Copyright (c) 2001 Peter Philipp
3.\" Copyright (c) 1997 Colin Wood
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. 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.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"      This product includes software developed by Colin Wood
17.\"      for the NetBSD Project.
18.\" 4. The name of the author may not be used to endorse or promote products
19.\"    derived from this software without specific prior written permission
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31.\"
32.\"	$OpenBSD: akbd.4,v 1.6 2022/02/20 15:21:15 jsg Exp $
33.\"	$NetBSD: adb.4,v 1.1 1997/07/18 02:13:42 ender Exp $
34.\"
35.Dd $Mdocdate: February 20 2022 $
36.Dt AKBD 4
37.Os
38.Sh NAME
39.Nm akbd
40.Nd Apple Keyboard Device
41.Sh SYNOPSIS
42.Cd "akbd* at adb?"
43.Cd "wskbd* at akbd? mux 1"
44.Cd "option AKBD_LAYOUT=XXX"
45.Sh DESCRIPTION
46This driver supports ADB keyboards within the
47.Xr wscons 4
48console framework.
49It doesn't provide direct device driver entry points but makes its
50functions available via the internal
51.Xr wskbd 4
52interface.
53.Pp
54The following is a partial list of supported
55.Tn AKBD
56devices:
57.Bd -filled -offset indent
58.Bl -item -compact
59.It
60Apple Standard Keyboard
61.It
62Apple Extended Keyboard
63.It
64Apple Keyboard II
65.It
66Apple PowerBook Keyboard
67.It
68Apple Adjustable Keyboard
69.It
70Apple PowerBook extended Keyboard
71.It
72Apple PowerBook G3 Keyboard
73.It
74Apple PowerBook G4 Keyboard
75.It
76Apple iBook Keyboard
77.It
78.El
79.Ed
80.Pp
81The
82.Nm
83driver supports a number of different key mappings which
84can be chosen from with the kernel option
85.Dq AKBD_LAYOUT
86at compile time or with the utility
87.Xr wsconsctl 8
88(variable:
89.Dq keyboard.encoding )
90at runtime.
91Other mappings can be used if the whole keymap is replaced by means of
92.Xr wsconsctl 8 .
93The built-in mappings are at this time:
94.Pp
95.Bl -tag -width Ds -offset indent -compact
96.It KB_DE
97.Pq de
98German with
99.Dq dead accents .
100.It KB_ES
101.Pq es
102Spanish.
103.It KB_FR
104.Pq fr
105French.
106.It KB_JP
107.Pq jp
108Japanese.
109.It KB_PT
110.Pq pt
111Portuguese.
112.It KB_SF
113.Pq sf
114Swiss French with
115.Dq dead accents .
116.It KB_SG
117.Pq sg
118Swiss German with
119.Dq dead accents .
120.It KB_SV
121.Pq sv
122Swedish with
123.Dq dead accents .
124.It KB_UK
125.Pq uk
126British.
127.It KB_US
128.Pq us
129English/US keyboard mapping (default).
130.El
131.Pp
132The KB_DE, KB_FR, KB_SG and KB_SV mappings can be used in the KB_NODEAD
133.Pq .nodead
134variant.
135This switches off the
136.Dq dead accents .
137.Sh EXAMPLES
138To set a German keyboard layout without
139.Dq dead accents ,
140use
141.Ic wsconsctl keyboard.encoding=de.nodead .
142To set it at kernel build time, add
143the following to the kernel configuration file:
144.Bd -literal -offset indent
145option AKBD_LAYOUT="KB_DE|KB_NODEAD"
146.Ed
147.Sh SEE ALSO
148.Xr adb 4 ,
149.Xr intro 4 ,
150.Xr ukbd 4 ,
151.Xr wskbd 4 ,
152.Xr wsconsctl 8
153.Sh HISTORY
154The
155.Nm
156interface first appeared in
157.Nx 0.9 .
158It has been under development ever since.
159.Sh AUTHORS
160.An -nosplit
161.An Bradley A. Grantham
162wrote the original
163.Nm
164driver, including the MRG support.
165The hardware direct interface was written by
166.An John P. Wittkoski .
167.Sh BUGS
168The list of built-in mappings doesn't follow any logic.
169It grew as people submitted what they needed.
170