diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_summary.md | 1 | ||||
| -rw-r--r-- | docs/faq_keymap.md | 6 | ||||
| -rw-r--r-- | docs/feature_grave_esc.md | 17 |
3 files changed, 20 insertions, 4 deletions
diff --git a/docs/_summary.md b/docs/_summary.md index 3c10e101d1..2c0fc17e36 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -26,6 +26,7 @@ * [Backlight](feature_backlight.md) * [Bootmagic](feature_bootmagic.md) * [Dynamic Macros](feature_dynamic_macros.md) + * [Grave Escape](feature_grave_escape.md) * [Key Lock](feature_key_lock.md) * [Layouts](feature_layouts.md) * [Leader Key](feature_leader_key.md) diff --git a/docs/faq_keymap.md b/docs/faq_keymap.md index 83eeb235ef..6a364eb538 100644 --- a/docs/faq_keymap.md +++ b/docs/faq_keymap.md @@ -125,11 +125,9 @@ https://github.com/tmk/tmk_keyboard/issues/213 https://github.com/tekezo/Karabiner/issues/403 -## Esc and `~ on a key +## Esc and `~ on a single key -Use `GRAVE_ESC` or `KC_GESC` in your keymap. `GUI`+`GRAVE_ESC` results in `` ` `` and `SHIFT`+`GRAVE_ESC` results in `~`. - -Note that this will break the CTRL+SHIFT+ESC shortcut to the Windows task manager. Use `#define GRAVE_ESC_CTRL_OVERRIDE` in your `config.h` to get the shortcut back. With this option, `ESC_GRAVE` results in `ESC` if `CTRL` is held, even if `SHIFT` or `GUI` are also held. +See the [Grave Escape](feature_grave_escape.md) feature. ## Arrow on Right Modifier keys with Dual-Role This turns right modifer keys into arrow keys when the keys are tapped while still modifiers when the keys are hold. In TMK the dual-role function is dubbed **TAP**. diff --git a/docs/feature_grave_esc.md b/docs/feature_grave_esc.md new file mode 100644 index 0000000000..ea3c55c639 --- /dev/null +++ b/docs/feature_grave_esc.md @@ -0,0 +1,17 @@ +# Grave Escape + +Grave Escape is a feature that allows you to share the grave key (`\`` 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`. + + +| Key | Alias | Description | +|-----|-------|-------------| +| `GRAVE_ESC` | `KC_GESC` | Act as `KC_ESC` normally, or `KC_GRAVE` when GUI or Shift are held. | + +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: + +| Option | Description | +|--------|-------------| +| `GRAVE_ESC_ALT_OVERRIDE` | Always send Escape if Alt is pressed. | +| `GRAVE_ESC_CTRL_OVERRIDE` | Always send Escape if Ctrl is pressed. | +| `GRAVE_ESC_GUI_OVERRIDE` | Always send Escape if GUI is pressed. | +| `GRAVE_ESC_SHIFT_OVERRIDE` | Always send Escape if SHIFT is pressed. | |