1 .\" Copyright (c) 1997, 1998
2 .\" Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $FreeBSD: head/share/man/man4/ukbd.4 204739 2010-03-04 22:06:57Z joel $
32 .Nd USB keyboard driver
34 To compile this driver into the kernel,
35 place the following line in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
41 Alternatively, to load the driver as a
42 module at boot time, place the following line in
44 .Bd -literal -offset indent
50 driver provides support for keyboards that attach to the USB port.
56 must be configured in the kernel as well.
58 By default, the keyboard subsystem will create the appropriate devices.
59 To disable this, remove or comment out the following option in the kernel
62 .Dl Cd "options KBD_INSTALL_CDEV"
64 If both an AT keyboard USB keyboards are used at the same time, the
65 AT keyboard will appear as
69 The USB keyboards will be
72 You can see some information about the keyboard with the following command:
74 .Dl "kbdcontrol -i < /dev/kbd1"
78 .Dl "kbdcontrol -l keymaps/pt.iso < /dev/kbd1"
82 for more possible options.
84 You can swap console keyboards by using the command
86 .Dl "kbdcontrol -k /dev/kbd1"
88 From this point on, the first USB keyboard will be the keyboard
89 to be used by the console.
91 If you want to use a USB keyboard as your default and not use an AT keyboard at
92 all, you will have to remove the
94 line from the kernel configuration file.
95 Because of the device initialization order,
96 the USB keyboard will be detected
99 initializes itself and you have to explicitly tell the console
100 driver to use the existence of the USB keyboard.
102 one of the following two ways.
104 Run the following command as a part of system initialization:
106 .Dl "kbdcontrol -k /dev/kbd0 < /dev/ttyv0 > /dev/null"
108 (Note that as the USB keyboard is the only keyboard, it is accessed as
110 or otherwise tell the console driver to periodically look for a
111 keyboard by setting a flag in the kernel configuration file:
113 .Dl "device sc0 at isa? flags 0x100"
115 With the above flag, the console driver will try to detect any
116 keyboard in the system if it did not detect one while it was
117 initialized at boot time.
118 .Sh DRIVER CONFIGURATION
119 .D1 Cd "options KBD_INSTALL_CDEV"
121 Make the keyboards available through a character device in
124 .D1 Cd options UKBD_DFLT_KEYMAP
125 .D1 Cd makeoptions UKBD_DFLT_KEYMAP=fr.iso
127 The above lines will put the French ISO keymap in the ukbd driver.
128 You can specify any keymap in
129 .Pa /usr/share/syscons/keymaps
132 .D1 Cd "options KBD_DISABLE_KEYMAP_LOAD"
134 Do not allow the user to change the keymap.
135 Note that these options also affect the AT keyboard driver,
138 .Bl -tag -width ".Pa /dev/kbd*" -compact
140 blocking device nodes
147 driver to the kernel.
158 driver was written by
159 .An Lennart Augustsson Aq Mt augustss@cs.chalmers.se
162 and was substantially rewritten for
165 .An Kazutaka YOKOTA Aq Mt yokota@zodiac.mech.utsunomiya-u.ac.jp .
167 This manual page was written by
168 .An Nick Hibma Aq Mt n_hibma@FreeBSD.org
169 with a large amount of input from
170 .An Kazutaka YOKOTA Aq Mt yokota@zodiac.mech.utsunomiya-u.ac.jp .