share/man/man4/wskbd.4

   1 .\" $NetBSD: wskbd.4,v 1.12 2006/10/31 22:01:09 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 October 31, 2006
  28 .Dt WSKBD 4
  29 .Os
  30 .Sh NAME
  31 .Nm wskbd
  32 .Nd generic keyboard support in wscons
  33 .Sh SYNOPSIS
  34 .Cd "wskbd* at pckbd? console ? mux 1"
  35 (standard PC keyboard)
  36 .Cd "wskbd* at ukbd? console ? mux 1"
  37 (USB keyboard)
  38 .Cd "wskbd* at lkkbd? console ? mux 1"
  39 (DEC LK200/400 serial keyboard)
  40 .Cd "wskbd0 at akbd? console ? mux 1"
  41 (Apple ADB keyboard)
  42 .Cd "wskbd0 at nextkbd? console ? mux 1"
  43 (NeXT keyboard)
  44 .Cd "wskbd* at vrkiu? console ? mux 1"
  45 (NEC VR4000 series HPC keyboard)
  46 .Cd "wskbd* at skbd? console ? mux 1"
  47 (keyboard of misc hpcmips handheld devices)
  48 .Cd "wskbd* at btkbd? console ? mux 1"
  49 (Bluetooth keyboard)
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver handles common tasks for keyboards within the
  54 .Xr wscons 4
  55 framework. It is attached to the hardware specific keyboard drivers and
  56 provides their connection to
  57 .Dq wsdisplay
  58 devices and a character device interface.
  59 .Pp
  60 The common keyboard support consists of:
  61 .Bl -bullet
  62 .It
  63 Mapping from keycodes (defined by the specific keyboard driver) to
  64 keysyms (hardware independent, defined in
  65 .Pa /usr/include/dev/wscons/wsksymdef.h ) .
  66 .It
  67 Handling of
  68 .Dq compose
  69 sequences. Characters commonly not present as separate key on keyboards
  70 can be generated after either a special
  71 .Dq compose
  72 key is pressed or a
  73 .Dq dead accent
  74 character is used.
  75 .It
  76 Certain translations, like turning an
  77 .Dq ALT
  78 modifier into an
  79 .Dq ESC
  80 prefix.
  81 .It
  82 Automatic key repetition
  83 .Pq Dq typematic .
  84 .It
  85 Parameter handling for
  86 .Dq keyboard bells .
  87 .It
  88 Generation of
  89 .Dq keyboard events
  90 for use by X servers.
  91 .El
  92 .Pp
  93 The
  94 .Nm
  95 driver provides a number of ioctl functions to control key maps
  96 and other parameters. These functions are accessible though the
  97 associated
  98 .Dq wsdisplay
  99 device as well. A complete list is in
 100 .Pa /usr/include/dev/wscons/wsconsio.h .
 101 The
 102 .Xr wsconsctl 8
 103 utility allows to access key maps and other variables.
 104 .Pp
 105 The
 106 .Em console
 107 locator in the configuration line refers to the device's use as input
 108 part of the operating system console. A device specification containing
 109 a positive value here will only match if the device is in use as system
 110 console. (The console device selection in early system startup is not
 111 influenced.) This way, the console device can be connected to a known
 112 wskbd device instance.
 113 .Sh FILES
 114 .Bl -item
 115 .It
 116 .Pa /dev/wskbd*
 117 .It
 118 .Pa /usr/include/dev/wscons/wsksymdef.h
 119 .It
 120 .Pa /usr/include/dev/wscons/wsconsio.h .
 121 .El
 122 .Sh SEE ALSO
 123 .Xr btkbd 4 ,
 124 .Xr pckbd 4 ,
 125 .Xr ukbd 4 ,
 126 .Xr wscons 4 ,
 127 .Xr wsmux 4 ,
 128 .Xr wsconsctl 8 ,
 129 .Xr wskbd 9