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.3 2005/05/07 17:38:33 swildner 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
  50 .Xr syscons 4
  51 console driver.
  52 .Pp
  53 There can be only one
  54 .Nm
  55 device defined in the kernel configuration file.  This device also
  56 requires the
  57 .Nm atkbdc
  58 keyboard controller to be present.
  59 The
  60 .Em irq
  61 number must always be 1; there is no provision of changing the number.
  62 .Ss Function Keys
  63 The AT keyboard has a number of function keys.
  64 They are numbered as follows and can be associated with strings
  65 by the
  66 .Xr kbdcontrol 1
  67 command.
  68 .Pp
  69 .Bl -tag -width "Function Key Number" -compact
  70 .It "Function Key number"
  71 Function Key
  72 .It "1, 2,...12"
  73 F1, F2,... F12
  74 .It "13, 14,...24"
  75 Shift+F1, Shift+F2,... Shift+F12
  76 .It "25, 26,...36"
  77 Ctl+F1, Ctl+F2,... Ctl+F12
  78 .It "37, 38,...48"
  79 Shift+Ctl+F1, Shift+Ctl+F2,... Shift+Ctl+F12
  80 .It 49
  81 Home and Numpad 7 (without NumLock)
  82 .It 50
  83 Up Arrow and Numpad 8 (without NumLock)
  84 .It 51
  85 Page Up and Numpad 9 (without NumLock)
  86 .It 52
  87 Numpad -
  88 .It 53
  89 Left Arrow and Numpad 4 (without NumLock)
  90 .It 54
  91 Numpad 5 (without NumLock)
  92 .It 55
  93 Right Arrow and Numpad 6 (without NumLock)
  94 .It 56
  95 Numpad +
  96 .It 57
  97 End and Numpad 1 (without NumLock)
  98 .It 58
  99 Down Arrow and Numpad 2 (without NumLock)
 100 .It 59
 101 Page Down and Numpad 3 (without NumLock)
 102 .It 60
 103 Ins and Numpad 0 (without NumLock)
 104 .It 61
 105 Del
 106 .It 62
 107 Left GUI Key
 108 .It 63
 109 Right GUI Key
 110 .It 64
 111 Menu
 112 .El
 113 .Pp
 114 See the man page for the
 115 .Xr kbdcontrol 1
 116 command for how to assign a string to the function key.
 117 .Sh DRIVER CONFIGURATION
 118 .Ss Kernel Configuration Options
 119 The following kernel configuration options control the
 120 .Nm
 121 driver.
 122 .Bl -tag -width ATKBD_DFLT
 123 .It Em ATKBD_DFLT_KEYMAP
 124 This option sets the defauilt, built-in keymap of the
 125 .Nm
 126 driver to the named keymap.
 127 See
 128 .Sx EXAMPLES
 129 below.
 130 .It Em KBD_DISABLE_KEYMAP_LOAD
 131 The keymap can be modified by the
 132 .Xr kbdcontrol 1
 133 command.
 134 This option will disable this feature and prevent the user from
 135 changing key assignment.
 136 .El
 137 .Pp
 138 .Ss Driver Flags
 139 The
 140 .Nm
 141 driver accepts the following driver flags.  They can be set either in the
 142 kernel configuration file
 143 (see
 144 .Xr config 8 ) ,
 145 or else in the User Configuration Menu at boot time
 146 (see
 147 .Xr boot 8 ) .
 148 .Bl -tag -width FAIL
 149 .It bit 0 (FAIL_IF_NO_KBD)
 150 By default the
 151 .Nm
 152 driver will install even if a keyboard is not actually connected to the
 153 system.
 154 This option prevents the driver from being installed in this situation.
 155 .It bit 1 (NO_RESET)
 156 When this option is given, the
 157 .Nm
 158 driver will not reset the keyboard when initializing it.
 159 It may be useful for laptop computers whose function keys
 160 have special functions and these functions are forgotten when the
 161 keyboard is reset.
 162 .It bit 2 (ALT_SCANCODESET)
 163 Certain keyboards, such as those on some ThinkPad models, behave
 164 like the old XT keyboard and require this option.
 165 .El
 166 .\".Sh FILES
 167 .Sh EXAMPLES
 168 The
 169 .Nm
 170 driver requires the keyboard controller
 171 .Nm atkbdc .
 172 Thus, the kernel configuration file should contain the following lines.
 173 .Pp
 174 .Dl "device atkbdc0 at isa"
 175 .Dl "device atkbd0 at atkbdc? irq 1"
 176 .Pp
 177 The following example shows how to set the default, built-in keymap
 178 to
 179 .Pa jp.106.kbd .
 180 .Pp
 181 .Dl "options ATKBD_DFLT_KEYMAP"
 182 .Dl "makeoptions ATKBD_DFLT_KEYMAP=jp.106"
 183 .Dl "device atkbd0 at atkbdc? irq 1"
 184 .Pp
 185 .\".Sh DIAGNOSTICS
 186 .\".Sh CAVEATS
 187 .\".Sh BUGS
 188 .Sh SEE ALSO
 189 .Xr kbdcontrol 1 ,
 190 .Xr atkbdc 4 ,
 191 .Xr psm 4 ,
 192 .Xr syscons 4 ,
 193 .Xr boot 8 ,
 194 .Xr config 8
 195 .Sh HISTORY
 196 The
 197 .Nm
 198 driver first appeared in
 199 .Fx 3.1 .
 200 .Sh AUTHORS
 201 .An -nosplit
 202 The
 203 .Nm
 204 driver was written by
 205 .An S\(/oren Schmidt Aq sos@FreeBSD.org
 206 and
 207 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
 208 This manual page was written by
 209 .An Kazutaka Yokota .