man/kbd.man

   1 .\" shorthand for double quote that works everywhere.
   2 .ds q \N'34'
   3 .TH KBD __drivermansuffix__ __vendorversion__
   4 .SH NAME
   5 kbd \- Keyboard input driver
   6 .SH SYNOPSIS
   7 .nf
   8 .B "Section \*qInputDevice\*q"
   9 .BI "  Identifier \*q" idevname \*q
  10 .B  "  Driver \*qkbd\*q"
  11 \ \ ...
  12 .B EndSection
  13 .fi
  14 .SH DESCRIPTION
  15 .B kbd
  16 is an __xservername__ input driver for keyboards.  The driver supports the standard
  17 OS-provided keyboard interface, but these are currently only available to
  18 this driver module for Linux, BSD, and Solaris.  This driver is the
  19 replacement for the built-in
  20 .B keyboard
  21 driver formerly included in __xservername__.
  22 .PP
  23 The
  24 .B kbd
  25 driver functions as a keyboard input device.
  26 .SH CONFIGURATION DETAILS
  27 .PP
  28 Depending on the X server version in use, input device options may be set
  29 in either a __xconfigfile__ file, an xorg.conf.d snippet, or in the
  30 configuration files read by the Hardware Abstraction Layer (HAL) daemon,
  31 hald(1).
  32 .PP
  33 Please refer to __xconfigfile__(__filemansuffix__) for general configuration
  34 details and for options that can be used with all input drivers.  This
  35 section only covers configuration details specific to this driver.
  36 .PP
  37 The following driver
  38 .B Options
  39 are supported:
  40 .TP 7
  41 .BI "Option \*qDevice\*q \*q" string \*q
  42 Specify the keyboard device.  Default: the OS's default console keyboard
  43 input source.
  44 .TP 7
  45 .BI "Option \*qProtocol\*q \*q" string \*q
  46 Specify the keyboard protocol.  Valid protocol types include:
  47 .PP
  48 .RS 12
  49 Standard, Xqueue.
  50 .RE
  51 .PP
  52 .RS 7
  53 Not all protocols are supported on all platforms.  Default: "Standard".
  54 .RE
  55 .TP 7
  56 .BI "Option \*qXLeds\*q \*q" ledlist \*q
  57 makes the keyboard LEDs specified in
  58 .I ledlist
  59 available for client use instead of their traditional function
  60 (Scroll Lock, Caps Lock and Num Lock).  The numbers in the list are
  61 in the range 1 to 3.  Default: empty list.
  62 .TP 7
  63 .BI "Option \*qXkbRules\*q \*q" rules \*q
  64 specifies which XKB rules file to use for interpreting the
  65 .BR XkbModel ,
  66 .BR XkbLayout ,
  67 .BR XkbVariant ,
  68 and
  69 .B XkbOptions
  70 settings.  Default: "xorg" for most platforms, but "xfree98" for the
  71 Japanese PC-98 platforms. If you use the "xorg" value then you can
  72 find listing of all valid values for these four options in the
  73 .I
  74 __xkb_path__/rules/xorg.lst
  75 file.
  76 .TP 7
  77 .BI "Option \*qXkbModel\*q \*q" modelname \*q
  78 specifies the XKB keyboard model name.  Default: "pc105" for most platforms,
  79 but "pc98" for the Japanese PC-98 platforms.
  80 .TP 7
  81 .BI "Option \*qXkbLayout\*q \*q" layoutname \*q
  82 specifies the XKB keyboard layout name.  This is usually the country or
  83 language type of the keyboard.  Default: "us" for most platforms, but
  84 "jp" for the Japanese PC-98 platforms.
  85 .TP 7
  86 .BI "Option \*qXkbVariant\*q \*q" variants \*q
  87 specifies the XKB keyboard variant components.  These can be used to
  88 enhance the keyboard layout details.  Default: not set.
  89 .TP 7
  90 .BI "Option \*qXkbOptions\*q \*q" options \*q
  91 specifies the XKB keyboard option components.  These can be used to
  92 enhance the keyboard behaviour.  Default: not set.
  93 .SH EXAMPLE
  94 The following xorg.conf fragment ensures that user will be able to switch between
  95 .I us
  96 and
  97 .I sk
  98 layouts by pressing the "menu" key. The scroll lock LED shows which layout
  99 is currently active.
 100 .PP
 101 The
 102 .B XkbVariant
 103 option defines which variants of the two layouts should be used. In case of the
 104 .I us
 105 layout
 106 its default variant is used. In case of the
 107 .I sk
 108 layout
 109 its
 110 .I qwerty
 111 variant is used.
 112 .PP
 113 .nf
 114 .RS 4
 115 Section \*qInputDevice\*q
 116 .RS 4
 117 Identifier   "Generic Keyboard"
 118 Driver       "kbd"
 119 Option       "CoreKeyboard"
 120 Option       "XkbRules"      "xorg"
 121 Option       "XkbModel"      "pc105"
 122 Option       "XkbLayout"     "us,sk"
 123 Option       "XkbVariant"    ",qwerty"
 124 Option       "XkbOptions"    "grp:menu_toggle,grp_led:scroll"
 125 .RE
 126 EndSection
 127 .RE
 128 .fi
 129 .SH "SEE ALSO"
 130 __xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__),
 131 Xserver(__appmansuffix__), X(__miscmansuffix__).
 132
 133 hal(__miscmansuffix__), hald(__adminmansuffix__), fdi(__filemansuffix__).