diff options
| -rw-r--r-- | docs/feature_grave_esc.md | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/docs/feature_grave_esc.md b/docs/feature_grave_esc.md index a8e45f3a9..c6fa16022 100644 --- a/docs/feature_grave_esc.md +++ b/docs/feature_grave_esc.md | |||
| @@ -1,17 +1,24 @@ | |||
| 1 | # Grave Escape | 1 | # Grave Escape |
| 2 | 2 | ||
| 3 | Grave Escape is a feature that allows you to share the grave key (<code>`</code> and `~`) on the same key as Escape. When `KC_GESC` is used it will act as `KC_ESC`, unless Shift or GUI is pressed, in which case it will act as `KC_GRAVE`. | 3 | If you're using a 60% keyboard, or any other layout with no F-row, you will have noticed that there is no dedicated Escape key. Grave Escape is a feature that allows you to share the grave key (<code>`</code> and `~`) with Escape. |
| 4 | 4 | ||
| 5 | ## Usage | ||
| 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`. | ||
| 8 | |||
| 9 | ## Keycodes | ||
| 5 | 10 | ||
| 6 | |Key |Aliases |Description | | 11 | |Key |Aliases |Description | |
| 7 | |---------|-----------|------------------------------------------------------------------| | 12 | |---------|-----------|------------------------------------------------------------------| |
| 8 | |`KC_GESC`|`GRAVE_ESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| | 13 | |`KC_GESC`|`GRAVE_ESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| |
| 9 | 14 | ||
| 10 | There are several possible key combinations this will break, among them Ctrl+Shift+Esc on Windows and Cmd+Opt+Esc on macOS. You can use these options in your `config.h` to work around this: | 15 | ## Configuration |
| 16 | |||
| 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`: | ||
| 11 | 18 | ||
| 12 | | Option | Description | | 19 | |Define |Description | |
| 13 | |--------|-------------| | 20 | |--------------------------|-----------------------------------------| |
| 14 | | `GRAVE_ESC_ALT_OVERRIDE` | Always send Escape if Alt is pressed. | | 21 | |`GRAVE_ESC_ALT_OVERRIDE` |Always send Escape if Alt is pressed | |
| 15 | | `GRAVE_ESC_CTRL_OVERRIDE` | Always send Escape if Ctrl is pressed. | | 22 | |`GRAVE_ESC_CTRL_OVERRIDE` |Always send Escape if Control is pressed | |
| 16 | | `GRAVE_ESC_GUI_OVERRIDE` | Always send Escape if GUI is pressed. | | 23 | |`GRAVE_ESC_GUI_OVERRIDE` |Always send Escape if GUI is pressed | |
| 17 | | `GRAVE_ESC_SHIFT_OVERRIDE` | Always send Escape if SHIFT is pressed. | | 24 | |`GRAVE_ESC_SHIFT_OVERRIDE`|Always send Escape if Shift is pressed | |