summaryrefslogtreecommitdiff
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)
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 6a31204f33..6f6ef7a3fd 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
## Punctuation
-|Key |Aliases |Description |
-|-----------------|-------------------|-----------------------------------------------|
-|`KC_ENTER` |`KC_ENT` |Return (Enter) |
-|`KC_ESCAPE` |`KC_ESC` |Escape |
-|`KC_BSPACE` |`KC_BSPC` |Delete (Backspace) |
-|`KC_TAB` | |Tab |
-|`KC_SPACE` |`KC_SPC` |Spacebar |
-|`KC_MINUS` |`KC_MINS` |`-` and `_` |
-|`KC_EQUAL` |`KC_EQL` |`=` and `+` |
-|`KC_LBRACKET` |`KC_LBRC` |`[` and `{` |
-|`KC_RBRACKET` |`KC_RBRC` |`]` and `}` |
-|`KC_BSLASH` |`KC_BSLS` |`\` and `\|` |
-|`KC_NONUS_HASH` |`KC_NUHS` |Non-US `#` and `~` |
-|`KC_SCOLON` |`KC_SCLN` |`;` and `:` |
-|`KC_QUOTE` |`KC_QUOT` |`'` and `"` |
-|`KC_GRAVE` |`KC_GRV`, `KC_ZKHK`|<code>&#96;</code> and `~`, JIS Zenkaku/Hankaku|
-|`KC_COMMA` |`KC_COMM` |`,` and `<` |
-|`KC_DOT` | |`.` and `>` |
-|`KC_SLASH` |`KC_SLSH` |`/` and `?` |
-|`KC_NONUS_BSLASH`|`KC_NUBS` |Non-US `\` and `\|` |
+|Key |Aliases |Description |
+|--------------------|---------|--------------------------|
+|`KC_ENTER` |`KC_ENT` |Return (Enter) |
+|`KC_ESCAPE` |`KC_ESC` |Escape |
+|`KC_BACKSPACE` |`KC_BSPC`|Delete (Backspace) |
+|`KC_TAB` | |Tab |
+|`KC_SPACE` |`KC_SPC` |Spacebar |
+|`KC_MINUS` |`KC_MINS`|`-` and `_` |
+|`KC_EQUAL` |`KC_EQL` |`=` and `+` |
+|`KC_LEFT_BRACKET` |`KC_LBRC`|`[` and `{` |
+|`KC_RIGHT_BRACKET` |`KC_RBRC`|`]` and `}` |
+|`KC_BACKSLASH` |`KC_BSLS`|`\` and `\|` |
+|`KC_NONUS_HASH` |`KC_NUHS`|Non-US `#` and `~` |
+|`KC_SEMICOLON` |`KC_SCLN`|`;` and `:` |
+|`KC_QUOTE` |`KC_QUOT`|`'` and `"` |
+|`KC_GRAVE` |`KC_GRV` |<code>&#96;</code> and `~`|
+|`KC_COMMA` |`KC_COMM`|`,` and `<` |
+|`KC_DOT` | |`.` and `>` |
+|`KC_SLASH` |`KC_SLSH`|`/` and `?` |
+|`KC_NONUS_BACKSLASH`|`KC_NUBS`|Non-US `\` and `\|` |
## Lock Keys
-|Key |Aliases |Description |
-|-------------------|--------------------|------------------------------------|
-|`KC_CAPSLOCK` |`KC_CLCK`, `KC_CAPS`|Caps Lock |
-|`KC_SCROLLLOCK` |`KC_SLCK`, `KC_BRMD`|Scroll Lock, Brightness Down (macOS)|
-|`KC_NUMLOCK` |`KC_NLCK` |Keypad Num Lock and Clear |
-|`KC_LOCKING_CAPS` |`KC_LCAP` |Locking Caps Lock |
-|`KC_LOCKING_NUM` |`KC_LNUM` |Locking Num Lock |
-|`KC_LOCKING_SCROLL`|`KC_LSCR` |Locking Scroll Lock |
+|Key |Aliases |Description |
+|------------------------|--------------------|------------------------------------|
+|`KC_CAPS_LOCK` |`KC_CAPS` |Caps Lock |
+|`KC_SCROLL_LOCK` |`KC_SCRL`, `KC_BRMD`|Scroll Lock, Brightness Down (macOS)|
+|`KC_NUM_LOCK` |`KC_NUM` |Keypad Num Lock and Clear |
+|`KC_LOCKING_CAPS_LOCK` |`KC_LCAP` |Locking Caps Lock |
+|`KC_LOCKING_NUM_LOCK` |`KC_LNUM` |Locking Num Lock |
+|`KC_LOCKING_SCROLL_LOCK`|`KC_LSCR` |Locking Scroll Lock |
## Modifiers
-|Key |Aliases |Description |
-|-----------|--------------------|------------------------------------|
-|`KC_LCTRL` |`KC_LCTL` |Left Control |
-|`KC_LSHIFT`|`KC_LSFT` |Left Shift |
-|`KC_LALT` |`KC_LOPT` |Left Alt (Option) |
-|`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) |
-|`KC_RCTRL` |`KC_RCTL` |Right Control |
-|`KC_RSHIFT`|`KC_RSFT` |Right Shift |
-|`KC_RALT` |`KC_ROPT`, `KC_ALGR`|Right Alt (Option/AltGr) |
-|`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)|
+|Key |Aliases |Description |
+|----------------|-------------------------------|------------------------------------|
+|`KC_LEFT_CTRL` |`KC_LCTL` |Left Control |
+|`KC_LEFT_SHIFT` |`KC_LSFT` |Left Shift |
+|`KC_LEFT_ALT` |`KC_LALT`, `KC_LOPT` |Left Alt (Option) |
+|`KC_LEFT_GUI` |`KC_LGUI`, `KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) |
+|`KC_RIGHT_CTRL` |`KC_RCTL` |Right Control |
+|`KC_RIGHT_SHIFT`|`KC_RSFT` |Right Shift |
+|`KC_RIGHT_ALT` |`KC_RALT`, `KC_ROPT`, `KC_ALGR`|Right Alt (Option/AltGr) |
+|`KC_RIGHT_GUI` |`KC_RGUI`, `KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)|
## International
-|Key |Aliases |Description |
-|----------|---------|---------------------|
-|`KC_INT1` |`KC_RO` |JIS `\` and `_` |
-|`KC_INT2` |`KC_KANA`|JIS Katakana/Hiragana|
-|`KC_INT3` |`KC_JYEN`|JIS `¥` and `\|` |
-|`KC_INT4` |`KC_HENK`|JIS Henkan |
-|`KC_INT5` |`KC_MHEN`|JIS Muhenkan |
-|`KC_INT6` | |JIS Numpad `,` |
-|`KC_INT7` | |International 7 |
-|`KC_INT8` | |International 8 |
-|`KC_INT9` | |International 9 |
-|`KC_LANG1`|`KC_HAEN`|Hangul/English |
-|`KC_LANG2`|`KC_HANJ`|Hanja |
-|`KC_LANG3`| |JIS Katakana |
-|`KC_LANG4`| |JIS Hiragana |
-|`KC_LANG5`| |JIS Zenkaku/Hankaku |
-|`KC_LANG6`| |Language 6 |
-|`KC_LANG7`| |Language 7 |
-|`KC_LANG8`| |Language 8 |
-|`KC_LANG9`| |Language 9 |
+|Key |Aliases |Description |
+|--------------------|---------|---------------------|
+|`KC_INTERNATIONAL_1`|`KC_INT1`|JIS `\` and `_` |
+|`KC_INTERNATIONAL_2`|`KC_INT2`|JIS Katakana/Hiragana|
+|`KC_INTERNATIONAL_3`|`KC_INT3`|JIS `¥` and `\|` |
+|`KC_INTERNATIONAL_4`|`KC_INT4`|JIS Henkan |
+|`KC_INTERNATIONAL_5`|`KC_INT5`|JIS Muhenkan |
+|`KC_INTERNATIONAL_6`|`KC_INT6`|JIS Numpad `,` |
+|`KC_INTERNATIONAL_7`|`KC_INT7`|International 7 |
+|`KC_INTERNATIONAL_8`|`KC_INT8`|International 8 |
+|`KC_INTERNATIONAL_9`|`KC_INT9`|International 9 |
+|`KC_LANGUAGE_1` |`KC_LNG1`|Hangul/English |
+|`KC_LANGUAGE_2` |`KC_LNG2`|Hanja |
+|`KC_LANGUAGE_3` |`KC_LNG3`|JIS Katakana |
+|`KC_LANGUAGE_4` |`KC_LNG4`|JIS Hiragana |
+|`KC_LANGUAGE_5` |`KC_LNG5`|JIS Zenkaku/Hankaku |
+|`KC_LANGUAGE_6` |`KC_LNG6`|Language 6 |
+|`KC_LANGUAGE_7` |`KC_LNG7`|Language 7 |
+|`KC_LANGUAGE_8` |`KC_LNG8`|Language 8 |
+|`KC_LANGUAGE_9` |`KC_LNG9`|Language 9 |
## Commands
-|Key |Aliases |Description |
-|------------------|------------------------------|--------------------------------------|
-|`KC_PSCREEN` |`KC_PSCR` |Print Screen |
-|`KC_PAUSE` |`KC_PAUS`, `KC_BRK`, `KC_BRMU`|Pause, Brightness Up (macOS) |
-|`KC_INSERT` |`KC_INS` |Insert |
-|`KC_HOME` | |Home |
-|`KC_PGUP` | |Page Up |
-|`KC_DELETE` |`KC_DEL` |Forward Delete |
-|`KC_END` | |End |
-|`KC_PGDOWN` |`KC_PGDN` |Page Down |
-|`KC_RIGHT` |`KC_RGHT` |Right Arrow |
-|`KC_LEFT` | |Left Arrow |
-|`KC_DOWN` | |Down Arrow |
-|`KC_UP` | |Up Arrow |
-|`KC_APPLICATION` |`KC_APP` |Application (Windows Context Menu Key)|
-|`KC_POWER` | |System Power |
-|`KC_EXECUTE` |`KC_EXEC` |Execute |
-|`KC_HELP` | |Help |
-|`KC_MENU` | |Menu |
-|`KC_SELECT` |`KC_SLCT` |Select |
-|`KC_STOP` | |Stop |
-|`KC_AGAIN` |`KC_AGIN` |Again |
-|`KC_UNDO` | |Undo |
-|`KC_CUT` | |Cut |
-|`KC_COPY` | |Copy |
-|`KC_PASTE` |`KC_PSTE` |Paste |
-|`KC_FIND` | |Find |
-|`KC__MUTE` | |Mute |
-|`KC__VOLUP` | |Volume Up |
-|`KC__VOLDOWN` | |Volume Down |
-|`KC_ALT_ERASE` |`KC_ERAS` |Alternate Erase |
-|`KC_SYSREQ` | |SysReq/Attention |
-|`KC_CANCEL` | |Cancel |
-|`KC_CLEAR` |`KC_CLR` |Clear |
-|`KC_PRIOR` | |Prior |
-|`KC_RETURN` | |Return |
-|`KC_SEPARATOR` | |Separator |
-|`KC_OUT` | |Out |
-|`KC_OPER` | |Oper |
-|`KC_CLEAR_AGAIN` | |Clear/Again |
-|`KC_CRSEL` | |CrSel/Props |
-|`KC_EXSEL` | |ExSel |
+|Key |Aliases |Description |
+|--------------------|------------------------------|--------------------------------------|
+|`KC_PRINT_SCREEN` |`KC_PSCR` |Print Screen |
+|`KC_PAUSE` |`KC_PAUS`, `KC_BRK`, `KC_BRMU`|Pause, Brightness Up (macOS) |
+|`KC_INSERT` |`KC_INS` |Insert |
+|`KC_HOME` | |Home |
+|`KC_PAGE_UP` |`KC_PGUP` |Page Up |
+|`KC_DELETE` |`KC_DEL` |Forward Delete |
+|`KC_END` | |End |
+|`KC_PAGE_DOWN` |`KC_PGDN` |Page Down |
+|`KC_RIGHT` |`KC_RGHT` |Right Arrow |
+|`KC_LEFT` | |Left Arrow |
+|`KC_DOWN` | |Down Arrow |
+|`KC_UP` | |Up Arrow |
+|`KC_APPLICATION` |`KC_APP` |Application (Windows Context Menu Key)|
+|`KC_KB_POWER` | |System Power |
+|`KC_EXECUTE` |`KC_EXEC` |Execute |
+|`KC_HELP` | |Help |
+|`KC_MENU` | |Menu |
+|`KC_SELECT` |`KC_SLCT` |Select |
+|`KC_STOP` | |Stop |
+|`KC_AGAIN` |`KC_AGIN` |Again |
+|`KC_UNDO` | |Undo |
+|`KC_CUT` | |Cut |
+|`KC_COPY` | |Copy |
+|`KC_PASTE` |`KC_PSTE` |Paste |
+|`KC_FIND` | |Find |
+|`KC_KB_MUTE` | |Mute |
+|`KC_KB_VOLUME_UP` | |Volume Up |
+|`KC_KB_VOLUME_DOWN` | |Volume Down |
+|`KC_ALTERNATE_ERASE`|`KC_ERAS` |Alternate Erase |
+|`KC_SYSTEM_REQUEST` |`KC_SYRQ` |SysReq/Attention |
+|`KC_CANCEL` |`KC_CNCL` |Cancel |
+|`KC_CLEAR` |`KC_CLR` |Clear |
+|`KC_PRIOR` |`KC_PRIR` |Prior |
+|`KC_RETURN` |`KC_RETN` |Return |
+|`KC_SEPARATOR` |`KC_SEPR` |Separator |
+|`KC_OUT` | |Out |
+|`KC_OPER` | |Oper |
+|`KC_CLEAR_AGAIN` |`KC_CLAG` |Clear/Again |
+|`KC_CRSEL` |`KC_CRSL` |CrSel/Props |
+|`KC_EXSEL` |`KC_EXSL` |ExSel |
## Media Keys