diff options
Diffstat (limited to 'static/freebsd/man4/ukbd.4 3.html')
| -rw-r--r-- | static/freebsd/man4/ukbd.4 3.html | 174 |
1 files changed, 174 insertions, 0 deletions
diff --git a/static/freebsd/man4/ukbd.4 3.html b/static/freebsd/man4/ukbd.4 3.html new file mode 100644 index 00000000..e1346353 --- /dev/null +++ b/static/freebsd/man4/ukbd.4 3.html @@ -0,0 +1,174 @@ +<table class="head"> + <tr> + <td class="head-ltitle">UKBD(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">UKBD(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">ukbd</code> — <span class="Nd">USB + keyboard driver</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp">To compile this driver into the kernel, place the following line + in your kernel configuration file:</p> +<div class="Bd Pp Bd-indent"><code class="Cd">device ukbd</code> +<br/> +<code class="Cd">device hid</code> +<br/> +<code class="Cd">device usb</code></div> +<p class="Pp">Alternatively, to load the driver as a module at boot time, place + the following line in <a class="Xr">loader.conf(5)</a>:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ukbd_load="YES"</pre> +</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">ukbd</code> driver provides support for + keyboards that attach to the USB port. <a class="Xr">usb(4)</a> and one of + <a class="Xr">uhci(4)</a> or <a class="Xr">ohci(4)</a> must be configured in + the kernel as well.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="CONFIGURATION"><a class="permalink" href="#CONFIGURATION">CONFIGURATION</a></h1> +<p class="Pp">By default, the keyboard subsystem does not create the appropriate + devices yet. Make sure you reconfigure your kernel with the following option + in the kernel config file:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">options KBD_INSTALL_CDEV</code></div> +<p class="Pp">If both an AT keyboard USB keyboards are used at the same time, + the AT keyboard will appear as <span class="Pa">kbd0</span> in + <span class="Pa">/dev</span>. The USB keyboards will be + <span class="Pa">kbd1</span>, <span class="Pa">kbd2</span>, etc. You can see + some information about the keyboard with the following command:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">kbdcontrol -i < + /dev/kbd1</code></div> +<p class="Pp">or load a keymap with</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">kbdcontrol -l keymaps/pt.iso < + /dev/kbd1</code></div> +<p class="Pp">See <a class="Xr">kbdcontrol(1)</a> for more possible options.</p> +<p class="Pp">You can swap console keyboards by using the command</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">kbdcontrol -k /dev/kbd1</code></div> +<p class="Pp">From this point on, the first USB keyboard will be the keyboard to + be used by the console.</p> +<p class="Pp" id="after">If you want to use a USB keyboard as your default and + not use an AT keyboard at all, you will have to remove the + <code class="Cd">device atkbd</code> line from the kernel configuration + file. Because of the device initialization order, the USB keyboard will be + detected <a class="permalink" href="#after"><i class="Em">after</i></a> the + console driver initializes itself and you have to explicitly tell the + console driver to use the existence of the USB keyboard. This can be done in + one of the following two ways.</p> +<p class="Pp">Run the following command as a part of system initialization:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">kbdcontrol -k /dev/kbd0 < + /dev/ttyv0 > /dev/null</code></div> +<p class="Pp">(Note that as the USB keyboard is the only keyboard, it is + accessed as <span class="Pa">/dev/kbd0</span>) or otherwise tell the console + driver to periodically look for a keyboard by setting a flag in the kernel + configuration file:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">device sc0 at isa? flags + 0x100</code></div> +<p class="Pp">With the above flag, the console driver will try to detect any + keyboard in the system if it did not detect one while it was initialized at + boot time.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DRIVER_CONFIGURATION"><a class="permalink" href="#DRIVER_CONFIGURATION">DRIVER + CONFIGURATION</a></h1> +<div class="Bd Bd-indent"><code class="Cd">options KBD_INSTALL_CDEV</code></div> +<p class="Pp">Make the keyboards available through a character device in + <span class="Pa">/dev</span>.</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Cd">options UKBD_DFLT_KEYMAP</code></div> +<div class="Bd Bd-indent"><code class="Cd">makeoptions + UKBD_DFLT_KEYMAP=fr.iso</code></div> +<p class="Pp">The above lines will put the French ISO keymap in the ukbd driver. + You can specify any keymap in + <span class="Pa">/usr/share/syscons/keymaps</span> or + <span class="Pa">/usr/share/vt/keymaps</span> (depending on the console + driver being used) with this option.</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Cd">options + KBD_DISABLE_KEYMAP_LOADING</code></div> +<p class="Pp">Do not allow the user to change the keymap.</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Cd">options KBD_DELAY1=200</code></div> +<p class="Pp">Set the keyboard initial key repeat delay.</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Cd">options KBD_DELAY2=15</code></div> +<p class="Pp">Set the keyboard key repeat delay.</p> +<p class="Pp">Note that these options also affect the AT keyboard driver, + <a class="Xr">atkbd(4)</a>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL + VARIABLES</a></h1> +<p class="Pp">The following variables are available as both + <a class="Xr">sysctl(8)</a> variables and <a class="Xr">loader(8)</a> + tunables:</p> +<dl class="Bl-tag"> + <dt id="hw.usb.ukbd.debug"><var class="Va">hw.usb.ukbd.debug</var></dt> + <dd>Debug output level, where 0 is debugging disabled and larger values + increase debug message verbosity. Default is 0.</dd> + <dt id="hw.usb.ukbd.apple_swap_cmd_opt"><var class="Va">hw.usb.ukbd.apple_swap_cmd_opt</var></dt> + <dd>Swap the Command & Option keys on Apple keyboards if set to 1. Default + is 0.</dd> + <dt id="hw.usb.ukbd.apple_swap_cmd_ctl"><var class="Va">hw.usb.ukbd.apple_swap_cmd_ctl</var></dt> + <dd>Swap the Command & Control keys on Apple keyboards if set to 1. + Default is 0.</dd> + <dt id="hw.usb.ukbd.apple_fn_mode"><var class="Va">hw.usb.ukbd.apple_fn_mode</var></dt> + <dd>Direct access to media keys without holding Fn if set to 1. Default is + 0.</dd> + <dt id="hw.usb.ukbd.no_leds"><var class="Va">hw.usb.ukbd.no_leds</var></dt> + <dd>Disables setting of keyboard LEDs if set to 1. Default is 0.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> +<dl class="Bl-tag Bl-compact"> + <dt><span class="Pa">/dev/kbd*</span></dt> + <dd>blocking device nodes</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> +<div class="Bd Bd-indent"><code class="Cd">device ukbd</code></div> +<p class="Pp">Add the <code class="Nm">ukbd</code> driver to the kernel.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">kbdcontrol(1)</a>, <a class="Xr">ohci(4)</a>, + <a class="Xr">syscons(4)</a>, <a class="Xr">uhci(4)</a>, + <a class="Xr">usb(4)</a>, <a class="Xr">vt(4)</a>, + <a class="Xr">config(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp">The <code class="Nm">ukbd</code> driver was written by + <span class="An">Lennart Augustsson</span> + <<a class="Mt" href="mailto:augustss@cs.chalmers.se">augustss@cs.chalmers.se</a>> + for <span class="Ux">NetBSD</span> and was substantially rewritten for + <span class="Ux">FreeBSD</span> by <span class="An">Kazutaka YOKOTA</span> + <<a class="Mt" href="mailto:yokota@zodiac.mech.utsunomiya-u.ac.jp">yokota@zodiac.mech.utsunomiya-u.ac.jp</a>>.</p> +<p class="Pp">This manual page was written by <span class="An">Nick Hibma</span> + <<a class="Mt" href="mailto:n_hibma@FreeBSD.org">n_hibma@FreeBSD.org</a>> + with a large amount of input from <span class="An">Kazutaka YOKOTA</span> + <<a class="Mt" href="mailto:yokota@zodiac.mech.utsunomiya-u.ac.jp">yokota@zodiac.mech.utsunomiya-u.ac.jp</a>>.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">April 23, 2026</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |