aboutsummaryrefslogtreecommitdiff
path: root/docs/keycodes_basic.md
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-11-04 16:22:17 +1100
committerGitHub <noreply@github.com>2021-11-03 22:22:17 -0700
commitf529580860cf5a1de4afc10432f218a45daae17a (patch)
tree1d2fa041174f2586230ab831c05e5b56d8ba4f92 /docs/keycodes_basic.md
parentb06d9d822cfb72e0728b11711a333f2f5d3c631e (diff)
downloadqmk_firmware-f529580860cf5a1de4afc10432f218a45daae17a.tar.gz
qmk_firmware-f529580860cf5a1de4afc10432f218a45daae17a.zip
Basic keycode overhaul (#14726)
Diffstat (limited to 'docs/keycodes_basic.md')
-rw-r--r--docs/keycodes_basic.md200
1 files changed, 100 insertions, 100 deletions
diff --git a/docs/keycodes_basic.md b/docs/keycodes_basic.md
index 6a31204f3..6f6ef7a3f 100644
--- a/docs/keycodes_basic.md
+++ b/docs/keycodes_basic.md
@@ -74,118 +74,118 @@ The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07
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_BACKSPACE` |`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_LEFT_BRACKET` |`KC_LBRC`|`[` and `{` |
87|`KC_RBRACKET` |`KC_RBRC` |`]` and `}` | 87|`KC_RIGHT_BRACKET` |`KC_RBRC`|`]` and `}` |
88|`KC_BSLASH` |`KC_BSLS` |`\` and `\|` | 88|`KC_BACKSLASH` |`KC_BSLS`|`\` and `\|` |
89|`KC_NONUS_HASH` |`KC_NUHS` |Non-US `#` and `~` | 89|`KC_NONUS_HASH` |`KC_NUHS`|Non-US `#` and `~` |
90|`KC_SCOLON` |`KC_SCLN` |`;` and `:` | 90|`KC_SEMICOLON` |`KC_SCLN`|`;` and `:` |
91|`KC_QUOTE` |`KC_QUOT` |`'` and `"` | 91|`KC_QUOTE` |`KC_QUOT`|`'` and `"` |
92|`KC_GRAVE` |`KC_GRV`, `KC_ZKHK`|<code>&#96;</code> and `~`, JIS Zenkaku/Hankaku| 92|`KC_GRAVE` |`KC_GRV` |<code>&#96;</code> and `~`|
93|`KC_COMMA` |`KC_COMM` |`,` and `<` | 93|`KC_COMMA` |`KC_COMM`|`,` and `<` |
94|`KC_DOT` | |`.` and `>` | 94|`KC_DOT` | |`.` and `>` |
95|`KC_SLASH` |`KC_SLSH` |`/` and `?` | 95|`KC_SLASH` |`KC_SLSH`|`/` and `?` |
96|`KC_NONUS_BSLASH`|`KC_NUBS` |Non-US `\` and `\|` | 96|`KC_NONUS_BACKSLASH`|`KC_NUBS`|Non-US `\` and `\|` |
97 97
98## Lock Keys 98## Lock Keys
99 99
100|Key |Aliases |Description | 100|Key |Aliases |Description |
101|-------------------|--------------------|------------------------------------| 101|------------------------|--------------------|------------------------------------|
102|`KC_CAPSLOCK` |`KC_CLCK`, `KC_CAPS`|Caps Lock | 102|`KC_CAPS_LOCK` |`KC_CAPS` |Caps Lock |
103|`KC_SCROLLLOCK` |`KC_SLCK`, `KC_BRMD`|Scroll Lock, Brightness Down (macOS)| 103|`KC_SCROLL_LOCK` |`KC_SCRL`, `KC_BRMD`|Scroll Lock, Brightness Down (macOS)|
104|`KC_NUMLOCK` |`KC_NLCK` |Keypad Num Lock and Clear | 104|`KC_NUM_LOCK` |`KC_NUM` |Keypad Num Lock and Clear |
105|`KC_LOCKING_CAPS` |`KC_LCAP` |Locking Caps Lock | 105|`KC_LOCKING_CAPS_LOCK` |`KC_LCAP` |Locking Caps Lock |
106|`KC_LOCKING_NUM` |`KC_LNUM` |Locking Num Lock | 106|`KC_LOCKING_NUM_LOCK` |`KC_LNUM` |Locking Num Lock |
107|`KC_LOCKING_SCROLL`|`KC_LSCR` |Locking Scroll Lock | 107|`KC_LOCKING_SCROLL_LOCK`|`KC_LSCR` |Locking Scroll Lock |
108 108
109## Modifiers 109## Modifiers
110 110
111|Key |Aliases |Description | 111|Key |Aliases |Description |
112|-----------|--------------------|------------------------------------| 112|----------------|-------------------------------|------------------------------------|
113|`KC_LCTRL` |`KC_LCTL` |Left Control | 113|`KC_LEFT_CTRL` |`KC_LCTL` |Left Control |
114|`KC_LSHIFT`|`KC_LSFT` |Left Shift | 114|`KC_LEFT_SHIFT` |`KC_LSFT` |Left Shift |
115|`KC_LALT` |`KC_LOPT` |Left Alt (Option) | 115|`KC_LEFT_ALT` |`KC_LALT`, `KC_LOPT` |Left Alt (Option) |
116|`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) | 116|`KC_LEFT_GUI` |`KC_LGUI`, `KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) |
117|`KC_RCTRL` |`KC_RCTL` |Right Control | 117|`KC_RIGHT_CTRL` |`KC_RCTL` |Right Control |
118|`KC_RSHIFT`|`KC_RSFT` |Right Shift | 118|`KC_RIGHT_SHIFT`|`KC_RSFT` |Right Shift |
119|`KC_RALT` |`KC_ROPT`, `KC_ALGR`|Right Alt (Option/AltGr) | 119|`KC_RIGHT_ALT` |`KC_RALT`, `KC_ROPT`, `KC_ALGR`|Right Alt (Option/AltGr) |
120|`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)| 120|`KC_RIGHT_GUI` |`KC_RGUI`, `KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)|
121 121
122## International 122## International
123 123
124|Key |Aliases |Description | 124|Key |Aliases |Description |
125|----------|---------|---------------------| 125|--------------------|---------|---------------------|
126|`KC_INT1` |`KC_RO` |JIS `\` and `_` | 126|`KC_INTERNATIONAL_1`|`KC_INT1`|JIS `\` and `_` |
127|`KC_INT2` |`KC_KANA`|JIS Katakana/Hiragana| 127|`KC_INTERNATIONAL_2`|`KC_INT2`|JIS Katakana/Hiragana|
128|`KC_INT3` |`KC_JYEN`|JIS `¥` and `\|` | 128|`KC_INTERNATIONAL_3`|`KC_INT3`|JIS `¥` and `\|` |
129|`KC_INT4` |`KC_HENK`|JIS Henkan | 129|`KC_INTERNATIONAL_4`|`KC_INT4`|JIS Henkan |
130|`KC_INT5` |`KC_MHEN`|JIS Muhenkan | 130|`KC_INTERNATIONAL_5`|`KC_INT5`|JIS Muhenkan |
131|`KC_INT6` | |JIS Numpad `,` | 131|`KC_INTERNATIONAL_6`|`KC_INT6`|JIS Numpad `,` |
132|`KC_INT7` | |International 7 | 132|`KC_INTERNATIONAL_7`|`KC_INT7`|International 7 |
133|`KC_INT8` | |International 8 | 133|`KC_INTERNATIONAL_8`|`KC_INT8`|International 8 |
134|`KC_INT9` | |International 9 | 134|`KC_INTERNATIONAL_9`|`KC_INT9`|International 9 |
135|`KC_LANG1`|`KC_HAEN`|Hangul/English | 135|`KC_LANGUAGE_1` |`KC_LNG1`|Hangul/English |
136|`KC_LANG2`|`KC_HANJ`|Hanja | 136|`KC_LANGUAGE_2` |`KC_LNG2`|Hanja |
137|`KC_LANG3`| |JIS Katakana | 137|`KC_LANGUAGE_3` |`KC_LNG3`|JIS Katakana |
138|`KC_LANG4`| |JIS Hiragana | 138|`KC_LANGUAGE_4` |`KC_LNG4`|JIS Hiragana |
139|`KC_LANG5`| |JIS Zenkaku/Hankaku | 139|`KC_LANGUAGE_5` |`KC_LNG5`|JIS Zenkaku/Hankaku |
140|`KC_LANG6`| |Language 6 | 140|`KC_LANGUAGE_6` |`KC_LNG6`|Language 6 |
141|`KC_LANG7`| |Language 7 | 141|`KC_LANGUAGE_7` |`KC_LNG7`|Language 7 |
142|`KC_LANG8`| |Language 8 | 142|`KC_LANGUAGE_8` |`KC_LNG8`|Language 8 |
143|`KC_LANG9`| |Language 9 | 143|`KC_LANGUAGE_9` |`KC_LNG9`|Language 9 |
144 144
145## Commands 145## Commands
146 146
147|Key |Aliases |Description | 147|Key |Aliases |Description |
148|------------------|------------------------------|--------------------------------------| 148|--------------------|------------------------------|--------------------------------------|
149|`KC_PSCREEN` |`KC_PSCR` |Print Screen | 149|`KC_PRINT_SCREEN` |`KC_PSCR` |Print Screen |
150|`KC_PAUSE` |`KC_PAUS`, `KC_BRK`, `KC_BRMU`|Pause, Brightness Up (macOS) | 150|`KC_PAUSE` |`KC_PAUS`, `KC_BRK`, `KC_BRMU`|Pause, Brightness Up (macOS) |
151|`KC_INSERT` |`KC_INS` |Insert | 151|`KC_INSERT` |`KC_INS` |Insert |
152|`KC_HOME` | |Home | 152|`KC_HOME` | |Home |
153|`KC_PGUP` | |Page Up | 153|`KC_PAGE_UP` |`KC_PGUP` |Page Up |
154|`KC_DELETE` |`KC_DEL` |Forward Delete | 154|`KC_DELETE` |`KC_DEL` |Forward Delete |
155|`KC_END` | |End | 155|`KC_END` | |End |
156|`KC_PGDOWN` |`KC_PGDN` |Page Down | 156|`KC_PAGE_DOWN` |`KC_PGDN` |Page Down |
157|`KC_RIGHT` |`KC_RGHT` |Right Arrow | 157|`KC_RIGHT` |`KC_RGHT` |Right Arrow |
158|`KC_LEFT` | |Left Arrow | 158|`KC_LEFT` | |Left Arrow |
159|`KC_DOWN` | |Down Arrow | 159|`KC_DOWN` | |Down Arrow |
160|`KC_UP` | |Up Arrow | 160|`KC_UP` | |Up Arrow |
161|`KC_APPLICATION` |`KC_APP` |Application (Windows Context Menu Key)| 161|`KC_APPLICATION` |`KC_APP` |Application (Windows Context Menu Key)|
162|`KC_POWER` | |System Power | 162|`KC_KB_POWER` | |System Power |
163|`KC_EXECUTE` |`KC_EXEC` |Execute | 163|`KC_EXECUTE` |`KC_EXEC` |Execute |
164|`KC_HELP` | |Help | 164|`KC_HELP` | |Help |
165|`KC_MENU` | |Menu | 165|`KC_MENU` | |Menu |
166|`KC_SELECT` |`KC_SLCT` |Select | 166|`KC_SELECT` |`KC_SLCT` |Select |
167|`KC_STOP` | |Stop | 167|`KC_STOP` | |Stop |
168|`KC_AGAIN` |`KC_AGIN` |Again | 168|`KC_AGAIN` |`KC_AGIN` |Again |
169|`KC_UNDO` | |Undo | 169|`KC_UNDO` | |Undo |
170|`KC_CUT` | |Cut | 170|`KC_CUT` | |Cut |
171|`KC_COPY` | |Copy | 171|`KC_COPY` | |Copy |
172|`KC_PASTE` |`KC_PSTE` |Paste | 172|`KC_PASTE` |`KC_PSTE` |Paste |
173|`KC_FIND` | |Find | 173|`KC_FIND` | |Find |
174|`KC__MUTE` | |Mute | 174|`KC_KB_MUTE` | |Mute |
175|`KC__VOLUP` | |Volume Up | 175|`KC_KB_VOLUME_UP` | |Volume Up |
176|`KC__VOLDOWN` | |Volume Down | 176|`KC_KB_VOLUME_DOWN` | |Volume Down |
177|`KC_ALT_ERASE` |`KC_ERAS` |Alternate Erase | 177|`KC_ALTERNATE_ERASE`|`KC_ERAS` |Alternate Erase |
178|`KC_SYSREQ` | |SysReq/Attention | 178|`KC_SYSTEM_REQUEST` |`KC_SYRQ` |SysReq/Attention |
179|`KC_CANCEL` | |Cancel | 179|`KC_CANCEL` |`KC_CNCL` |Cancel |
180|`KC_CLEAR` |`KC_CLR` |Clear | 180|`KC_CLEAR` |`KC_CLR` |Clear |
181|`KC_PRIOR` | |Prior | 181|`KC_PRIOR` |`KC_PRIR` |Prior |
182|`KC_RETURN` | |Return | 182|`KC_RETURN` |`KC_RETN` |Return |
183|`KC_SEPARATOR` | |Separator | 183|`KC_SEPARATOR` |`KC_SEPR` |Separator |
184|`KC_OUT` | |Out | 184|`KC_OUT` | |Out |
185|`KC_OPER` | |Oper | 185|`KC_OPER` | |Oper |
186|`KC_CLEAR_AGAIN` | |Clear/Again | 186|`KC_CLEAR_AGAIN` |`KC_CLAG` |Clear/Again |
187|`KC_CRSEL` | |CrSel/Props | 187|`KC_CRSEL` |`KC_CRSL` |CrSel/Props |
188|`KC_EXSEL` | |ExSel | 188|`KC_EXSEL` |`KC_EXSL` |ExSel |
189 189
190## Media Keys 190## Media Keys
191 191
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-01 21:38:08 +0000