Go to main content

man pages section 4: Device and Network Interfaces

Exit Print View

Updated: Wednesday, July 27, 2022

kbd (4)


kbd - Keyboard input driver


Section "InputDevice"
Identifier "idevname"
Driver "kbd"


KBD(4)                     Kernel Interfaces Manual                     KBD(4)

       kbd - Keyboard input driver

       Section "InputDevice"
         Identifier "idevname"
         Driver "kbd"

       kbd  is  an  Xorg  input driver for keyboards.  The driver supports the
       standard OS-provided keyboard interface, but these are  currently  only
       available  to  this  driver  module  for Linux, BSD, and Solaris.  This
       driver is the replacement for the  built-in  keyboard  driver  formerly
       included in Xorg.

       The kbd driver functions as a keyboard input device.

       Depending  on  the X server version in use, input device options may be
       set in either a xorg.conf file, an xorg.conf.d snippet, or in the  con-
       figuration  files  read by the Hardware Abstraction Layer (HAL) daemon,

       Please refer to xorg.conf(5) 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 "Device" "string"
              Specify the keyboard device.  Default: the OS's default  console
              keyboard input source.  Property: "Device Node" (read-only).

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

                   Standard, Xqueue.

              Not  all  protocols  are  supported  on all platforms.  Default:

       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 "XkbRules" "rules"
              specifies  which XKB rules file to use for interpreting the Xkb-
              Model, XkbLayout, XkbVariant, and XkbOptions settings.  Default:
              "base" for most platforms.  If you use the "base" value then you
              can find listing of all valid values for these four  options  in
              the /usr/share/X11/xkb/rules/base.lst file.

       Option "XkbModel" "modelname"
              specifies  the  XKB  keyboard  model name.  Default: "pc105" for
              most 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.

       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.

       For a list of available XKB options, see xkeyboard-config(7).

       The following xorg.conf fragment ensures that  user  will  be  able  to
       switch between us and sk layouts by pressing the "menu" key. The scroll
       lock LED shows which layout is currently active.

       The XkbVariant option defines which variants of the two layouts  should
       be  used. In case of the us layout its default variant is used. In case
       of the sk layout its qwerty variant is used.

           Section "InputDevice"
               Identifier   "Generic Keyboard"
               Driver       "kbd"
               Option       "CoreKeyboard"
               Option       "XkbRules"      "base"
               Option       "XkbModel"      "pc105"
               Option       "XkbLayout"     "us,sk"
               Option       "XkbVariant"    ",qwerty"
               Option       "XkbOptions"    "grp:menu_toggle,grp_led:scroll"

       See attributes(7) for descriptions of the following attributes:

       |ATTRIBUTE TYPE |              ATTRIBUTE VALUE               |
       |Availability   | x11/server/xorg/driver/xorg-input-keyboard |
       |Stability      | Volatile                                   |

       Xorg(1), xorg.conf(5), Xserver(1), X(7).

       hal(7), hald(8), fdi(5).


       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from    https://www.x.org/releases/individ-

       Further information about this software can be found on the open source
       community website at https://www.x.org.

X Version 11               xf86-input-keyboard 1.9.0                    KBD(4)