summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYan-Fa Li <yanfali@gmail.com>2019-02-15 06:50:28 -0800
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-02-15 06:50:28 -0800
commitf3bdd436a3e8e37e274fcd1147eb13e05b24fe98 (patch)
tree9e9b0517a5170afc4a6a1ee36bd635e503eafefa
parentd04485e32c58503eae857a2b0b8b84ecc2d2880e (diff)
Update KC_GESC documentation (#5053)
* Update KC_GESC documentation - document caveats on OSX and expected behavior with KC_GESC and GUI - clarify documentation slightly - give examples of expected output in actual use * Update OSX -> macOS * Captilization * remove simply
-rw-r--r--docs/feature_grave_esc.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/feature_grave_esc.md b/docs/feature_grave_esc.md
index c6fa160221..a7261d2dc8 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
## Usage
-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`.
+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.
+
+## What Your OS Sees
+
+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>&#96;</code> character.
## Keycodes
@@ -12,6 +16,10 @@ Replace the `KC_GRAVE` key in your keymap (usually to the left of the `1` key) w
|---------|-----------|------------------------------------------------------------------|
|`KC_GESC`|`GRAVE_ESC`|Escape when pressed, <code>&#96;</code> when Shift or GUI are held|
+### Caveats
+
+ * On macOS CMD/GUI + KC_GRV is actually mapped to a hot key so it will not output a backtick.
+
## Configuration
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`: