diff options
| -rw-r--r-- | docs/feature_grave_esc.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/feature_grave_esc.md b/docs/feature_grave_esc.md index c6fa16022..a7261d2dc 100644 --- a/docs/feature_grave_esc.md +++ b/docs/feature_grave_esc.md | |||
| @@ -4,7 +4,11 @@ If you're using a 60% keyboard, or any other layout with no F-row, you will have | |||
| 4 | 4 | ||
| 5 | ## Usage | 5 | ## Usage |
| 6 | 6 | ||
| 7 | Replace the `KC_GRAVE` key in your keymap (usually to the left of the `1` key) with `KC_GESC`. When pressed it will behave like `KC_ESC`, but with Shift or GUI held it will send `KC_GRAVE`. | 7 | Replace the `KC_GRAVE` key in your keymap (usually to the left of the `1` key) with `KC_GESC`. Most of the time this key will output `KC_ESC` when pressed. However, when Shift or GUI are held down it will output `KC_GRV` instead. |
| 8 | |||
| 9 | ## What Your OS Sees | ||
| 10 | |||
| 11 | If Mary presses GESC on her keyboard, the OS will see an KC_ESC character. Now if Mary holds Shift down and presses GESC it will output `~`, or a shifted backtick. Now if she holds GUI/CMD/WIN, it will output a simple <code>`</code> character. | ||
| 8 | 12 | ||
| 9 | ## Keycodes | 13 | ## Keycodes |
| 10 | 14 | ||
| @@ -12,6 +16,10 @@ Replace the `KC_GRAVE` key in your keymap (usually to the left of the `1` key) w | |||
| 12 | |---------|-----------|------------------------------------------------------------------| | 16 | |---------|-----------|------------------------------------------------------------------| |
| 13 | |`KC_GESC`|`GRAVE_ESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| | 17 | |`KC_GESC`|`GRAVE_ESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| |
| 14 | 18 | ||
| 19 | ### Caveats | ||
| 20 | |||
| 21 | * On macOS CMD/GUI + KC_GRV is actually mapped to a hot key so it will not output a backtick. | ||
| 22 | |||
| 15 | ## Configuration | 23 | ## Configuration |
| 16 | 24 | ||
| 17 | There are several possible key combinations this will break, among them Control+Shift+Escape on Windows and Command+Option+Escape on macOS. To work around this, you can `#define` these options in your `config.h`: | 25 | There are several possible key combinations this will break, among them Control+Shift+Escape on Windows and Command+Option+Escape on macOS. To work around this, you can `#define` these options in your `config.h`: |
