share/man/man4/atkbd.4

   1 .\"
   2 .\" Copyright (c) 1999
   3 .\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
   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 as
  11 .\"    the first lines of this file unmodified.
  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 ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man4/atkbd.4,v 1.12.2.5 2001/08/17 13:08:36 ru Exp $
  28 .\" $DragonFly: src/share/man/man4/atkbd.4,v 1.2 2003/06/17 04:36:58 dillon Exp $
  29 .\"
  30 .Dd May 21, 1999
  31 .Dt ATKBD 4
  32 .Os
  33 .Sh NAME
  34 .Nm atkbd
  35 .Nd the AT keyboard interface
  36 .Sh SYNOPSIS
  37 .Cd "options ATKBD_DFLT_KEYMAP"
  38 .Cd "makeoptions ATKBD_DFLT_KEYMAP=_keymap_name_"
  39 .Cd "options KBD_DISABLE_KEYMAP_LOAD"
  40 .Cd "device atkbd0 at atkbdc? irq 1"
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver, together with the
  45 .Nm atkbdc
  46 driver, provides access to the AT 84 keyboard or the AT enhanced keyboard
  47 which is connected to the AT keyboard controller.
  48 .Pp
  49 This driver is required for the console drivers
  50 .Xr syscons 4
  51 and
  52 .Xr pcvt 4 .
  53 .Pp
  54 There can be only one
  55 .Nm
  56 device defined in the kernel configuration file.  This device also
  57 requires the
  58 .Nm atkbdc
  59 keyboard controller to be present.
  60 The
  61 .Em irq
  62 number must always be 1; there is no provision of changing the number.
  63 .Ss Function Keys
  64 The AT keyboard has a number of function keys.
  65 They are numbered as follows and can be associated with strings
  66 by the
  67 .Xr kbdcontrol 1
  68 command.
  69 .Pp
  70 .Bl -tag -width "Function Key Number" -compact
  71 .It "Function Key number"
  72 Function Key
  73 .It "1, 2,...12"
  74 F1, F2,... F12
  75 .It "13, 14,...24"
  76 Shift+F1, Shift+F2,... Shift+F12
  77 .It "25, 26,...36"
  78 Ctl+F1, Ctl+F2,... Ctl+F12
  79 .It "37, 38,...48"
  80 Shift+Ctl+F1, Shift+Ctl+F2,... Shift+Ctl+F12
  81 .It 49
  82 Home and Numpad 7 (without NumLock)
  83 .It 50
  84 Up Arrow and Numpad 8 (without NumLock)
  85 .It 51
  86 Page Up and Numpad 9 (without NumLock)
  87 .It 52
  88 Numpad -
  89 .It 53
  90 Left Arrow and Numpad 4 (without NumLock)
  91 .It 54
  92 Numpad 5 (without NumLock)
  93 .It 55
  94 Right Arrow and Numpad 6 (without NumLock)
  95 .It 56
  96 Numpad +
  97 .It 57
  98 End and Numpad 1 (without NumLock)
  99 .It 58
 100 Down Arrow and Numpad 2 (without NumLock)
 101 .It 59
 102 Page Down and Numpad 3 (without NumLock)
 103 .It 60
 104 Ins and Numpad 0 (without NumLock)
 105 .It 61
 106 Del
 107 .It 62
 108 Left GUI Key
 109 .It 63
 110 Right GUI Key
 111 .It 64
 112 Menu
 113 .El
 114 .Pp
 115 See the man page for the
 116 .Xr kbdcontrol 1
 117 command for how to assign a string to the function key.
 118 .Sh DRIVER CONFIGURATION
 119 .Ss Kernel Configuration Options
 120 The following kernel configuration options control the
 121 .Nm
 122 driver.
 123 .Bl -tag -width ATKBD_DFLT
 124 .It Em ATKBD_DFLT_KEYMAP
 125 This option sets the defauilt, built-in keymap of the
 126 .Nm
 127 driver to the named keymap.
 128 See
 129 .Sx EXAMPLES
 130 below.
 131 .It Em KBD_DISABLE_KEYMAP_LOAD
 132 The keymap can be modified by the
 133 .Xr kbdcontrol 1
 134 command.
 135 This option will disable this feature and prevent the user from
 136 changing key assignment.
 137 .El
 138 .Pp
 139 .Ss Driver Flags
 140 The
 141 .Nm
 142 driver accepts the following driver flags.  They can be set either in the
 143 kernel configuration file
 144 (see
 145 .Xr config 8 ) ,
 146 or else in the User Configuration Menu at boot time
 147 (see
 148 .Xr boot 8 ) .
 149 .Bl -tag -width FAIL
 150 .It bit 0 (FAIL_IF_NO_KBD)
 151 By default the
 152 .Nm
 153 driver will install even if a keyboard is not actually connected to the
 154 system.
 155 This option prevents the driver from being installed in this situation.
 156 .It bit 1 (NO_RESET)
 157 When this option is given, the
 158 .Nm
 159 driver will not reset the keyboard when initializing it.
 160 It may be useful for laptop computers whose function keys
 161 have special functions and these functions are forgotten when the
 162 keyboard is reset.
 163 .It bit 2 (ALT_SCANCODESET)
 164 Certain keyboards, such as those on some ThinkPad models, behave
 165 like the old XT keyboard and require this option.
 166 .El
 167 .\".Sh FILES
 168 .Sh EXAMPLES
 169 The
 170 .Nm
 171 driver requires the keyboard controller
 172 .Nm atkbdc .
 173 Thus, the kernel configuration file should contain the following lines.
 174 .Pp
 175 .Dl "device atkbdc0 at isa"
 176 .Dl "device atkbd0 at atkbdc? irq 1"
 177 .Pp
 178 The following example shows how to set the default, built-in keymap
 179 to
 180 .Pa jp.106.kbd .
 181 .Pp
 182 .Dl "options ATKBD_DFLT_KEYMAP"
 183 .Dl "makeoptions ATKBD_DFLT_KEYMAP=jp.106"
 184 .Dl "device atkbd0 at atkbdc? irq 1"
 185 .Pp
 186 .\".Sh DIAGNOSTICS
 187 .\".Sh CAVEATS
 188 .\".Sh BUGS
 189 .Sh SEE ALSO
 190 .Xr kbdcontrol 1 ,
 191 .Xr atkbdc 4 ,
 192 .Xr pcvt 4 ,
 193 .Xr psm 4 ,
 194 .Xr syscons 4 ,
 195 .Xr boot 8 ,
 196 .Xr config 8
 197 .Sh HISTORY
 198 The
 199 .Nm
 200 driver first appeared in
 201 .Fx 3.1 .
 202 .Sh AUTHORS
 203 .An -nosplit
 204 The
 205 .Nm
 206 driver was written by
 207 .An S\(/oren Schmidt Aq sos@FreeBSD.org
 208 and
 209 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
 210 This manual page was written by
 211 .An Kazutaka Yokota .