diff options
author | Yan-Fa Li <yanfali@gmail.com> | 2018-02-19 23:01:46 -0800 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2018-02-23 13:14:53 -0500 |
commit | a8daf3ffba0606d3e80dc5f12d2da336305aed0d (patch) | |
tree | 0803a2f06fbe01bce419de0e49e93ff2b772d361 /docs/feature_bootmagic.md | |
parent | 3b4d26e3443771dfaeb7a45c4d9ee08e3e00866d (diff) | |
download | qmk_firmware-a8daf3ffba0606d3e80dc5f12d2da336305aed0d.tar.gz qmk_firmware-a8daf3ffba0606d3e80dc5f12d2da336305aed0d.zip |
Document bootmagic hot keys
- covers most of tmk_core/common/bootmagic.h
Diffstat (limited to 'docs/feature_bootmagic.md')
-rw-r--r-- | docs/feature_bootmagic.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/feature_bootmagic.md b/docs/feature_bootmagic.md index 037830c4d..080a8cb27 100644 --- a/docs/feature_bootmagic.md +++ b/docs/feature_bootmagic.md | |||
@@ -27,3 +27,38 @@ Shortcuts for bootmagic options. You can use these even when bootmagic is off. | |||
27 | |`MAGIC_UNHOST_NKRO` | |Force NKRO off | | 27 | |`MAGIC_UNHOST_NKRO` | |Force NKRO off | |
28 | |`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Left Alt and GUI | | 28 | |`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Left Alt and GUI | |
29 | |`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off | | 29 | |`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off | |
30 | |||
31 | |||
32 | ## Bootmagc Hotkeys | ||
33 | |||
34 | Use this by holding the SPACEBAR and the documented key while | ||
35 | plugging in the USB connection. e.g. to get into bootloader mode | ||
36 | hold `SPACE` and `B` while plugging in USB. | ||
37 | |||
38 | |||
39 | |Key |Description | | ||
40 | |-----------|------------------------------------------------------------------------| | ||
41 | |`ESC` | Skip bootmagic and saved eeprom configuration | | ||
42 | |`B` | Enter bootloader instead of firmware | | ||
43 | |`BACKSPACE`| Clear the saved settings from flash | | ||
44 | |`LCTRL` | Swap `Control` and `Capslock` and save into flash | | ||
45 | |`CAPSLOCK` | Swap `Capslock` and `Control` and save into flash | | ||
46 | |`LALT` | Swap Left `Alt` and `GUI` and save into flash, e.g. for OSX Opt and Cmd| | ||
47 | |`RALT` | Swap Right `Alt` and `GUI` and save into flash | | ||
48 | |`LGUI` | Disable GUI key - e.g. disable Windows key during gaming | | ||
49 | |`GRAVE` | Swap ' and `ESC` and save into flash | | ||
50 | |`BACKSLASH`| Swap Blackslash and Backspace and save into flash | | ||
51 | |`N` | Enable NKRO (N Key Roll Over) | | ||
52 | |`0` | Make Layer 0 the default layer at bootup, e.g. switch to dvorak | | ||
53 | |`1` | Make Layer 1 the default layer at bootup | | ||
54 | |`2` | Make Layer 2 the default layer at bootup | | ||
55 | |`3` | Make Layer 3 the default layer at bootup | | ||
56 | |`4` | Make Layer 4 the default layer at bootup | | ||
57 | |`5` | Make Layer 5 the default layer at bootup | | ||
58 | |`6` | Make Layer 6 the default layer at bootup | | ||
59 | |`7` | Make Layer 7 the default layer at bootup | | ||
60 | |||
61 | |||
62 | |||
63 | |||
64 | |||