aboutsummaryrefslogtreecommitdiff
path: root/docs/faq_keymap.md
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2018-03-02 09:21:03 -0800
committerGitHub <noreply@github.com>2018-03-02 09:21:03 -0800
commite87c39d3024908d646e2e0d80d0b63e68ac52f87 (patch)
treee6a60089593b7cec0909e7a03da149ca986313bb /docs/faq_keymap.md
parente5c331e7be2ebb062d861876b17d14683c0c3fda (diff)
downloadqmk_firmware-e87c39d3024908d646e2e0d80d0b63e68ac52f87.tar.gz
qmk_firmware-e87c39d3024908d646e2e0d80d0b63e68ac52f87.zip
More thoroughly document Bootmagic and Command (#2455)
Diffstat (limited to 'docs/faq_keymap.md')
-rw-r--r--docs/faq_keymap.md33
1 files changed, 21 insertions, 12 deletions
diff --git a/docs/faq_keymap.md b/docs/faq_keymap.md
index 0fed0445f..674d207aa 100644
--- a/docs/faq_keymap.md
+++ b/docs/faq_keymap.md
@@ -14,6 +14,15 @@ There are 3 standard keyboard layouts in use around the world- ANSI, ISO, and JI
14<!-- Source for this image: http://www.keyboard-layout-editor.com/#/gists/9ce023dc6caadc0cf11c88c782350a8c --> 14<!-- Source for this image: http://www.keyboard-layout-editor.com/#/gists/9ce023dc6caadc0cf11c88c782350a8c -->
15![Keyboard Layout Image](https://i.imgur.com/45m4mRf.png) 15![Keyboard Layout Image](https://i.imgur.com/45m4mRf.png)
16 16
17## Some Of My Keys Are Swapped Or Not Working
18
19QMK has two features, Bootmagic and Command, which allow you to change the behavior of your keyboard on the fly. This includes, but is not limited to, swapping Ctrl/Caps, disabling Gui, swapping Alt/Gui, swapping Backspace/Backslash, disabling all keys, and other behavioral modifications.
20
21As a quick fix try holding down `Space`+`Backspace` while you plug in your keyboard. This will reset the stored settings on your keyboard, returning those keys to normal operation. If that doesn't work look here:
22
23* [Bootmagic](feature_bootmagic.md)
24* [Command](feature_command.md)
25
17## The Menu Key Isn't Working 26## The Menu Key Isn't Working
18 27
19The key found on most modern keyboards that is located between `KC_RGUI` and `KC_RCTL` is actually called `KC_APP`. This is because when that key was invented there was already a key named `MENU` in the relevant standards, so MS chose to call that the `APP` key. 28The key found on most modern keyboards that is located between `KC_RGUI` and `KC_RCTL` is actually called `KC_APP`. This is because when that key was invented there was already a key named `MENU` in the relevant standards, so MS chose to call that the `APP` key.
@@ -22,13 +31,13 @@ The key found on most modern keyboards that is located between `KC_RGUI` and `KC
22Use keycode for Print Screen(`KC_PSCREEN` or `KC_PSCR`) instead of `KC_SYSREQ`. Key combination of 'Alt + Print Screen' is recognized as 'System request'. 31Use keycode for Print Screen(`KC_PSCREEN` or `KC_PSCR`) instead of `KC_SYSREQ`. Key combination of 'Alt + Print Screen' is recognized as 'System request'.
23 32
24See [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) and 33See [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) and
25- http://en.wikipedia.org/wiki/Magic_SysRq_key 34* http://en.wikipedia.org/wiki/Magic_SysRq_key
26- http://en.wikipedia.org/wiki/System_request 35* http://en.wikipedia.org/wiki/System_request
27 36
28## Power Key Doesn't Work 37## Power Key Doesn't Work
29Use `KC_PWR` instead of `KC_POWER` or vice versa. 38Use `KC_PWR` instead of `KC_POWER` or vice versa.
30- `KC_PWR` works with Windows and Linux, not with OSX. 39* `KC_PWR` works with Windows and Linux, not with OSX.
31- `KC_POWER` works with OSX and Linux, not with Windows. 40* `KC_POWER` works with OSX and Linux, not with Windows.
32 41
33More info: http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264 42More info: http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264
34 43
@@ -40,9 +49,9 @@ https://github.com/tmk/tmk_keyboard/issues/67
40Modifier keys or layers can be stuck unless layer switching is configured properly. 49Modifier keys or layers can be stuck unless layer switching is configured properly.
41For Modifier keys and layer actions you have to place `KC_TRANS` on same position of destination layer to unregister the modifier key or return to previous layer on release event. 50For Modifier keys and layer actions you have to place `KC_TRANS` on same position of destination layer to unregister the modifier key or return to previous layer on release event.
42 51
43- https://github.com/tmk/tmk_core/blob/master/doc/keymap.md#31-momentary-switching 52* https://github.com/tmk/tmk_core/blob/master/doc/keymap.md#31-momentary-switching
44- http://geekhack.org/index.php?topic=57008.msg1492604#msg1492604 53* http://geekhack.org/index.php?topic=57008.msg1492604#msg1492604
45- https://github.com/tmk/tmk_keyboard/issues/248 54* https://github.com/tmk/tmk_keyboard/issues/248
46 55
47 56
48## Mechanical Lock Switch Support 57## Mechanical Lock Switch Support
@@ -66,17 +75,17 @@ See this post for example **MACRO** code.
66http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p195620 75http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p195620
67 76
68On **Windows** you can use `AltGr` key or **Alt code**. 77On **Windows** you can use `AltGr` key or **Alt code**.
69- http://en.wikipedia.org/wiki/AltGr_key 78* http://en.wikipedia.org/wiki/AltGr_key
70- http://en.wikipedia.org/wiki/Alt_code 79* http://en.wikipedia.org/wiki/Alt_code
71 80
72On **Mac** OS defines `Option` key combinations. 81On **Mac** OS defines `Option` key combinations.
73- http://en.wikipedia.org/wiki/Option_key#Alternative_keyboard_input 82* http://en.wikipedia.org/wiki/Option_key#Alternative_keyboard_input
74 83
75On **Xorg** you can use `compose` key, instead. 84On **Xorg** you can use `compose` key, instead.
76- http://en.wikipedia.org/wiki/Compose_key 85* http://en.wikipedia.org/wiki/Compose_key
77 86
78And see this for **Unicode** input. 87And see this for **Unicode** input.
79- http://en.wikipedia.org/wiki/Unicode_input 88* http://en.wikipedia.org/wiki/Unicode_input
80 89
81 90
82## Apple/Mac Keyboard `Fn` 91## Apple/Mac Keyboard `Fn`