Table of Contents

Name

keyboard - Keyboard input driver

Synopsis


Section "InputDevice"
  Identifier "idevname"
  Driver "keyboard"
  ...
EndSection

Description

keyboard is an Xorg input driver for keyboards. The driver supports the standard OS-provided keyboard interface.

The keyboard driver functions as a keyboard input device, and may be used as the X server's core keyboard.

This driver is built-in to the core X server, and multiple instances are not supported. A loadable driver, kbd, is available, and is planned to replace the keyboard driver in a future release of the Xorg server.

Configuration Details

Please refer to xorg.conf(5x) for general configuration details and for options that can be used with all input drivers. This section only covers configuration details specific to this driver.

The following driver Options are supported:

Option "Protocol" "string"
Specify the keyboard protocol. Valid protocol types include:

Standard, Xqueue.

Not all protocols are supported on all platforms. Default: "Standard".
Option "AutoRepeat" "delay rate"
sets the auto repeat behaviour for the keyboard. This is not implemented on all platforms. delay is the time in milliseconds before a key starts repeating. rate is the number of times a key repeats per second. Default: "500 30".
Option "XLeds" "ledlist"
makes the keyboard LEDs specified in ledlist available for client use instead of their traditional function (Scroll Lock, Caps Lock and Num Lock). The numbers in the list are in the range 1 to 3. Default: empty list.
Option "XkbDisable" "boolean"
disable/enable the XKEYBOARD extension. The -kb command line option overrides this config file option. Default: XKB is enabled.

NOTE: This option should be specified in the ServerFlags section rather than here. It's use here is deprecated.
Option "XkbRules" "rules"
specifies which XKB rules file to use for interpreting the XkbModel, XkbLayout, XkbVariant, and XkbOptions settings. Default: "xorg" for most platforms, but "xfree98" for the Japanese PC-98 platforms.
Option "XkbModel" "modelname"
specifies the XKB keyboard model name. Default: "pc105" for most platforms, but "pc98" for the Japanese PC-98 platforms.
Option "XkbLayout" "layoutname"
specifies the XKB keyboard layout name. This is usually the country or language type of the keyboard. Default: "us" for most platforms, but "nec/jp" for the Japanese PC-98 platforms.
Option "XkbVariant" "variants"
specifies the XKB keyboard variant components. These can be used to enhance the keyboard layout details. Default: not set.
Option "XkbOptions" "options"
specifies the XKB keyboard option components. These can be used to enhance the keyboard behaviour. Default: not set.

Some other XKB-related options are available, but they are incompatible with the ones listed above and are not recommended, so they are not documented here.

See Also

kbd(4) , Xorg(1x) , xorg.conf(5x) , xorgconfig(1x) , Xserver(1x) , X(7) .

Table of Contents