aboutsummaryrefslogtreecommitdiff
path: root/docs/keycodes_basic.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/keycodes_basic.md')
-rw-r--r--docs/keycodes_basic.md110
1 files changed, 56 insertions, 54 deletions
diff --git a/docs/keycodes_basic.md b/docs/keycodes_basic.md
index 8445b05ef..6f21cabd2 100644
--- a/docs/keycodes_basic.md
+++ b/docs/keycodes_basic.md
@@ -1,6 +1,6 @@
1# Basic Keycodes 1# Basic Keycodes
2 2
3The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07)](http://www.usb.org/developers/hidpage/Hut1_12v2.pdf) with the exception of `KC_NO`, `KC_TRNS` and keycodes in the `0xA5-DF` range. See below for more details. 3The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07)](https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf) with the exception of `KC_NO`, `KC_TRNS` and keycodes in the `0xA5-DF` range. See below for more details.
4 4
5## Letters and Numbers 5## Letters and Numbers
6 6
@@ -97,14 +97,14 @@ The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07
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_CAPSLOCK` |`KC_CLCK`, `KC_CAPS`|Caps Lock |
103|`KC_SCROLLLOCK` |`KC_SLCK` |Scroll Lock | 103|`KC_SCROLLLOCK` |`KC_SLCK`, `KC_BRMD`|Scroll Lock, Brightness Down (macOS)|
104|`KC_NUMLOCK` |`KC_NLCK` |Keypad Num Lock and Clear| 104|`KC_NUMLOCK` |`KC_NLCK` |Keypad Num Lock and Clear |
105|`KC_LOCKING_CAPS` |`KC_LCAP` |Locking Caps Lock | 105|`KC_LOCKING_CAPS` |`KC_LCAP` |Locking Caps Lock |
106|`KC_LOCKING_NUM` |`KC_LNUM` |Locking Num Lock | 106|`KC_LOCKING_NUM` |`KC_LNUM` |Locking Num Lock |
107|`KC_LOCKING_SCROLL`|`KC_LSCR` |Locking Scroll Lock | 107|`KC_LOCKING_SCROLL`|`KC_LSCR` |Locking Scroll Lock |
108 108
109## Modifiers 109## Modifiers
110 110
@@ -116,16 +116,16 @@ The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07
116|`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) |
117|`KC_RCTRL` |`KC_RCTL` |Right Control | 117|`KC_RCTRL` |`KC_RCTL` |Right Control |
118|`KC_RSHIFT`|`KC_RSFT` |Right Shift | 118|`KC_RSHIFT`|`KC_RSFT` |Right Shift |
119|`KC_RALT` | |Right Alt | 119|`KC_RALT` |`KC_ALGR` |Right Alt (AltGr) |
120|`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)|
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 <code>&#124;</code>| 126|`KC_INT1` |`KC_RO` |JIS `\` and `_` |
127|`KC_INT2` |`KC_KANA`|JIS Katakana/Hiragana | 127|`KC_INT2` |`KC_KANA`|JIS Katakana/Hiragana |
128|`KC_INT3` |`KC_JYEN`|JIS `¥` | 128|`KC_INT3` |`KC_JYEN`|JIS `¥` and <code>&#124;</code>|
129|`KC_INT4` |`KC_HENK`|JIS Henkan | 129|`KC_INT4` |`KC_HENK`|JIS Henkan |
130|`KC_INT5` |`KC_MHEN`|JIS Muhenkan | 130|`KC_INT5` |`KC_MHEN`|JIS Muhenkan |
131|`KC_INT6` | |JIS Numpad `,` | 131|`KC_INT6` | |JIS Numpad `,` |
@@ -144,48 +144,48 @@ The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07
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_PSCREEN` |`KC_PSCR` |Print Screen |
150|`KC_PAUSE` |`KC_PAUS`, `KC_BRK`|Pause | 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_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_PGDOWN` |`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 Menu Key)| 161|`KC_APPLICATION` |`KC_APP` |Application (Windows Menu Key)|
162|`KC_POWER` | |System Power (macOS/Linux) | 162|`KC_POWER` | |System Power (macOS/Linux) |
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 (macOS) | 174|`KC__MUTE` | |Mute (macOS) |
175|`KC__VOLUP` | |Volume Up (macOS) | 175|`KC__VOLUP` | |Volume Up (macOS) |
176|`KC__VOLDOWN` | |Volume Down (macOS) | 176|`KC__VOLDOWN` | |Volume Down (macOS) |
177|`KC_ALT_ERASE` |`KC_ERAS` |Alternate Erase | 177|`KC_ALT_ERASE` |`KC_ERAS` |Alternate Erase |
178|`KC_SYSREQ` | |SysReq/Attention | 178|`KC_SYSREQ` | |SysReq/Attention |
179|`KC_CANCEL` | |Cancel | 179|`KC_CANCEL` | |Cancel |
180|`KC_CLEAR` |`KC_CLR` |Clear | 180|`KC_CLEAR` |`KC_CLR` |Clear |
181|`KC_PRIOR` | |Prior | 181|`KC_PRIOR` | |Prior |
182|`KC_RETURN` | |Return | 182|`KC_RETURN` | |Return |
183|`KC_SEPARATOR` | |Separator | 183|`KC_SEPARATOR` | |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` | |Clear/Again |
187|`KC_CRSEL` | |CrSel/Props | 187|`KC_CRSEL` | |CrSel/Props |
188|`KC_EXSEL` | |ExSel | 188|`KC_EXSEL` | |ExSel |
189 189
190## Media Keys 190## Media Keys
191 191
@@ -219,6 +219,8 @@ Windows and macOS use different keycodes for "next track" and "previous track".
219|`KC_WWW_FAVORITES` |`KC_WFAV`|Browser Favorites (Windows) | 219|`KC_WWW_FAVORITES` |`KC_WFAV`|Browser Favorites (Windows) |
220|`KC_MEDIA_FAST_FORWARD`|`KC_MFFD`|Next Track (macOS) | 220|`KC_MEDIA_FAST_FORWARD`|`KC_MFFD`|Next Track (macOS) |
221|`KC_MEDIA_REWIND` |`KC_MRWD`|Previous Track (macOS) | 221|`KC_MEDIA_REWIND` |`KC_MRWD`|Previous Track (macOS) |
222|`KC_BRIGHTNESS_UP` |`KC_BRIU`|Brightness Up |
223|`KC_BRIGHTNESS_DOWN` |`KC_BRID`|Brightness Down |
222 224
223## Number Pad 225## Number Pad
224 226