diff options
| author | fauxpark <fauxpark@gmail.com> | 2018-07-30 01:42:51 +1000 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2018-07-29 08:42:51 -0700 |
| commit | f2ebafcee8b9f672b7ea5a5fcd93a319397008a1 (patch) | |
| tree | b6d2c0ef26fe792dbb4d7ff7bbaba5771aebe47d /docs/feature_command.md | |
| parent | 595f3cbe5bb06eab583352a047c89859a6fa0753 (diff) | |
| download | qmk_firmware-f2ebafcee8b9f672b7ea5a5fcd93a319397008a1.tar.gz qmk_firmware-f2ebafcee8b9f672b7ea5a5fcd93a319397008a1.zip | |
Docs: Make Bootmagic and Command docs a little easier to read (#3499)
* Make Bootmagic and Command docs a little easier to read
* Sometimes Bootmagic/Command is default on
* "Escape" pipe character so it renders correctly
Diffstat (limited to 'docs/feature_command.md')
| -rw-r--r-- | docs/feature_command.md | 84 |
1 files changed, 41 insertions, 43 deletions
diff --git a/docs/feature_command.md b/docs/feature_command.md index ad987aaf6..1e03f7ebd 100644 --- a/docs/feature_command.md +++ b/docs/feature_command.md | |||
| @@ -1,52 +1,50 @@ | |||
| 1 | # Command (Formerly known as Magic) | 1 | # Command |
| 2 | 2 | ||
| 3 | Command is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic](feature_bootmagic.md). There is a lot of overlap between this functionality and the [Bootmagic Keycodes](feature_bootmagic.md). Whenever possible we encourage you to use that functionality instead of Command. | 3 | Command, formerly known as Magic, is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic](feature_bootmagic.md). There is a lot of overlap between this functionality and the [Bootmagic Keycodes](feature_bootmagic.md#keycodes). Wherever possible we encourage you to use that feature instead of Command. |
| 4 | 4 | ||
| 5 | ## Enabling Command | 5 | On some keyboards Command is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk`: |
| 6 | 6 | ||
| 7 | By default Command is disabled. You can enable it in your `rules.mk` file: | 7 | ```make |
| 8 | 8 | COMMAND_ENABLE = yes | |
| 9 | COMMAND_ENABLE = yes | 9 | ``` |
| 10 | 10 | ||
| 11 | ## Usage | 11 | ## Usage |
| 12 | 12 | ||
| 13 | To use Command you hold down the key combination defined by `IS_COMMAND`. By default that combination is both shift keys. While holding the key combination press the key corresponding to the command you want. | 13 | To use Command, hold down the key combination defined by the `IS_COMMAND()` macro. By default this is Left Shift+Right Shift. Then, press the key corresponding to the command you want. For example, to output the current QMK version to the QMK Toolbox console, press Left Shift+Right Shift+`V`. |
| 14 | |||
| 15 | For example, to write the current QMK version to the QMK Toolbox console, you can press `Left Shift`+`Right Shift`+`V`. | ||
| 16 | 14 | ||
| 17 | ## Configuration | 15 | ## Configuration |
| 18 | 16 | ||
| 19 | The following values can be defined in `config.h` to control the behavior of Command. | 17 | If you would like to change the key assignments for Command, `#define` these in your `config.h` at either the keyboard or keymap level. All keycode assignments here must omit the `KC_` prefix. |
| 20 | 18 | ||
| 21 | |Define |Default | Description | | 19 | |Define |Default |Description | |
| 22 | |-------|--------|-------------| | 20 | |------------------------------------|----------------------------------------------------------------------------------------|------------------------------------------------| |
| 23 | |`IS_COMMAND()` |`(keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)))`|Key combination to activate Command| | 21 | |`IS_COMMAND()` |`(keyboard_report->mods == (MOD_BIT(KC_LSHIFT) <code>|</code> MOD_BIT(KC_RSHIFT)))`|The key combination to activate Command | |
| 24 | |`MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS` |`true` |Do layer switching with Function row| | 22 | |`MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS` |`true` |Set default layer with the Function row | |
| 25 | |`MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS` |`true` |Do layer switching with number keys.| | 23 | |`MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS` |`true` |Set default layer with the number keys | |
| 26 | |`MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM`|`false` |Do layer switching with custom keys (`MAGIC_KEY_LAYER0..9` below.)| | 24 | |`MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM`|`false` |Set default layer with `MAGIC_KEY_LAYER0..9` | |
| 27 | |`MAGIC_KEY_HELP1` |`H` |Show help.| | 25 | |`MAGIC_KEY_DEBUG` |`D` |Toggle debugging over serial | |
| 28 | |`MAGIC_KEY_HELP2` |`SLASH` |Show help.| | 26 | |`MAGIC_KEY_DEBUG_MATRIX` |`X` |Toggle key matrix debugging | |
| 29 | |`MAGIC_KEY_DEBUG` |`D` |Turn on debug mode.| | 27 | |`MAGIC_KEY_DEBUG_KBD` |`K` |Toggle keyboard debugging | |
| 30 | |`MAGIC_KEY_DEBUG_MATRIX` |`X` |Turn on matrix debugging.| | 28 | |`MAGIC_KEY_DEBUG_MOUSE` |`M` |Toggle mouse debugging | |
| 31 | |`MAGIC_KEY_DEBUG_KBD` |`K` |Turn on keyboard debugging.| | 29 | |`MAGIC_KEY_CONSOLE` |`C` |Enable the Command console | |
| 32 | |`MAGIC_KEY_DEBUG_MOUSE` |`M` |Turn on mouse debugging.| | 30 | |`MAGIC_KEY_VERSION` |`V` |Print the running QMK version to the console | |
| 33 | |`MAGIC_KEY_VERSION` |`V` |Write the QMK version to the console| | 31 | |`MAGIC_KEY_STATUS` |`S` |Print the current keyboard status to the console| |
| 34 | |`MAGIC_KEY_STATUS` |`S` |Show the current keyboard status| | 32 | |`MAGIC_KEY_HELP1` |`H` |Print Command help to the console | |
| 35 | |`MAGIC_KEY_CONSOLE` |`C` |Enable the Command Console| | 33 | |`MAGIC_KEY_HELP2` |`SLASH` |Print Command help to the console (alternate) | |
| 36 | |`MAGIC_KEY_LAYER0_ALT1` |`ESC` |Alternate access to layer 0| | 34 | |`MAGIC_KEY_LAYER0` |`0` |Make layer 0 the default layer | |
| 37 | |`MAGIC_KEY_LAYER0_ALT2` |`GRAVE` |Alternate access to layer 0| | 35 | |`MAGIC_KEY_LAYER1` |`1` |Make layer 1 the default layer | |
| 38 | |`MAGIC_KEY_LAYER0` |`0` |Change default layer to 0| | 36 | |`MAGIC_KEY_LAYER2` |`2` |Make layer 2 the default layer | |
| 39 | |`MAGIC_KEY_LAYER1` |`1` |Change default layer to 1| | 37 | |`MAGIC_KEY_LAYER3` |`3` |Make layer 3 the default layer | |
| 40 | |`MAGIC_KEY_LAYER2` |`2` |Change default layer to 2| | 38 | |`MAGIC_KEY_LAYER4` |`4` |Make layer 4 the default layer | |
| 41 | |`MAGIC_KEY_LAYER3` |`3` |Change default layer to 3| | 39 | |`MAGIC_KEY_LAYER5` |`5` |Make layer 5 the default layer | |
| 42 | |`MAGIC_KEY_LAYER4` |`4` |Change default layer to 4| | 40 | |`MAGIC_KEY_LAYER6` |`6` |Make layer 6 the default layer | |
| 43 | |`MAGIC_KEY_LAYER5` |`5` |Change default layer to 5| | 41 | |`MAGIC_KEY_LAYER7` |`7` |Make layer 7 the default layer | |
| 44 | |`MAGIC_KEY_LAYER6` |`6` |Change default layer to 6| | 42 | |`MAGIC_KEY_LAYER8` |`8` |Make layer 8 the default layer | |
| 45 | |`MAGIC_KEY_LAYER7` |`7` |Change default layer to 7| | 43 | |`MAGIC_KEY_LAYER9` |`9` |Make layer 9 the default layer | |
| 46 | |`MAGIC_KEY_LAYER8` |`8` |Change default layer to 8| | 44 | |`MAGIC_KEY_LAYER0_ALT1` |`ESC` |Make layer 0 the default layer (alternate) | |
| 47 | |`MAGIC_KEY_LAYER9` |`9` |Change default layer to 9| | 45 | |`MAGIC_KEY_LAYER0_ALT2` |`GRAVE` |Make layer 0 the default layer (alternate) | |
| 48 | |`MAGIC_KEY_BOOTLOADER` |`PAUSE` |Exit keyboard and enter bootloader| | 46 | |`MAGIC_KEY_BOOTLOADER` |`PAUSE` |Enter the bootloader | |
| 49 | |`MAGIC_KEY_LOCK` |`CAPS` |Lock the keyboard so nothing can be typed| | 47 | |`MAGIC_KEY_LOCK` |`CAPS` |Lock the keyboard so nothing can be typed | |
| 50 | |`MAGIC_KEY_EEPROM` |`E` |Erase EEPROM settings| | 48 | |`MAGIC_KEY_EEPROM` |`E` |Clear the EEPROM | |
| 51 | |`MAGIC_KEY_NKRO` |`N` |Toggle NKRO on/off| | 49 | |`MAGIC_KEY_NKRO` |`N` |Toggle N-Key Rollover (NKRO) | |
| 52 | |`MAGIC_KEY_SLEEP_LED` |`Z` |Toggle LED when computer is sleeping on/off| | 50 | |`MAGIC_KEY_SLEEP_LED` |`Z` |Toggle LED when computer is sleeping | |