mh
/
qmk_firmware
mirror of https://github.com/qmk/qmk_firmware/
1
0
Fork 0
Code Issues 0 Projects 0 Releases 1.6k Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
17162 Commits
64 Branches
6.1 GiB
Tree: a03aa301de
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'a03aa301de'
${ noResults }
qmk_firmware/docs/feature_command.md

51 lines
4.9 KiB
Raw Normal View History

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
5 years ago
More thoroughly document Bootmagic and Command (#2455)
6 years ago
Remove Full Bootmagic (#13846) * disambiguate Bootmagic rules in keymaps The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic. This commit edits the files to specify that full Bootmagic is intended. * remove BOOTMAGIC_ENABLE=full setting * unify commented BOOTMAGIC_ENABLE rules in keyboards Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;#[ \t]*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).*;\1 = no # Virtual DIP switch configuration;g' {} + ``` * remove commented Bootmagic rules from keymap/user level Command: ``` find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*/d' {} + ``` * update keyboard BOOTMAGIC_ENABLE rule formatting Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later). Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' + ``` * update keyboards' BOOTMAGIC_ENABLE settings Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' + ``` * update keymap/user BOOTMAGIC_ENABLE settings Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + ``` * remove and replace inline comments in keyboards and keymap/user files Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1 # Enable Bootmagic Lite;g' '{}' + ``` * rename improperly named makefiles Some files intended to be used as makefiles had improper names causing them to not be used as intended when building. This commit corrects the filenames of the affected files. * update renamed file with new rule formatting * update QMK's template files Updates QMK's `rules.mk` templates to use the new inline comment. * update QMK Docs - remove documentation of full Bootmagic - update links to Bootmagic Lite doc - add doc for Magic Keycodes * rules.mk patch for coarse/ixora and coarse/vinta
2 years ago
More thoroughly document Bootmagic and Command (#2455)
6 years ago
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
5 years ago
More thoroughly document Bootmagic and Command (#2455)
6 years ago
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
5 years ago
​
​
More thoroughly document Bootmagic and Command (#2455)
6 years ago
​
​
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
5 years ago
More thoroughly document Bootmagic and Command (#2455)
6 years ago
​
​
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
5 years ago
​
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>
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. # Command

  2. 

  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 Lite](feature_bootmagic.md). There is a lot of overlap between this functionality and the [Magic Keycodes](keycodes_magic.md). Wherever possible we encourage you to use that feature instead of Command.
  4. 

  5. On some keyboards Command is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk`:
  6. 

  7. ```make
  8. COMMAND_ENABLE = yes
  9. ```
  10. 

  11. ## Usage

  12. 

  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. ## Configuration

  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.
  18. 

  19. |Define                              |Default                         |Description                                     |
  20. |------------------------------------|--------------------------------|------------------------------------------------|
  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         |
  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`    |
  25. |`MAGIC_KEY_DEBUG`                   |`D`                             |Toggle debugging over serial                    |
  26. |`MAGIC_KEY_DEBUG_MATRIX`            |`X`                             |Toggle key matrix debugging                     |
  27. |`MAGIC_KEY_DEBUG_KBD`               |`K`                             |Toggle keyboard debugging                       |
  28. |`MAGIC_KEY_DEBUG_MOUSE`             |`M`                             |Toggle mouse debugging                          |
  29. |`MAGIC_KEY_CONSOLE`                 |`C`                             |Enable the Command 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|
  32. |`MAGIC_KEY_HELP`                    |`H`                             |Print Command help to the console               |
  33. |`MAGIC_KEY_HELP_ALT`                |`SLASH`                         |Print Command help to the console (alternate)   |
  34. |`MAGIC_KEY_LAYER0`                  |`0`                             |Make layer 0 the default layer                  |
  35. |`MAGIC_KEY_LAYER0_ALT`              |`GRAVE`                         |Make layer 0 the default layer (alternate)      |
  36. |`MAGIC_KEY_LAYER1`                  |`1`                             |Make layer 1 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                  |
  39. |`MAGIC_KEY_LAYER4`                  |`4`                             |Make layer 4 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                  |
  42. |`MAGIC_KEY_LAYER7`                  |`7`                             |Make layer 7 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                  |
  45. |`MAGIC_KEY_BOOTLOADER`              |`B`                             |Jump to bootloader                              |
  46. |`MAGIC_KEY_BOOTLOADER_ALT`          |`ESC`                           |Jump to bootloader (alternate)                  |
  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       |
  49. |`MAGIC_KEY_EEPROM_CLEAR`            |`BSPACE`                        |Clear the EEPROM                                |
  50. |`MAGIC_KEY_NKRO`                    |`N`                             |Toggle N-Key Rollover (NKRO)                    |
  51. |`MAGIC_KEY_SLEEP_LED`               |`Z`                             |Toggle LED when computer is sleeping            |