diff options
| author | fauxpark <fauxpark@gmail.com> | 2019-12-05 19:44:39 +1100 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-12-05 00:44:39 -0800 |
| commit | 3ad389de55aa73eef4542807488a70a19639df11 (patch) | |
| tree | a83c3cddfb943508e42b7295b8d76296c287c183 /docs/feature_bootmagic.md | |
| parent | 66040506a7cece73ad1e3f892aa3effab97ec7f9 (diff) | |
| download | qmk_firmware-3ad389de55aa73eef4542807488a70a19639df11.tar.gz qmk_firmware-3ad389de55aa73eef4542807488a70a19639df11.zip | |
Add short aliases for Magic keycodes (#7541)
* Add short alias for `MAGIC_TOGGLE_NKRO`
* Add aliases for the other Bootmagic keycodes
* Replace long form in default keymaps
Diffstat (limited to 'docs/feature_bootmagic.md')
| -rw-r--r-- | docs/feature_bootmagic.md | 62 |
1 files changed, 31 insertions, 31 deletions
diff --git a/docs/feature_bootmagic.md b/docs/feature_bootmagic.md index ed00d5129..a19b5e548 100644 --- a/docs/feature_bootmagic.md +++ b/docs/feature_bootmagic.md | |||
| @@ -56,37 +56,37 @@ Hold down the Bootmagic key (Space by default) and the desired hotkey while plug | |||
| 56 | 56 | ||
| 57 | ## Keycodes | 57 | ## Keycodes |
| 58 | 58 | ||
| 59 | |Keycode |Aliases |Description | | 59 | |Key |Aliases |Description | |
| 60 | |----------------------------------|---------|------------------------------------------| | 60 | |----------------------------------|---------|--------------------------------------------------------------------------| |
| 61 | |`MAGIC_CAPSLOCK_TO_CONTROL` | |Treat Caps Lock as Left Control | | 61 | |`MAGIC_SWAP_CONTROL_CAPSLOCK` |`CL_SWAP`|Swap Caps Lock and Left Control | |
| 62 | |`MAGIC_UNCAPSLOCK_TO_CONTROL` | |Stop treating Caps Lock as Left Control | | 62 | |`MAGIC_UNSWAP_CONTROL_CAPSLOCK` |`CL_NORM`|Unswap Caps Lock and Left Control | |
| 63 | |`MAGIC_HOST_NKRO` | |Force N-Key Rollover (NKRO) on | | 63 | |`MAGIC_CAPSLOCK_TO_CONTROL` |`CL_CTRL`|Treat Caps Lock as Control | |
| 64 | |`MAGIC_UNHOST_NKRO` | |Force NKRO off | | 64 | |`MAGIC_UNCAPSLOCK_TO_CONTROL` |`CL_CAPS`|Stop treating Caps Lock as Control | |
| 65 | |`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off | | 65 | |`MAGIC_SWAP_LCTL_LGUI` |`LCG_SWP`|Swap Left Control and GUI | |
| 66 | |`MAGIC_NO_GUI` | |Disable the GUI keys (useful when gaming) | | 66 | |`MAGIC_UNSWAP_LCTL_LGUI` |`LCG_NRM`|Unswap Left Control and GUI | |
| 67 | |`MAGIC_UNNO_GUI` | |Enable the GUI keys | | 67 | |`MAGIC_SWAP_RCTL_RGUI` |`RCG_SWP`|Swap Right Control and GUI | |
| 68 | |`MAGIC_SWAP_ALT_GUI` |`AG_SWAP`|Swap Alt and GUI on both sides (for macOS)| | 68 | |`MAGIC_UNSWAP_RCTL_RGUI` |`RCG_NRM`|Unswap Right Control and GUI | |
| 69 | |`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI | | 69 | |`MAGIC_SWAP_CTL_GUI` |`CG_SWAP`|Swap Control and GUI on both sides | |
| 70 | |`MAGIC_TOGGLE_ALT_GUI` |`AG_TOGG`|Toggle Alt and GUI swap | | 70 | |`MAGIC_UNSWAP_CTL_GUI` |`CG_NORM`|Unswap Control and GUI on both sides | |
| 71 | |`MAGIC_SWAP_CTL_GUI` |`CG_SWAP`|Swap Ctrl and GUI on both sides (for macOS)| | 71 | |`MAGIC_TOGGLE_CTL_GUI` |`CG_TOGG`|Toggle Control and GUI swap on both sides | |
| 72 | |`MAGIC_UNSWAP_CTL_GUI` |`CG_NORM`|Unswap Ctrl and GUI | | 72 | |`MAGIC_SWAP_LALT_LGUI` |`LAG_SWP`|Swap Left Alt and GUI | |
| 73 | |`MAGIC_TOGGLE_CTL_GUI` |`CG_TOGG`|Toggle Ctrl and GUI swap | | 73 | |`MAGIC_UNSWAP_LALT_LGUI` |`LAG_NRM`|Unswap Left Alt and GUI | |
| 74 | |`MAGIC_SWAP_BACKSLASH_BACKSPACE` | |Swap `\` and Backspace | | 74 | |`MAGIC_SWAP_RALT_RGUI` |`RAG_SWP`|Swap Right Alt and GUI | |
| 75 | |`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`| |Unswap `\` and Backspace | | 75 | |`MAGIC_UNSWAP_RALT_RGUI` |`RAG_NRM`|Unswap Right Alt and GUI | |
| 76 | |`MAGIC_SWAP_CONTROL_CAPSLOCK` | |Swap Left Control and Caps Lock | | 76 | |`MAGIC_SWAP_ALT_GUI` |`AG_SWAP`|Swap Alt and GUI on both sides | |
| 77 | |`MAGIC_UNSWAP_CONTROL_CAPSLOCK` | |Unswap Left Control and Caps Lock | | 77 | |`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI on both sides | |
| 78 | |`MAGIC_SWAP_GRAVE_ESC` | |Swap <code>`</code> and Escape | | 78 | |`MAGIC_TOGGLE_ALT_GUI` |`AG_TOGG`|Toggle Alt and GUI swap on both sides | |
| 79 | |`MAGIC_UNSWAP_GRAVE_ESC` | |Unswap <code>`</code> and Escape | | 79 | |`MAGIC_NO_GUI` |`GUI_OFF`|Disable the GUI keys | |
| 80 | |`MAGIC_SWAP_LALT_LGUI` | |Swap Left Alt and Left GUI | | 80 | |`MAGIC_UNNO_GUI` |`GUI_ON` |Enable the GUI keys | |
| 81 | |`MAGIC_UNSWAP_LALT_LGUI` | |Unswap Left Alt and Left GUI | | 81 | |`MAGIC_SWAP_GRAVE_ESC` |`GE_SWAP`|Swap <code>`</code> and Escape | |
| 82 | |`MAGIC_SWAP_RALT_RGUI` | |Swap Right Alt and Right GUI | | 82 | |`MAGIC_UNSWAP_GRAVE_ESC` |`GE_NORM`|Unswap <code>`</code> and Escape | |
| 83 | |`MAGIC_UNSWAP_RALT_RGUI` | |Unswap Right Alt and Right GUI | | 83 | |`MAGIC_SWAP_BACKSLASH_BACKSPACE` |`BS_SWAP`|Swap `\` and Backspace | |
| 84 | |`MAGIC_SWAP_LCTL_LGUI` | |Swap Left Control and Left GUI | | 84 | |`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|`BS_NORM`|Unswap `\` and Backspace | |
| 85 | |`MAGIC_UNSWAP_LCTL_LGUI` | |Unswap Left Control and Left GUI | | 85 | |`MAGIC_HOST_NKRO` |`NK_ON` |Enable N-key rollover | |
| 86 | |`MAGIC_SWAP_RCTL_RGUI` | |Swap Right Control and Right GUI | | 86 | |`MAGIC_UNHOST_NKRO` |`NK_OFF` |Disable N-key rollover | |
| 87 | |`MAGIC_UNSWAP_RCTL_RGUI` | |Unswap Right Control and Right GUI | | 87 | |`MAGIC_TOGGLE_NKRO` |`NK_TOGG`|Toggle N-key rollover | |
| 88 | |`MAGIC_EE_HANDS_LEFT` | |Set "Left Hand" for EE_HANDS handedness | | 88 | |`MAGIC_EE_HANDS_LEFT` |`EH_LEFT`|Set the master half of a split keyboard as the left hand (for `EE_HANDS`) | |
| 89 | |`MAGIC_EE_HANDS_RIGHT` | |Set "Right Hand" for EE_HANDS handedness | | 89 | |`MAGIC_EE_HANDS_RIGHT` |`EH_RGHT`|Set the master half of a split keyboard as the right hand (for `EE_HANDS`)| |
| 90 | 90 | ||
| 91 | ## Configuration | 91 | ## Configuration |
| 92 | 92 | ||