forked from qmk/qmk_firmware
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Format Grave Escape documentation (qmk#3536)
- Loading branch information
Showing
1 changed file
with
15 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,24 @@ | ||
| # Grave Escape | ||
|
|
||
| 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`. | ||
| 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. | ||
|
|
||
| ## 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`. | ||
|
|
||
| ## Keycodes | ||
|
|
||
| |Key |Aliases |Description | | ||
| |---------|-----------|------------------------------------------------------------------| | ||
| |`KC_GESC`|`GRAVE_ESC`|Escape when pressed, <code>`</code> when Shift or GUI 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: | ||
| ## 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`: | ||
|
|
||
| | 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. | | ||
| |Define |Description | | ||
| |--------------------------|-----------------------------------------| | ||
| |`GRAVE_ESC_ALT_OVERRIDE` |Always send Escape if Alt is pressed | | ||
| |`GRAVE_ESC_CTRL_OVERRIDE` |Always send Escape if Control is pressed | | ||
| |`GRAVE_ESC_GUI_OVERRIDE` |Always send Escape if GUI is pressed | | ||
| |`GRAVE_ESC_SHIFT_OVERRIDE`|Always send Escape if Shift is pressed | |