Module Name: src
Committed By: uwe
Date: Tue Jan 21 16:03:33 UTC 2025
Modified Files:
src/share/man/man4: akbd.4
Log Message:
akbd(4): markup fixes, editorial tweaks from nat@
To generate a diff of this commit:
cvs rdiff -u -r1.3 -r1.4 src/share/man/man4/akbd.4
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man4/akbd.4
diff -u src/share/man/man4/akbd.4:1.3 src/share/man/man4/akbd.4:1.4
--- src/share/man/man4/akbd.4:1.3 Mon Jan 20 16:06:01 2025
+++ src/share/man/man4/akbd.4 Tue Jan 21 16:03:32 2025
@@ -1,4 +1,4 @@
-.\" $NetBSD: akbd.4,v 1.3 2025/01/20 16:06:01 nat Exp $
+.\" $NetBSD: akbd.4,v 1.4 2025/01/21 16:03:32 uwe Exp $
.\"
.\" Copyright (c) 2003 Alex Zepeda <[email protected]>
.\" All rights reserved.
@@ -31,7 +31,9 @@
.Dd January 20, 2025
.Dt AKBD 4
.Os
+.
.Sh NAME
+.
.Nm akbd
.Nd Apple Desktop Bus keyboard driver for wscons
.Sh SYNOPSIS
@@ -41,52 +43,101 @@
.Cd "options ALTXBUTTONS"
.Cd "options CAPS_IS_CONTROL"
.Cd "options FORCE_FUNCTION_KEYS"
+.
.Sh DESCRIPTION
+.
This driver provides the
.Xr wscons 4
driver with support for Apple Desktop Bus keyboards.
+.Bl -tag -width Cd
+.
+.It Cd "options ALTXBUTTONS"
+.
+To map
+.Sm off
+.Ao Option Ac \&+ Aq 1 ,
+.Sm on
+.Sm off
+.Ao Option Ac \&+ Aq 2 ,
+.Sm on
+.Sm off
+.Ao Option Ac \&+ Aq 3 ,
+.Sm on
+to mouse buttons 1, 2, and 3
+respectively.
+.
+.It Cd options CAPS_IS_CONTROL
+.
+On macppc systems it is possible to tweak the keyboard driver to treat
+the caps lock key on an
+.Tn ADB
+keyboard as a control key.
+This requires special remapping because of
+.Tn ADB Ap s
+strange emulation of a mechanically-locked key.
+.
+.It Cd options FORCE_FUNCTION_KEYS
+.
+On macppc PowerBooks, several function keys double as
+.Dq hot keys
+.Pq brightness, volume, eject
+when the
+.Aq \&Fn
+modifier is held down.
+Mac OS\~X likes to reprogram the keyboard controller to send hot key
+events when
+.Aq \&Fn
+is
+.Em not
+held down and send function key events when it is.
+With this option you can transform the non-keyboard
+.Dq button
+events back into function key events.
+.El
+.
+.Ss Special Keys
+.
+To work around the limited number of buttons found on most
+.Tn ADB
+mice, the following key sequences trigger mouse button events:
.Pp
-To work around the limited number of buttons found on most ADB mice,
-one can map key sequences to trigger mouse button events.
-.Bl
-.It
-Option+LeftArrow will work as the middle mouse button.
+.Bl -dash -compact
.It
-Option+RightArrow will work as the right mouse button.
+.Sm off
+.Ao Option Ac \&+ Aq LeftArrow
+.Sm on
+will work as the middle mouse button.
+.It
+.Sm off
+.Ao Option Ac \&+ Aq RightArrow
+.Sm on
+will work as the right mouse button.
.El
.Pp
-To map Option+1, Option+2, Option+3 to mouse buttons 1, 2, and 3
-respectively, add the following line to your kernel configuration
-file:
+On PowerBook (mac68k) models the following key sequences are also
+significant:
.Pp
-.Cd "options ALTXBUTTONS"
-.Pp
-On macppc systems it is possible to tweak the keyboard driver
-to treat the caps lock key on an ADB keyboard as a control key.
-This requires special remapping because of ADB's strange emulation of
-a mechanically-locked key. To enable this code add the following
-line to your kernel configuration file:
-.Pp
-.Cd options CAPS_IS_CONTROL
-.Pp
-On macppc PowerBooks, several function keys double as "hot keys"
-(brightness, volume, eject) when the Fn modifier is held down.
-Mac OS X likes to reprogram the keyboard controller to send hot key
-events when Fn is not held down and send function key events when it
-is.
-To transform the non-keyboard "button" events back into function key
-events, place the following line in your kernel configuration file:
-.Pp
-.Cd options FORCE_FUNCTION_KEYS
-.Pp
-On PowerBook (mac68k) models holding Option and up/down arrows change the screen
-brightness.
-.Sh SUPPORTED HARDWARE
+.Bl -dash -compact
+.It
+.Sm off
+.Ao Option Ac \&+ Aq UpArrow
+.Sm on
+increase screen brightness.
+.It
+.Sm off
+.Ao Option Ac \&+ Aq DownArrow
+.Sm on
+decrease screen brightness.
+.El
+.
+.Ss Supported Hardware
+.
.Nx
is known to support the following
.Tn ADB
keyboards:
-.Bl -bullet -offset indent
+.Pp
+.Bl -bullet -offset indent -compact
.It
On-board keyboards on PowerBook models
.It
@@ -100,15 +151,21 @@ Apple Extended Keyboard II
.It
Apple Adjustable Keyboard
.It
-Most third-party ADB keyboards are supported
+Most third-party
+.Tn ADB
+keyboards are supported
.El
+.
.Sh SEE ALSO
+.
+.Xr xmodmap 1 ,
.Xr adb 4 ,
.Xr wscons 4 ,
.Xr wskbd 4 ,
-.Xr wsconsctl 8 ,
-.Xr xmodmap 1
+.Xr wsconsctl 8
+.
.Sh BUGS
+.
The number pad on extended keyboards does not send out the proper
key codes for many applications.
.Pp
@@ -116,12 +173,17 @@ The LEDs on extended keyboards are not f
.Nx .
.Pp
In X11 with the default key mapping, middle and right mouse button events will
-hold Meta_L and this will clobber the intended mouse button.
-.Pp
-Meta_L shoud be remapped with
+hold
+.Ql Meta_L
+and this will clobber the intended mouse button.
+.Aq Option
+shoud be remapped with
.Xr xmodmap 1
-to the Command Key ie:
-.Pp
-.Dl remove Mod4 = Super_L
-.Dl remove Mod1 = Alt_L
-.Dl add Mod1 = Super_L
+to the
+.Aq Command
+key:
+.Bd -literal -offset indent
+remove Mod4 = Super_L
+remove Mod1 = Alt_L
+add Mod1 = Super_L
+.Ed
