diff options
| author |  Joe Wasson <jwasson+github@gmail.com> | 2018-03-11 16:53:35 -0700 |
|---|---|---|
| committer |  Jack Humbert <jack.humb@gmail.com> | 2018-03-16 16:33:43 -0400 |
| commit | 23ac2a02ef870dce91318a4d98e3c8ec5749bced (patch) | |
| tree | 302f61696ce319d635c17e919ec6d8acf264d2ab /docs/keycodes.md | |
| parent | 7230923b051bdb32bea19c3d732fa1fbc4883a68 (diff) | |
| download | qmk_firmware-23ac2a02ef870dce91318a4d98e3c8ec5749bced.tar.gz | |
Add keycodes for swap-hands feature.
Diffstat (limited to 'docs/keycodes.md')
| -rw-r--r-- | docs/keycodes.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md index 030b23827..21a722250 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md @@ -390,3 +390,15 @@ This is a reference only. Each group of keys links to the page documenting their |------------|-------|-------------------------------------------------| |`UNICODE(n)`|`UC(n)`|Send Unicode character `n` | |`X(n)` | |Send Unicode character `n` via a different method| + +## [Swap Hands](feature_swap_hands.md) + +|Key |Description | +|-----------|-------------------------------------------------------------------------| +|`SH_T(key)`|Sends `key` with a tap; momentary swap when held. | +|`SW_ON` |Turns on swapping and leaves it on. | +|`SW_OFF` |Turn off swapping and leaves it off. Good for returning to a known state.| +|`SH_MON` |Swaps hands when pressed, returns to normal when released (momentary). | +|`SH_MOFF` |Momentarily turns off swap. | +|`SH_TG` |Toggles swap on and off with every key press. | +|`SH_TT` |Toggles with a tap; momentary when held. | |