140 lines
4.2 KiB
Groff
140 lines
4.2 KiB
Groff
.\" $XdotOrg: $
|
|
.\" $XFree86: xc/programs/Xserver/hw/xfree86/input/keyboard/keyboard.man,v 1.2 2001/01/27 18:20:57 dawes Exp $
|
|
.\" shorthand for double quote that works everywhere.
|
|
.ds q \N'34'
|
|
.TH KBD __drivermansuffix__ __vendorversion__
|
|
.SH NAME
|
|
kbd \- Keyboard input driver
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.B "Section \*qInputDevice\*q"
|
|
.BI " Identifier \*q" idevname \*q
|
|
.B " Driver \*qkbd\*q"
|
|
\ \ ...
|
|
.B EndSection
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.B kbd
|
|
is an __xservername__ 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
|
|
.B keyboard
|
|
driver formerly included in __xservername__.
|
|
.PP
|
|
The
|
|
.B kbd
|
|
driver functions as a keyboard input device, and may be used as the
|
|
X server's core keyboard.
|
|
.SH CONFIGURATION DETAILS
|
|
Please refer to __xconfigfile__(__filemansuffix__) 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.
|
|
.PP
|
|
The following driver
|
|
.B Options
|
|
are supported:
|
|
.TP 7
|
|
.BI "Option \*qDevice\*q \*q" string \*q
|
|
Specify the keyboard device. Default: the OS's default console keyboard
|
|
input source.
|
|
.TP 7
|
|
.BI "Option \*qProtocol\*q \*q" string \*q
|
|
Specify the keyboard protocol. Valid protocol types include:
|
|
.PP
|
|
.RS 12
|
|
Standard, Xqueue.
|
|
.RE
|
|
.PP
|
|
.RS 7
|
|
Not all protocols are supported on all platforms. Default: "Standard".
|
|
.RE
|
|
.TP 7
|
|
.BI "Option \*qAutoRepeat\*q \*q" "delay rate" \*q
|
|
sets the auto repeat behaviour for the keyboard. This is not implemented
|
|
on all platforms.
|
|
.I delay
|
|
is the time in milliseconds before a key starts repeating.
|
|
.I rate
|
|
is the number of times a key repeats per second. Default: "500 30".
|
|
.TP 7
|
|
.BI "Option \*qXLeds\*q \*q" ledlist \*q
|
|
makes the keyboard LEDs specified in
|
|
.I 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.
|
|
.TP 7
|
|
.BI "Option \*qXkbRules\*q \*q" rules \*q
|
|
specifies which XKB rules file to use for interpreting the
|
|
.BR XkbModel ,
|
|
.BR XkbLayout ,
|
|
.BR XkbVariant ,
|
|
and
|
|
.B XkbOptions
|
|
settings. Default: "xorg" for most platforms, but "xfree98" for the
|
|
Japanese PC-98 platforms. If you use the "xorg" value then you can
|
|
find listing of all valid values for these four options in the
|
|
.I
|
|
__xkb_path__/rules/xorg.lst
|
|
file.
|
|
.TP 7
|
|
.BI "Option \*qXkbModel\*q \*q" modelname \*q
|
|
specifies the XKB keyboard model name. Default: "pc105" for most platforms,
|
|
but "pc98" for the Japanese PC-98 platforms.
|
|
.TP 7
|
|
.BI "Option \*qXkbLayout\*q \*q" layoutname \*q
|
|
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.
|
|
.TP 7
|
|
.BI "Option \*qXkbVariant\*q \*q" variants \*q
|
|
specifies the XKB keyboard variant components. These can be used to
|
|
enhance the keyboard layout details. Default: not set.
|
|
.TP 7
|
|
.BI "Option \*qXkbOptions\*q \*q" options \*q
|
|
specifies the XKB keyboard option components. These can be used to
|
|
enhance the keyboard behaviour. Default: not set.
|
|
.PP
|
|
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.
|
|
.SH EXAMPLE
|
|
The following xorg.conf fragment ensures that user will be able to switch between
|
|
.I us
|
|
and
|
|
.I sk
|
|
layouts by pressing the "menu" key.
|
|
.PP
|
|
The
|
|
.B XkbVariant
|
|
option defines which variants of the two layouts should be used. In case of the
|
|
.I us
|
|
layout
|
|
its default variant is used. In case of the
|
|
.I sk
|
|
layout
|
|
its
|
|
.I qwerty
|
|
variant is used.
|
|
.PP
|
|
.nf
|
|
.RS 4
|
|
Section \*qInputDevice\*q
|
|
.RS 4
|
|
Identifier "Generic Keyboard"
|
|
Driver "kbd"
|
|
Option "CoreKeyboard"
|
|
Option "XkbRules" "xorg"
|
|
Option "XkbModel" "pc105"
|
|
Option "XkbLayout" "us,sk"
|
|
Option "XkbVariant" ",qwerty"
|
|
Option "XkbOptions" "grp:menu_toggle,grp_led:scroll"
|
|
.RE
|
|
EndSection
|
|
.RE
|
|
.fi
|
|
.SH "SEE ALSO"
|
|
__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__),
|
|
xorgconfig(__appmansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__).
|