Imported Upstream version 2.0.90
[platform/upstream/kbd.git] / docs / man / man1 / kbdinfo.1
1 .TH KBDINFO "1" "June 2019" "kbdinfo from kbd 2.0.4" "User Commands"
2 .SH NAME
3 kbdinfo \- read information about keyboard state
4 .SH SYNOPSIS
5 .B kbdinfo
6 [\fI\,options\/\fR] \fI\,getmode \/\fR[\fI\,text|graphics\/\fR]
7 .br
8 .B kbdinfo
9 [\fI\,options\/\fR] \fI\,gkbmode \/\fR[\fI\,raw|xlate|mediumraw|unicode\/\fR]
10 .br
11 .B kbdinfo
12 [\fI\,options\/\fR] \fI\,gkbmeta \/\fR[\fI\,metabit|escprefix\/\fR]
13 .br
14 .B kbdinfo
15 [\fI\,options\/\fR] \fI\,gkbled  \/\fR[\fI\,scrolllock|numlock|capslock\/\fR]
16 .SH DESCRIPTION
17 The utility allows you to read and check various parameters of the keyboard and
18 virtual console.
19 .TP 9
20 .B getmode
21 Get or check virtual console mode.
22 .TP 9
23 .B gkbmode
24 Gets current keyboard mode.
25 .LP
26 .RS
27 .TP 12
28 .B raw
29 Raw (scancode) mode. These are the raw codes generated by the keyboard.
30 .TP 12
31 .B mediumraw
32 Medium raw (scancode) mode. This is extended medium raw mode, with keys above
33 127 encoded as 0, high 7 bits, low 7 bits, with the 0 bearing the 'up' flag if
34 needed. 0 is reserved, so this shouldn't interfere with anything else. The two
35 bytes after 0 will always have the up flag set not to interfere with older
36 applications. This allows for 16384 different keycodes, which should be enough.
37 .TP 12
38 .B xlate
39 Translate keycodes using keymap. These are the codes generated via the current
40 keysym mapping.
41 .TP 12
42 .B unicode
43 Unicode mode.
44 .RE
45 .LP
46 .TP 9
47 .B gkbmeta
48 Gets meta key handling mode.
49 .LP
50 .RS
51 .TP 12
52 .B escprefix
53 Specifies if pressing the meta (alt) key generates an ESC (\\033) prefix followed by the keysym.
54 .TP 12
55 .B metabit
56 The keysym marked with the high bit set.
57 .RE
58 .LP
59
60 .TP 9
61 .B gkbled
62 Get keyboard flags CapsLock, NumLock, ScrollLock (not lights).
63 .LP
64 .RS
65 .TP 12
66 .B scrolllock
67 The scroll lock is down.
68 .TP 12
69 .B numlock
70 The num lock is down.
71 .TP 12
72 .B capslock
73 The caps lock is down.
74 .RE
75 .LP
76 .SH OPTIONS
77 .TP
78 \fB\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR
79 the console device to be used;
80 .TP
81 \fB\-V\fR, \fB\-\-version\fR
82 print version number;
83 .TP
84 \fB\-h\fR, \fB\-\-help\fR
85 print this usage message.
86 .SH AUTHORS
87 Written by Alexey Gladkov.
88 .SH "SEE ALSO"
89 .BR kbdrate (1),
90 .BR setleds (1),
91 .BR kbd_mode (1)