docs/feature_bootmagic.md

   1 # Bootmagic
   2
   3 <!-- FIXME: Describe the bootmagic feature here. -->
   4
   5 ## Bootmagic Keycodes
   6
   7 Shortcuts for bootmagic options. You can use these even when bootmagic is off.
   8
   9 |Name|Description|
  10 |----|-----------|
  11 |`MAGIC_SWAP_CONTROL_CAPSLOCK`|Swap Capslock and Left Control|
  12 |`MAGIC_CAPSLOCK_TO_CONTROL`|Treat Capslock like a Control Key|
  13 |`MAGIC_SWAP_LALT_LGUI`|Swap the left Alt and GUI keys|
  14 |`MAGIC_SWAP_RALT_RGUI`|Swap the right Alt and GUI keys|
  15 |`MAGIC_NO_GUI`|Disable the GUI key|
  16 |`MAGIC_SWAP_GRAVE_ESC`|Swap the Grave and Esc key.|
  17 |`MAGIC_SWAP_BACKSLASH_BACKSPACE`|Swap backslash and backspace|
  18 |`MAGIC_HOST_NKRO`|Force NKRO on|
  19 |`MAGIC_SWAP_ALT_GUI`/`AG_SWAP`|Swap Alt and Gui on both sides|
  20 |`MAGIC_UNSWAP_CONTROL_CAPSLOCK`|Disable the Control/Capslock swap|
  21 |`MAGIC_UNCAPSLOCK_TO_CONTROL`|Disable treating Capslock like Control |
  22 |`MAGIC_UNSWAP_LALT_LGUI`|Disable Left Alt and GUI switching|
  23 |`MAGIC_UNSWAP_RALT_RGUI`|Disable Right Alt and GUI switching|
  24 |`MAGIC_UNNO_GUI`|Enable the GUI key |
  25 |`MAGIC_UNSWAP_GRAVE_ESC`|Disable the Grave/Esc swap |
  26 |`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|Disable the backslash/backspace swap|
  27 |`MAGIC_UNHOST_NKRO`|Force NKRO off|
  28 |`MAGIC_UNSWAP_ALT_GUI`/`AG_NORM`|Disable the Alt/GUI switching|
  29 |`MAGIC_TOGGLE_NKRO`|Turn NKRO on or off|