Add HTML entries for Korean layout keys
[keycodemapdb.git] / data / README
1 This directory contains the raw data for mapping between different
2 keyboard codes. Naming if often based on the US keyboard layout, but
3 does not indicate the symbol actually generated by the key.
4
5 The columns currently in this data set are:
6
7 Linux
8 -----
9
10 Name and value of the hardware independent keycodes used by the linux
11 kernel and exposed through the input subsystem.
12
13 References: linux/input.h
14
15 macOS
16 -----
17
18 Low level key codes as exposed by Mac OS X/macOS.
19
20 References: Carbon/HIToolbox/Events.h
21
22 PC scan code sets
23 -----------------
24
25 Scan codes for the three orignal PC keyboard generations:
26
27  Set 1: XT
28  Set 2: AT
29  Set 3: PS/2
30
31 The sets include codes for modern keys as well and not just the keys
32 present on those original keyboards.
33
34 References: linux/drivers/input/keyboard/atkbd.c
35
36 USB HID
37 -------
38
39 Codes as specified by the HID profile in USB.
40
41 References: linux/drivers/hid/usbhid/usbkbd.c
42
43 Windows Virtual-key codes
44 -------------------------
45
46 The low level, hardware independent "VKEYs" exposed by Windows.
47
48 References: mingw32/winuser.h
49
50 XWin XT
51 -------
52
53 X11 keycodes generated by the XWin server. Based on the XT scan code
54 set.
55
56 References: xorg-server/hw/xwin/{winkeybd.c,winkeynames.h}
57
58 Xfree86 KBD XT
59 --------------
60
61 X11 keycodes generated by the Xfree86 keyboard drivers. Based on the XT
62 scan code set.
63
64 References: xf86-input-keyboard/src/at_scancode.c
65
66 X11 keysyms
67 -----------
68
69 Corresponding X11 keysym value(s) for a US keyboard layout.
70
71 WARNING: These columns represent symbols, not physical keys, and should
72          be used with extreme care.
73
74 References: http://cgit.freedesktop.org/xorg/proto/x11proto/plain/keysymdef.h
75
76 HTML KeyboardEvent.code
77 -----------------------
78
79 Key codes seen in the KeyboardEvent.code attribute as part of the
80 UI Events specification.
81
82 References: https://www.w3.org/TR/uievents-code/
83
84 XKEYBOARD key names
85 -------------------
86
87 Hardware independent key names as used in the XKEYBOARD extension.
88
89 References: /usr/share/X11/xkb/keycodes/