From 0b54e7f5ae90ee36e1149b947562e9f7137ec874 Mon Sep 17 00:00:00 2001 From: skullY Date: Tue, 28 Nov 2017 14:08:32 -0800 Subject: Flesh out the grave escape overrides --- docs/feature_grave_esc.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/feature_grave_esc.md (limited to 'docs/feature_grave_esc.md') diff --git a/docs/feature_grave_esc.md b/docs/feature_grave_esc.md new file mode 100644 index 000000000..ea3c55c63 --- /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. | -- cgit v1.2.3-24-g4f1b