diff options
| author | skullY <skullydazed@gmail.com> | 2017-11-28 14:08:32 -0800 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-12-03 00:00:23 -0500 |
| commit | 0b54e7f5ae90ee36e1149b947562e9f7137ec874 (patch) | |
| tree | 7118649a9e93f2edeaa1b64d12f73641b8ca65df /docs/feature_grave_esc.md | |
| parent | 8cac6088c694474908a8237497026e090aaf4a35 (diff) | |
| download | qmk_firmware-0b54e7f5ae90ee36e1149b947562e9f7137ec874.tar.gz qmk_firmware-0b54e7f5ae90ee36e1149b947562e9f7137ec874.zip | |
Flesh out the grave escape overrides
Diffstat (limited to 'docs/feature_grave_esc.md')
| -rw-r--r-- | docs/feature_grave_esc.md | 17 |
1 files changed, 17 insertions, 0 deletions
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. | |