1.\" $OpenBSD: wskbd.4,v 1.21 2008/07/16 16:32:06 miod Exp $ 2.\" $NetBSD: wskbd.4,v 1.5 2000/03/20 11:51:59 pk Exp $ 3.\" 4.\" Copyright (c) 1999 5.\" Matthias Drochner. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.Dd $Mdocdate: July 16 2008 $ 29.Dt WSKBD 4 30.Os 31.Sh NAME 32.Nm wskbd 33.Nd generic keyboard support in wscons 34.Sh SYNOPSIS 35.Cd "wskbd* at ..." 36.Sh DESCRIPTION 37The 38.Nm 39driver handles common tasks for keyboards within the 40.Xr wscons 4 41framework. 42It is attached to the hardware specific keyboard drivers and 43provides their connection to 44.Dq wsdisplay 45devices and a character device interface. 46.Pp 47The common keyboard support consists of: 48.Bl -bullet 49.It 50Mapping from keycodes (defined by the specific keyboard driver) to 51keysyms (hardware independent, defined in 52.Pa /usr/include/dev/wscons/wsksymdef.h ) . 53.It 54Handling of 55.Dq compose 56sequences. 57Characters commonly not present as separate keys on keyboards 58can be generated after either a special 59.Dq compose 60key is pressed or a 61.Dq dead accent 62character is used. 63.It 64Certain translations, like turning an 65.Dq ALT 66modifier into an 67.Dq ESC 68prefix. 69.It 70Automatic key repetition 71.Pf ( Dq typematic ) . 72.It 73Parameter handling for 74.Dq keyboard bells . 75.It 76Generation of 77.Dq keyboard events 78for use by X servers. 79.El 80.Pp 81The 82.Nm 83driver provides a number of ioctl functions to control key maps 84and other parameters. 85These functions are accessible through the associated 86.Dq wsdisplay 87device as well. 88A complete list is in 89.Pa /usr/include/dev/wscons/wsconsio.h . 90The 91.Xr wsconsctl 8 92utility allows access to key maps and other variables. 93.Pp 94The 95.Em console 96locator in the configuration line refers to the device's use as input 97part of the operating system console. 98A device specification containing a positive value here will only match 99if the device is in use as system console. 100(The console device selection in early system startup is not influenced.) 101This way, the console device can be connected to a known 102.Nm wskbd 103device instance. 104.Pp 105The 106.Nm 107driver traps certain key sequences intended to perform special functions. 108The 109.Cm Ctrl+Alt+Esc 110sequence will initiate the 111.Xr ddb 4 112kernel debugger if the 113.Dq ddb.console 114.Xr sysctl 8 115variable is set. 116When attached to a 117.Xr wsdisplay 4 118device, 119.Cm Ctrl+Alt+Fx 120switches virtual terminals and the 121.Cm Shift+PgUp 122and 123.Cm Shift+PgDn 124combinations provide scrollback functionality if the underlying hardware 125driver supports it. 126When audio devices are supported, keys 127.Cm Mute , 128.Cm VolumeUp 129and 130.Cm VolumeDown 131tweak mixer settings. 132.Sh FILES 133.Bl -tag -width /usr/include/dev/wscons/wsksymdef.h -compact 134.It Pa /dev/wskbd* 135.It Pa /usr/include/dev/wscons/wsksymdef.h 136.It Pa /usr/include/dev/wscons/wsconsio.h 137.El 138.Sh SEE ALSO 139.Xr akbd 4 , 140.Xr comkbd 4 , 141.Xr dnkbd 4 , 142.Xr hilkbd 4 , 143.Xr intro 4 , 144.Xr lkkbd 4 , 145.Xr pckbd 4 , 146.Xr ukbd 4 , 147.Xr wscons 4 , 148.Xr wsmux 4 , 149.Xr zkbd 4 , 150.Xr zrc 4 , 151.Xr zskbd 4 , 152.Xr wsconsctl 8 153