diff options
Diffstat (limited to 'docs/keycodes_basic.md')
-rw-r--r-- | docs/keycodes_basic.md | 297 |
1 files changed, 160 insertions, 137 deletions
diff --git a/docs/keycodes_basic.md b/docs/keycodes_basic.md index c6ca4ad99..8445b05ef 100644 --- a/docs/keycodes_basic.md +++ b/docs/keycodes_basic.md | |||
@@ -47,117 +47,145 @@ The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07 | |||
47 | 47 | ||
48 | |Key |Description| | 48 | |Key |Description| |
49 | |--------|-----------| | 49 | |--------|-----------| |
50 | |`KC_F1` | | | 50 | |`KC_F1` |F1 | |
51 | |`KC_F2` | | | 51 | |`KC_F2` |F2 | |
52 | |`KC_F3` | | | 52 | |`KC_F3` |F3 | |
53 | |`KC_F4` | | | 53 | |`KC_F4` |F4 | |
54 | |`KC_F5` | | | 54 | |`KC_F5` |F5 | |
55 | |`KC_F6` | | | 55 | |`KC_F6` |F6 | |
56 | |`KC_F7` | | | 56 | |`KC_F7` |F7 | |
57 | |`KC_F8` | | | 57 | |`KC_F8` |F8 | |
58 | |`KC_F9` | | | 58 | |`KC_F9` |F9 | |
59 | |`KC_F10`| | | 59 | |`KC_F10`|F10 | |
60 | |`KC_F11`| | | 60 | |`KC_F11`|F11 | |
61 | |`KC_F12`| | | 61 | |`KC_F12`|F12 | |
62 | |`KC_F13`| | | 62 | |`KC_F13`|F13 | |
63 | |`KC_F14`| | | 63 | |`KC_F14`|F14 | |
64 | |`KC_F15`| | | 64 | |`KC_F15`|F15 | |
65 | |`KC_F16`| | | 65 | |`KC_F16`|F16 | |
66 | |`KC_F17`| | | 66 | |`KC_F17`|F17 | |
67 | |`KC_F18`| | | 67 | |`KC_F18`|F18 | |
68 | |`KC_F19`| | | 68 | |`KC_F19`|F19 | |
69 | |`KC_F20`| | | 69 | |`KC_F20`|F20 | |
70 | |`KC_F21`| | | 70 | |`KC_F21`|F21 | |
71 | |`KC_F22`| | | 71 | |`KC_F22`|F22 | |
72 | |`KC_F23`| | | 72 | |`KC_F23`|F23 | |
73 | |`KC_F24`| | | 73 | |`KC_F24`|F24 | |
74 | 74 | ||
75 | ## Punctuation | 75 | ## Punctuation |
76 | 76 | ||
77 | |Key |Aliases |Description | | 77 | |Key |Aliases |Description | |
78 | |-----------------|---------|----------------------------------| | 78 | |-----------------|-------------------|-----------------------------------------------| |
79 | |`KC_ENTER` |`KC_ENT` |Return (Enter) | | 79 | |`KC_ENTER` |`KC_ENT` |Return (Enter) | |
80 | |`KC_ESCAPE` |`KC_ESC` |Escape | | 80 | |`KC_ESCAPE` |`KC_ESC` |Escape | |
81 | |`KC_BSPACE` |`KC_BSPC`|Delete (Backspace) | | 81 | |`KC_BSPACE` |`KC_BSPC` |Delete (Backspace) | |
82 | |`KC_TAB` | |Tab | | 82 | |`KC_TAB` | |Tab | |
83 | |`KC_SPACE` |`KC_SPC` |Spacebar | | 83 | |`KC_SPACE` |`KC_SPC` |Spacebar | |
84 | |`KC_MINUS` |`KC_MINS`|`-` and `_` | | 84 | |`KC_MINUS` |`KC_MINS` |`-` and `_` | |
85 | |`KC_EQUAL` |`KC_EQL` |`=` and `+` | | 85 | |`KC_EQUAL` |`KC_EQL` |`=` and `+` | |
86 | |`KC_LBRACKET` |`KC_LBRC`|`[` and `{` | | 86 | |`KC_LBRACKET` |`KC_LBRC` |`[` and `{` | |
87 | |`KC_RBRACKET` |`KC_RBRC`|`]` and `}` | | 87 | |`KC_RBRACKET` |`KC_RBRC` |`]` and `}` | |
88 | |`KC_BSLASH` |`KC_BSLS`|`\` and <code>|</code> | | 88 | |`KC_BSLASH` |`KC_BSLS` |`\` and <code>|</code> | |
89 | |`KC_NONUS_HASH` |`KC_NUHS`|Non-US `#` and `~` | | 89 | |`KC_NONUS_HASH` |`KC_NUHS` |Non-US `#` and `~` | |
90 | |`KC_NONUS_BSLASH`|`KC_NUBS`|Non-US `\` and <code>|</code>| | 90 | |`KC_SCOLON` |`KC_SCLN` |`;` and `:` | |
91 | |`KC_INT1` |`KC_RO` |JIS `\` and <code>|</code> | | 91 | |`KC_QUOTE` |`KC_QUOT` |`'` and `"` | |
92 | |`KC_INT2` |`KC_KANA`|JIS Katakana/Hiragana | | 92 | |`KC_GRAVE` |`KC_GRV`, `KC_ZKHK`|<code>`</code> and `~`, JIS Zenkaku/Hankaku| |
93 | |`KC_INT3` |`KC_JYEN`|JIS `¥` | | 93 | |`KC_COMMA` |`KC_COMM` |`,` and `<` | |
94 | |`KC_SCOLON` |`KC_SCLN`|`;` and `:` | | 94 | |`KC_DOT` | |`.` and `>` | |
95 | |`KC_QUOTE` |`KC_QUOT`|`'` and `"` | | 95 | |`KC_SLASH` |`KC_SLSH` |`/` and `?` | |
96 | |`KC_GRAVE` |`KC_GRV` |<code>`</code> and `~` | | 96 | |`KC_NONUS_BSLASH`|`KC_NUBS` |Non-US `\` and <code>|</code> | |
97 | |`KC_COMMA` |`KC_COMM`|`,` and `<` | | 97 | |
98 | |`KC_DOT` | |`.` and `>` | | 98 | ## Lock Keys |
99 | |`KC_SLASH` |`KC_SLSH`|`/` and `?` | | 99 | |
100 | |`KC_CAPSLOCK` |`KC_CAPS`|Caps Lock | | 100 | |Key |Aliases |Description | |
101 | |-------------------|--------------------|-------------------------| | ||
102 | |`KC_CAPSLOCK` |`KC_CLCK`, `KC_CAPS`|Caps Lock | | ||
103 | |`KC_SCROLLLOCK` |`KC_SLCK` |Scroll Lock | | ||
104 | |`KC_NUMLOCK` |`KC_NLCK` |Keypad Num Lock and Clear| | ||
105 | |`KC_LOCKING_CAPS` |`KC_LCAP` |Locking Caps Lock | | ||
106 | |`KC_LOCKING_NUM` |`KC_LNUM` |Locking Num Lock | | ||
107 | |`KC_LOCKING_SCROLL`|`KC_LSCR` |Locking Scroll Lock | | ||
101 | 108 | ||
102 | ## Modifiers | 109 | ## Modifiers |
103 | 110 | ||
104 | |Key |Aliases |Description | | 111 | |Key |Aliases |Description | |
105 | |-------------------|--------------------|------------------------------------| | 112 | |-----------|--------------------|------------------------------------| |
106 | |`KC_LCTRL` |`KC_LCTL` |Left Control | | 113 | |`KC_LCTRL` |`KC_LCTL` |Left Control | |
107 | |`KC_LSHIFT` |`KC_LSFT` |Left Shift | | 114 | |`KC_LSHIFT`|`KC_LSFT` |Left Shift | |
108 | |`KC_LALT` | |Left Alt | | 115 | |`KC_LALT` | |Left Alt | |
109 | |`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) | | 116 | |`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) | |
110 | |`KC_RCTRL` |`KC_RCTL` |Right Control | | 117 | |`KC_RCTRL` |`KC_RCTL` |Right Control | |
111 | |`KC_RSHIFT` |`KC_RSFT` |Right Shift | | 118 | |`KC_RSHIFT`|`KC_RSFT` |Right Shift | |
112 | |`KC_RALT` | |Right Alt | | 119 | |`KC_RALT` | |Right Alt | |
113 | |`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)| | 120 | |`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)| |
114 | |`KC_LOCKING_CAPS` |`KC_LCAP` |Locking Caps Lock | | 121 | |
115 | |`KC_LOCKING_NUM` |`KC_LNUM` |Locking Num Lock | | 122 | ## International |
116 | |`KC_LOCKING_SCROLL`|`KC_LSCR` |Locking Scroll Lock | | 123 | |
117 | |`KC_INT4` |`KC_HENK` |JIS Henkan | | 124 | |Key |Aliases |Description | |
118 | |`KC_INT5` |`KC_MHEN` |JIS Muhenkan | | 125 | |----------|---------|-------------------------------| |
126 | |`KC_INT1` |`KC_RO` |JIS `\` and <code>|</code>| | ||
127 | |`KC_INT2` |`KC_KANA`|JIS Katakana/Hiragana | | ||
128 | |`KC_INT3` |`KC_JYEN`|JIS `¥` | | ||
129 | |`KC_INT4` |`KC_HENK`|JIS Henkan | | ||
130 | |`KC_INT5` |`KC_MHEN`|JIS Muhenkan | | ||
131 | |`KC_INT6` | |JIS Numpad `,` | | ||
132 | |`KC_INT7` | |International 7 | | ||
133 | |`KC_INT8` | |International 8 | | ||
134 | |`KC_INT9` | |International 9 | | ||
135 | |`KC_LANG1`|`KC_HAEN`|Hangul/English | | ||
136 | |`KC_LANG2`|`KC_HANJ`|Hanja | | ||
137 | |`KC_LANG3`| |JIS Katakana | | ||
138 | |`KC_LANG4`| |JIS Hiragana | | ||
139 | |`KC_LANG5`| |JIS Zenkaku/Hankaku | | ||
140 | |`KC_LANG6`| |Language 6 | | ||
141 | |`KC_LANG7`| |Language 7 | | ||
142 | |`KC_LANG8`| |Language 8 | | ||
143 | |`KC_LANG9`| |Language 9 | | ||
119 | 144 | ||
120 | ## Commands | 145 | ## Commands |
121 | 146 | ||
122 | |Key |Aliases |Description | | 147 | |Key |Aliases |Description | |
123 | |------------------|---------|------------------------------| | 148 | |------------------|-------------------|------------------------------| |
124 | |`KC_PSCREEN` |`KC_PSCR`|Print Screen | | 149 | |`KC_PSCREEN` |`KC_PSCR` |Print Screen | |
125 | |`KC_SCROLLLOCK` |`KC_SLCK`|Scroll Lock | | 150 | |`KC_PAUSE` |`KC_PAUS`, `KC_BRK`|Pause | |
126 | |`KC_PAUSE` |`KC_PAUS`|Pause | | 151 | |`KC_INSERT` |`KC_INS` |Insert | |
127 | |`KC_INSERT` |`KC_INS` |Insert | | 152 | |`KC_HOME` | |Home | |
128 | |`KC_HOME` | |Home | | 153 | |`KC_PGUP` | |Page Up | |
129 | |`KC_PGUP` | |Page Up | | 154 | |`KC_DELETE` |`KC_DEL` |Forward Delete | |
130 | |`KC_DELETE` |`KC_DEL` |Forward Delete | | 155 | |`KC_END` | |End | |
131 | |`KC_END` | |End | | 156 | |`KC_PGDOWN` |`KC_PGDN` |Page Down | |
132 | |`KC_PGDOWN` |`KC_PGDN`|Page Down | | 157 | |`KC_RIGHT` |`KC_RGHT` |Right Arrow | |
133 | |`KC_RIGHT` |`KC_RGHT`|Right Arrow | | 158 | |`KC_LEFT` | |Left Arrow | |
134 | |`KC_LEFT` | |Left Arrow | | 159 | |`KC_DOWN` | |Down Arrow | |
135 | |`KC_DOWN` | |Down Arrow | | 160 | |`KC_UP` | |Up Arrow | |
136 | |`KC_UP` | |Up Arrow | | 161 | |`KC_APPLICATION` |`KC_APP` |Application (Windows Menu Key)| |
137 | |`KC_APPLICATION` |`KC_APP` |Application (Windows Menu Key)| | 162 | |`KC_POWER` | |System Power (macOS/Linux) | |
138 | |`KC_POWER` | |Power | | 163 | |`KC_EXECUTE` |`KC_EXEC` |Execute | |
139 | |`KC_EXECUTE` | |Execute | | 164 | |`KC_HELP` | |Help | |
140 | |`KC_HELP` | |Help | | 165 | |`KC_MENU` | |Menu | |
141 | |`KC_MENU` | |Menu | | 166 | |`KC_SELECT` |`KC_SLCT` |Select | |
142 | |`KC_SELECT` | |Select | | 167 | |`KC_STOP` | |Stop | |
143 | |`KC_AGAIN` | |Again | | 168 | |`KC_AGAIN` |`KC_AGIN` |Again | |
144 | |`KC_UNDO` | |Undo | | 169 | |`KC_UNDO` | |Undo | |
145 | |`KC_CUT` | |Cut | | 170 | |`KC_CUT` | |Cut | |
146 | |`KC_COPY` | |Copy | | 171 | |`KC_COPY` | |Copy | |
147 | |`KC_PASTE` | |Paste | | 172 | |`KC_PASTE` |`KC_PSTE` |Paste | |
148 | |`KC_FIND` | |Find | | 173 | |`KC_FIND` | |Find | |
149 | |`KC_ALT_ERASE` | |Alternate Erase | | 174 | |`KC__MUTE` | |Mute (macOS) | |
150 | |`KC_SYSREQ` | |SysReq/Attention | | 175 | |`KC__VOLUP` | |Volume Up (macOS) | |
151 | |`KC_CANCEL` | |Cancel | | 176 | |`KC__VOLDOWN` | |Volume Down (macOS) | |
152 | |`KC_CLEAR` | |Clear | | 177 | |`KC_ALT_ERASE` |`KC_ERAS` |Alternate Erase | |
153 | |`KC_PRIOR` | |Prior | | 178 | |`KC_SYSREQ` | |SysReq/Attention | |
154 | |`KC_RETURN` | |Return | | 179 | |`KC_CANCEL` | |Cancel | |
155 | |`KC_SEPARATOR` | |Separator | | 180 | |`KC_CLEAR` |`KC_CLR` |Clear | |
156 | |`KC_OUT` | |Out | | 181 | |`KC_PRIOR` | |Prior | |
157 | |`KC_OPER` | |Oper | | 182 | |`KC_RETURN` | |Return | |
158 | |`KC_CLEAR_AGAIN` | |Clear/Again | | 183 | |`KC_SEPARATOR` | |Separator | |
159 | |`KC_CRSEL` | |CrSel/Props | | 184 | |`KC_OUT` | |Out | |
160 | |`KC_EXSEL` | |ExSel | | 185 | |`KC_OPER` | |Oper | |
186 | |`KC_CLEAR_AGAIN` | |Clear/Again | | ||
187 | |`KC_CRSEL` | |CrSel/Props | | ||
188 | |`KC_EXSEL` | |ExSel | | ||
161 | 189 | ||
162 | ## Media Keys | 190 | ## Media Keys |
163 | 191 | ||
@@ -165,42 +193,37 @@ These keycodes are not part of the Keyboard/Keypad usage page. The `SYSTEM_` key | |||
165 | 193 | ||
166 | Windows and macOS use different keycodes for "next track" and "previous track". Make sure you choose the keycode that corresponds to your OS. | 194 | Windows and macOS use different keycodes for "next track" and "previous track". Make sure you choose the keycode that corresponds to your OS. |
167 | 195 | ||
168 | |Key |Aliases |Description | | 196 | |Key |Aliases |Description | |
169 | |-----------------------|---------|---------------------------------| | 197 | |-----------------------|---------|-----------------------------| |
170 | |`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down | | 198 | |`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down | |
171 | |`KC_SYSTEM_SLEEP` |`KC_SLEP`|System Sleep | | 199 | |`KC_SYSTEM_SLEEP` |`KC_SLEP`|System Sleep | |
172 | |`KC_SYSTEM_WAKE` |`KC_WAKE`|System Wake | | 200 | |`KC_SYSTEM_WAKE` |`KC_WAKE`|System Wake | |
173 | |`KC_MAIL` |`KC_MAIL`| | | 201 | |`KC_AUDIO_MUTE` |`KC_MUTE`|Mute | |
174 | |`KC_CALCULATOR` |`KC_CALC`| | | 202 | |`KC_AUDIO_VOL_UP` |`KC_VOLU`|Volume Up | |
175 | |`KC_MY_COMPUTER` |`KC_MYCM`| | | 203 | |`KC_AUDIO_VOL_DOWN` |`KC_VOLD`|Volume Down | |
176 | |`KC_WWW_SEARCH` |`KC_WSCH`| | | 204 | |`KC_MEDIA_NEXT_TRACK` |`KC_MNXT`|Next Track (Windows) | |
177 | |`KC_WWW_HOME` |`KC_WHOM`| | | 205 | |`KC_MEDIA_PREV_TRACK` |`KC_MPRV`|Previous Track (Windows) | |
178 | |`KC_WWW_BACK` |`KC_WBAK`| | | 206 | |`KC_MEDIA_STOP` |`KC_MSTP`|Stop Track (Windows) | |
179 | |`KC_WWW_FORWARD` |`KC_WFWD`| | | 207 | |`KC_MEDIA_PLAY_PAUSE` |`KC_MPLY`|Play/Pause Track | |
180 | |`KC_WWW_STOP` |`KC_WSTP`| | | 208 | |`KC_MEDIA_SELECT` |`KC_MSEL`|Launch Media Player (Windows)| |
181 | |`KC_WWW_REFRESH` |`KC_WREF`| | | 209 | |`KC_MEDIA_EJECT` |`KC_EJCT`|Eject (macOS) | |
182 | |`KC_STOP` | |Stop | | 210 | |`KC_MAIL` | |Launch Mail (Windows) | |
183 | |`KC_WWW_FAVORITES` |`KC_WFAV`| | | 211 | |`KC_CALCULATOR` |`KC_CALC`|Launch Calculator (Windows) | |
184 | |`KC__MUTE` | |Mute (macOS) | | 212 | |`KC_MY_COMPUTER` |`KC_MYCM`|Launch My Computer (Windows) | |
185 | |`KC__VOLUP` | |Volume Up (macOS) | | 213 | |`KC_WWW_SEARCH` |`KC_WSCH`|Browser Search (Windows) | |
186 | |`KC__VOLDOWN` | |Volume Down (macOS) | | 214 | |`KC_WWW_HOME` |`KC_WHOM`|Browser Home (Windows) | |
187 | |`KC_AUDIO_MUTE` |`KC_MUTE`|Mute (Windows/macOS/Linux) | | 215 | |`KC_WWW_BACK` |`KC_WBAK`|Browser Back (Windows) | |
188 | |`KC_AUDIO_VOL_UP` |`KC_VOLU`|Volume Up (Windows/macOS/Linux) | | 216 | |`KC_WWW_FORWARD` |`KC_WFWD`|Browser Forward (Windows) | |
189 | |`KC_AUDIO_VOL_DOWN` |`KC_VOLD`|Volume Down (Windows/macOS/Linux)| | 217 | |`KC_WWW_STOP` |`KC_WSTP`|Browser Stop (Windows) | |
190 | |`KC_MEDIA_NEXT_TRACK` |`KC_MNXT`|Next Track (Windows) | | 218 | |`KC_WWW_REFRESH` |`KC_WREF`|Browser Refresh (Windows) | |
191 | |`KC_MEDIA_PREV_TRACK` |`KC_MPRV`|Previous Track (Windows) | | 219 | |`KC_WWW_FAVORITES` |`KC_WFAV`|Browser Favorites (Windows) | |
192 | |`KC_MEDIA_FAST_FORWARD`|`KC_MFFD`|Next Track (macOS) | | 220 | |`KC_MEDIA_FAST_FORWARD`|`KC_MFFD`|Next Track (macOS) | |
193 | |`KC_MEDIA_REWIND` |`KC_MRWD`|Previous Track (macOS) | | 221 | |`KC_MEDIA_REWIND` |`KC_MRWD`|Previous Track (macOS) | |
194 | |`KC_MEDIA_STOP` |`KC_MSTP`|Stop Track | | ||
195 | |`KC_MEDIA_PLAY_PAUSE` |`KC_MPLY`|Play/Pause Track | | ||
196 | |`KC_MEDIA_SELECT` |`KC_MSEL`| | | ||
197 | |`KC_MEDIA_EJECT` |`KC_EJCT`|Eject (macOS) | | ||
198 | 222 | ||
199 | ## Number Pad | 223 | ## Number Pad |
200 | 224 | ||
201 | |Key |Aliases |Description | | 225 | |Key |Aliases |Description | |
202 | |-------------------|---------|------------------------------| | 226 | |-------------------|---------|------------------------------| |
203 | |`KC_NUMLOCK` |`KC_NLCK`|Keypad Num Lock and Clear | | ||
204 | |`KC_KP_SLASH` |`KC_PSLS`|Keypad `/` | | 227 | |`KC_KP_SLASH` |`KC_PSLS`|Keypad `/` | |
205 | |`KC_KP_ASTERISK` |`KC_PAST`|Keypad `*` | | 228 | |`KC_KP_ASTERISK` |`KC_PAST`|Keypad `*` | |
206 | |`KC_KP_MINUS` |`KC_PMNS`|Keypad `-` | | 229 | |`KC_KP_MINUS` |`KC_PMNS`|Keypad `-` | |
@@ -225,7 +248,7 @@ Windows and macOS use different keycodes for "next track" and "previous track". | |||
225 | 248 | ||
226 | In addition to these, keycodes in the range of `0xA5-DF` are reserved for internal use by TMK. | 249 | In addition to these, keycodes in the range of `0xA5-DF` are reserved for internal use by TMK. |
227 | 250 | ||
228 | |Key |Aliases |Description | | 251 | |Key |Aliases |Description | |
229 | |----------------|---------|---------------------------------------| | 252 | |----------------|--------------------|---------------------------------------| |
230 | |`KC_NO` | |Ignore this key (NOOP) | | 253 | |`KC_NO` |`XXXXXXX` |Ignore this key (NOOP) | |
231 | |`KC_TRANSPARENT`|`KC_TRNS`|Use the next lowest non-transparent key| | 254 | |`KC_TRANSPARENT`|`KC_TRNS`, `_______`|Use the next lowest non-transparent key| |