diff options
| author | Konstantin Đorđević <vomindoraan@gmail.com> | 2019-07-20 22:21:40 +0200 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-07-20 13:21:40 -0700 |
| commit | a2e91ebec910d31a9f32cc56924ef3d6f0291e72 (patch) | |
| tree | a2727aa99c89025aea5b4fd67fec7aa4b6ae8fea /docs/feature_command.md | |
| parent | a40dbf94e81e44b1e1ecc9f37c48258dde5ced27 (diff) | |
| download | qmk_firmware-a2e91ebec910d31a9f32cc56924ef3d6f0291e72.tar.gz qmk_firmware-a2e91ebec910d31a9f32cc56924ef3d6f0291e72.zip | |
Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348)
* Update IS_COMMAND definition in templates to use MOD_MASK_SHIFT
* Update IS_COMMAND in docs
* Update IS_COMMAND default definition in tmk_core
* Update table in Command docs based on suggestion
Co-Authored-By: fauxpark <fauxpark@gmail.com>
Diffstat (limited to 'docs/feature_command.md')
| -rw-r--r-- | docs/feature_command.md | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/docs/feature_command.md b/docs/feature_command.md index deabedc1c..a4ce3f5ae 100644 --- a/docs/feature_command.md +++ b/docs/feature_command.md | |||
| @@ -16,36 +16,36 @@ To use Command, hold down the key combination defined by the `IS_COMMAND()` macr | |||
| 16 | 16 | ||
| 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. | 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. |
| 18 | 18 | ||
| 19 | |Define |Default |Description | | 19 | |Define |Default |Description | |
| 20 | |------------------------------------|---------------------------------------------------------------------------|------------------------------------------------| | 20 | |------------------------------------|--------------------------------|------------------------------------------------| |
| 21 | |`IS_COMMAND()` |<code>(get_mods() == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)))</code>|The key combination to activate Command | | 21 | |`IS_COMMAND()` |`(get_mods() == MOD_MASK_SHIFT)`|The key combination to activate Command | |
| 22 | |`MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS` |`true` |Set default layer with the Function row | | 22 | |`MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS` |`true` |Set default layer with the Function row | |
| 23 | |`MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS` |`true` |Set default layer with the number keys | | 23 | |`MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS` |`true` |Set default layer with the number keys | |
| 24 | |`MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM`|`false` |Set default layer with `MAGIC_KEY_LAYER0..9` | | 24 | |`MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM`|`false` |Set default layer with `MAGIC_KEY_LAYER0..9` | |
| 25 | |`MAGIC_KEY_DEBUG` |`D` |Toggle debugging over serial | | 25 | |`MAGIC_KEY_DEBUG` |`D` |Toggle debugging over serial | |
| 26 | |`MAGIC_KEY_DEBUG_MATRIX` |`X` |Toggle key matrix debugging | | 26 | |`MAGIC_KEY_DEBUG_MATRIX` |`X` |Toggle key matrix debugging | |
| 27 | |`MAGIC_KEY_DEBUG_KBD` |`K` |Toggle keyboard debugging | | 27 | |`MAGIC_KEY_DEBUG_KBD` |`K` |Toggle keyboard debugging | |
| 28 | |`MAGIC_KEY_DEBUG_MOUSE` |`M` |Toggle mouse debugging | | 28 | |`MAGIC_KEY_DEBUG_MOUSE` |`M` |Toggle mouse debugging | |
| 29 | |`MAGIC_KEY_CONSOLE` |`C` |Enable the Command console | | 29 | |`MAGIC_KEY_CONSOLE` |`C` |Enable the Command console | |
| 30 | |`MAGIC_KEY_VERSION` |`V` |Print the running QMK version to the console | | 30 | |`MAGIC_KEY_VERSION` |`V` |Print the running QMK version to the console | |
| 31 | |`MAGIC_KEY_STATUS` |`S` |Print the current keyboard status to the console| | 31 | |`MAGIC_KEY_STATUS` |`S` |Print the current keyboard status to the console| |
| 32 | |`MAGIC_KEY_HELP` |`H` |Print Command help to the console | | 32 | |`MAGIC_KEY_HELP` |`H` |Print Command help to the console | |
| 33 | |`MAGIC_KEY_HELP_ALT` |`SLASH` |Print Command help to the console (alternate) | | 33 | |`MAGIC_KEY_HELP_ALT` |`SLASH` |Print Command help to the console (alternate) | |
| 34 | |`MAGIC_KEY_LAYER0` |`0` |Make layer 0 the default layer | | 34 | |`MAGIC_KEY_LAYER0` |`0` |Make layer 0 the default layer | |
| 35 | |`MAGIC_KEY_LAYER0_ALT` |`GRAVE` |Make layer 0 the default layer (alternate) | | 35 | |`MAGIC_KEY_LAYER0_ALT` |`GRAVE` |Make layer 0 the default layer (alternate) | |
| 36 | |`MAGIC_KEY_LAYER1` |`1` |Make layer 1 the default layer | | 36 | |`MAGIC_KEY_LAYER1` |`1` |Make layer 1 the default layer | |
| 37 | |`MAGIC_KEY_LAYER2` |`2` |Make layer 2 the default layer | | 37 | |`MAGIC_KEY_LAYER2` |`2` |Make layer 2 the default layer | |
| 38 | |`MAGIC_KEY_LAYER3` |`3` |Make layer 3 the default layer | | 38 | |`MAGIC_KEY_LAYER3` |`3` |Make layer 3 the default layer | |
| 39 | |`MAGIC_KEY_LAYER4` |`4` |Make layer 4 the default layer | | 39 | |`MAGIC_KEY_LAYER4` |`4` |Make layer 4 the default layer | |
| 40 | |`MAGIC_KEY_LAYER5` |`5` |Make layer 5 the default layer | | 40 | |`MAGIC_KEY_LAYER5` |`5` |Make layer 5 the default layer | |
| 41 | |`MAGIC_KEY_LAYER6` |`6` |Make layer 6 the default layer | | 41 | |`MAGIC_KEY_LAYER6` |`6` |Make layer 6 the default layer | |
| 42 | |`MAGIC_KEY_LAYER7` |`7` |Make layer 7 the default layer | | 42 | |`MAGIC_KEY_LAYER7` |`7` |Make layer 7 the default layer | |
| 43 | |`MAGIC_KEY_LAYER8` |`8` |Make layer 8 the default layer | | 43 | |`MAGIC_KEY_LAYER8` |`8` |Make layer 8 the default layer | |
| 44 | |`MAGIC_KEY_LAYER9` |`9` |Make layer 9 the default layer | | 44 | |`MAGIC_KEY_LAYER9` |`9` |Make layer 9 the default layer | |
| 45 | |`MAGIC_KEY_BOOTLOADER` |`B` |Jump to bootloader | | 45 | |`MAGIC_KEY_BOOTLOADER` |`B` |Jump to bootloader | |
| 46 | |`MAGIC_KEY_BOOTLOADER_ALT` |`ESC` |Jump to bootloader (alternate) | | 46 | |`MAGIC_KEY_BOOTLOADER_ALT` |`ESC` |Jump to bootloader (alternate) | |
| 47 | |`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 | |
| 48 | |`MAGIC_KEY_EEPROM` |`E` |Print stored EEPROM config to the console | | 48 | |`MAGIC_KEY_EEPROM` |`E` |Print stored EEPROM config to the console | |
| 49 | |`MAGIC_KEY_EEPROM_CLEAR` |`BSPACE` |Clear the EEPROM | | 49 | |`MAGIC_KEY_EEPROM_CLEAR` |`BSPACE` |Clear the EEPROM | |
| 50 | |`MAGIC_KEY_NKRO` |`N` |Toggle N-Key Rollover (NKRO) | | 50 | |`MAGIC_KEY_NKRO` |`N` |Toggle N-Key Rollover (NKRO) | |
| 51 | |`MAGIC_KEY_SLEEP_LED` |`Z` |Toggle LED when computer is sleeping | | 51 | |`MAGIC_KEY_SLEEP_LED` |`Z` |Toggle LED when computer is sleeping | |