summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2025-07-06 20:30:47 +1000
committerGitHub <noreply@github.com>2025-07-06 20:30:47 +1000
commitbaf0060761db4e0f1d631b00e6057c6763470e78 (patch)
treee89a3e22efd844f350cb4c7d5275f14edd24390b /docs
parent036745e853b512db868b6e226753521f7975d40c (diff)
Deprecate some nonstandard mod & mod-tap keycode aliases (#25437)
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_advanced_keycodes.md60
-rw-r--r--docs/keycodes.md70
-rw-r--r--docs/mod_tap.md6
3 files changed, 68 insertions, 68 deletions
diff --git a/docs/feature_advanced_keycodes.md b/docs/feature_advanced_keycodes.md
index b21accd367..a6f8bc8372 100644
--- a/docs/feature_advanced_keycodes.md
+++ b/docs/feature_advanced_keycodes.md
@@ -2,36 +2,36 @@
2 2
3These allow you to combine a modifier with a keycode. When pressed, the keydown event for the modifier, then `kc` will be sent. On release, the keyup event for `kc`, then the modifier will be sent. 3These allow you to combine a modifier with a keycode. When pressed, the keydown event for the modifier, then `kc` will be sent. On release, the keyup event for `kc`, then the modifier will be sent.
4 4
5|Key |Aliases |Description | 5|Key |Aliases |Description |
6|----------|----------------------------------|-------------------------------------------------------------------------------| 6|----------|-------------------------------|-------------------------------------------------------------------------------|
7|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` | 7|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` |
8|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` | 8|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
9|`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` | 9|`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` |
10|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)` |Hold Left GUI and press `kc` | 10|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` |
11|`LCS(kc)` | |Hold Left Control and Left Shift and press `kc` | 11|`LCS(kc)` | |Hold Left Control and Left Shift and press `kc` |
12|`LCA(kc)` | |Hold Left Control and Left Alt and press `kc` | 12|`LCA(kc)` | |Hold Left Control and Left Alt and press `kc` |
13|`LCG(kc)` | |Hold Left Control and Left GUI and press `kc` | 13|`LCG(kc)` | |Hold Left Control and Left GUI and press `kc` |
14|`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` | 14|`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` |
15|`LSG(kc)` |`SGUI(kc)`, `SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and Left GUI and press `kc` | 15|`LSG(kc)` | |Hold Left Shift and Left GUI and press `kc` |
16|`LAG(kc)` | |Hold Left Alt and Left GUI and press `kc` | 16|`LAG(kc)` | |Hold Left Alt and Left GUI and press `kc` |
17|`LCSG(kc)`| |Hold Left Control, Left Shift and Left GUI and press `kc` | 17|`LCSG(kc)`| |Hold Left Control, Left Shift and Left GUI and press `kc` |
18|`LCAG(kc)`| |Hold Left Control, Left Alt and Left GUI and press `kc` | 18|`LCAG(kc)`| |Hold Left Control, Left Alt and Left GUI and press `kc` |
19|`LSAG(kc)`| |Hold Left Shift, Left Alt and Left GUI and press `kc` | 19|`LSAG(kc)`| |Hold Left Shift, Left Alt and Left GUI and press `kc` |
20|`RCTL(kc)`| |Hold Right Control and press `kc` | 20|`RCTL(kc)`| |Hold Right Control and press `kc` |
21|`RSFT(kc)`| |Hold Right Shift and press `kc` | 21|`RSFT(kc)`| |Hold Right Shift and press `kc` |
22|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` | 22|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` |
23|`RGUI(kc)`|`RCMD(kc)`, `RWIN(kc)` |Hold Right GUI and press `kc` | 23|`RGUI(kc)`|`RCMD(kc)`, `RWIN(kc)` |Hold Right GUI and press `kc` |
24|`RCA(kc)` | |Hold Right Control and Right Alt and press `kc` | 24|`RCA(kc)` | |Hold Right Control and Right Alt and press `kc` |
25|`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` | 25|`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` |
26|`RCG(kc)` | |Hold Right Control and Right GUI and press `kc` | 26|`RCG(kc)` | |Hold Right Control and Right GUI and press `kc` |
27|`RSA(kc)` |`SAGR(kc)` |Hold Right Shift and Right Alt and press `kc` | 27|`RSA(kc)` | |Hold Right Shift and Right Alt and press `kc` |
28|`RSG(kc)` | |Hold Right Shift and Right GUI and press `kc` | 28|`RSG(kc)` | |Hold Right Shift and Right GUI and press `kc` |
29|`RAG(kc)` | |Hold Right Alt and Right GUI and press `kc` | 29|`RAG(kc)` | |Hold Right Alt and Right GUI and press `kc` |
30|`RCSG(kc)`| |Hold Right Control, Right Shift and Right GUI and press `kc` | 30|`RCSG(kc)`| |Hold Right Control, Right Shift and Right GUI and press `kc` |
31|`RCAG(kc)`| |Hold Right Control, Right Alt and Right GUI and press `kc` | 31|`RCAG(kc)`| |Hold Right Control, Right Alt and Right GUI and press `kc` |
32|`RSAG(kc)`| |Hold Right Shift, Right Alt and Right GUI and press `kc` | 32|`RSAG(kc)`| |Hold Right Shift, Right Alt and Right GUI and press `kc` |
33|`MEH(kc)` | |Hold Left Control, Left Shift and Left Alt and press `kc` | 33|`MEH(kc)` | |Hold Left Control, Left Shift and Left Alt and press `kc` |
34|`HYPR(kc)`| |Hold Left Control, Left Shift, Left Alt and Left GUI and press `kc`<sup>1</sup>| 34|`HYPR(kc)`| |Hold Left Control, Left Shift, Left Alt and Left GUI and press `kc`<sup>1</sup>|
35 35
36<sup>1. More information on the Hyper key can be found on [this blog post by Brett Terpstra](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/).</sup> 36<sup>1. More information on the Hyper key can be found on [this blog post by Brett Terpstra](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/).</sup>
37 37
diff --git a/docs/keycodes.md b/docs/keycodes.md
index 33014a54a5..e569e87431 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -657,38 +657,38 @@ See also: [Mouse Keys](features/mouse_keys)
657 657
658See also: [Modifier Keys](feature_advanced_keycodes#modifier-keys) 658See also: [Modifier Keys](feature_advanced_keycodes#modifier-keys)
659 659
660|Key |Aliases |Description | 660|Key |Aliases |Description |
661|----------|----------------------------------|-------------------------------------------------------------------| 661|----------|-------------------------------|-------------------------------------------------------------------|
662|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` | 662|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` |
663|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` | 663|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
664|`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` | 664|`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` |
665|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)` |Hold Left GUI and press `kc` | 665|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` |
666|`LCS(kc)` | |Hold Left Control and Left Shift and press `kc` | 666|`LCS(kc)` | |Hold Left Control and Left Shift and press `kc` |
667|`LCA(kc)` | |Hold Left Control and Left Alt and press `kc` | 667|`LCA(kc)` | |Hold Left Control and Left Alt and press `kc` |
668|`LCG(kc)` | |Hold Left Control and Left GUI and press `kc` | 668|`LCG(kc)` | |Hold Left Control and Left GUI and press `kc` |
669|`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` | 669|`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` |
670|`LSG(kc)` |`SGUI(kc)`, `SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and Left GUI and press `kc` | 670|`LSG(kc)` | |Hold Left Shift and Left GUI and press `kc` |
671|`LAG(kc)` | |Hold Left Alt and Left GUI and press `kc` | 671|`LAG(kc)` | |Hold Left Alt and Left GUI and press `kc` |
672|`LCSG(kc)`| |Hold Left Control, Left Shift and Left GUI and press `kc` | 672|`LCSG(kc)`| |Hold Left Control, Left Shift and Left GUI and press `kc` |
673|`LCAG(kc)`| |Hold Left Control, Left Alt and Left GUI and press `kc` | 673|`LCAG(kc)`| |Hold Left Control, Left Alt and Left GUI and press `kc` |
674|`LSAG(kc)`| |Hold Left Shift, Left Alt and Left GUI and press `kc` | 674|`LSAG(kc)`| |Hold Left Shift, Left Alt and Left GUI and press `kc` |
675|`RCTL(kc)`| |Hold Right Control and press `kc` | 675|`RCTL(kc)`| |Hold Right Control and press `kc` |
676|`RSFT(kc)`| |Hold Right Shift and press `kc` | 676|`RSFT(kc)`| |Hold Right Shift and press `kc` |
677|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` | 677|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` |
678|`RGUI(kc)`|`RCMD(kc)`, `RWIN(kc)` |Hold Right GUI and press `kc` | 678|`RGUI(kc)`|`RCMD(kc)`, `RWIN(kc)` |Hold Right GUI and press `kc` |
679|`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` | 679|`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` |
680|`RCA(kc)` | |Hold Right Control and Right Alt and press `kc` | 680|`RCA(kc)` | |Hold Right Control and Right Alt and press `kc` |
681|`RCG(kc)` | |Hold Right Control and Right GUI and press `kc` | 681|`RCG(kc)` | |Hold Right Control and Right GUI and press `kc` |
682|`RSA(kc)` |`SAGR(kc)` |Hold Right Shift and Right Alt and press `kc` | 682|`RSA(kc)` | |Hold Right Shift and Right Alt and press `kc` |
683|`RSG(kc)` | |Hold Right Shift and Right GUI and press `kc` | 683|`RSG(kc)` | |Hold Right Shift and Right GUI and press `kc` |
684|`RAG(kc)` | |Hold Right Alt and Right GUI and press `kc` | 684|`RAG(kc)` | |Hold Right Alt and Right GUI and press `kc` |
685|`RCSG(kc)`| |Hold Right Control, Right Shift and Right GUI and press `kc` | 685|`RCSG(kc)`| |Hold Right Control, Right Shift and Right GUI and press `kc` |
686|`RCAG(kc)`| |Hold Right Control, Right Alt and Right GUI and press `kc` | 686|`RCAG(kc)`| |Hold Right Control, Right Alt and Right GUI and press `kc` |
687|`RSAG(kc)`| |Hold Right Shift, Right Alt and Right GUI and press `kc` | 687|`RSAG(kc)`| |Hold Right Shift, Right Alt and Right GUI and press `kc` |
688|`MEH(kc)` | |Hold Left Control, Left Shift and Left Alt and press `kc` | 688|`MEH(kc)` | |Hold Left Control, Left Shift and Left Alt and press `kc` |
689|`HYPR(kc)`| |Hold Left Control, Left Shift, Left Alt and Left GUI and press `kc`| 689|`HYPR(kc)`| |Hold Left Control, Left Shift, Left Alt and Left GUI and press `kc`|
690|`KC_MEH` | |Left Control, Left Shift and Left Alt | 690|`KC_MEH` | |Left Control, Left Shift and Left Alt |
691|`KC_HYPR` | |Left Control, Left Shift, Left Alt and Left GUI | 691|`KC_HYPR` | |Left Control, Left Shift, Left Alt and Left GUI |
692 692
693## Mod-Tap Keys {#mod-tap-keys} 693## Mod-Tap Keys {#mod-tap-keys}
694 694
@@ -705,7 +705,7 @@ See also: [Mod-Tap](mod_tap)
705|`LCA_T(kc)` | |Left Control and Left Alt when held, `kc` when tapped | 705|`LCA_T(kc)` | |Left Control and Left Alt when held, `kc` when tapped |
706|`LCG_T(kc)` | |Left Control and Left GUI when held, `kc` when tapped | 706|`LCG_T(kc)` | |Left Control and Left GUI when held, `kc` when tapped |
707|`LSA_T(kc)` | |Left Shift and Left Alt when held, `kc` when tapped | 707|`LSA_T(kc)` | |Left Shift and Left Alt when held, `kc` when tapped |
708|`LSG_T(kc)` |`SGUI_T(kc)`, `SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and Left GUI when held, `kc` when tapped | 708|`LSG_T(kc)` | |Left Shift and Left GUI when held, `kc` when tapped |
709|`LAG_T(kc)` | |Left Alt and Left GUI when held, `kc` when tapped | 709|`LAG_T(kc)` | |Left Alt and Left GUI when held, `kc` when tapped |
710|`LCSG_T(kc)` | |Left Control, Left Shift and Left GUI when held, `kc` when tapped | 710|`LCSG_T(kc)` | |Left Control, Left Shift and Left GUI when held, `kc` when tapped |
711|`LCAG_T(kc)` | |Left Control, Left Alt and Left GUI when held, `kc` when tapped | 711|`LCAG_T(kc)` | |Left Control, Left Alt and Left GUI when held, `kc` when tapped |
@@ -717,14 +717,14 @@ See also: [Mod-Tap](mod_tap)
717|`RCS_T(kc)` | |Right Control and Right Shift when held, `kc` when tapped | 717|`RCS_T(kc)` | |Right Control and Right Shift when held, `kc` when tapped |
718|`RCA_T(kc)` | |Right Control and Right Alt when held, `kc` when tapped | 718|`RCA_T(kc)` | |Right Control and Right Alt when held, `kc` when tapped |
719|`RCG_T(kc)` | |Right Control and Right GUI when held, `kc` when tapped | 719|`RCG_T(kc)` | |Right Control and Right GUI when held, `kc` when tapped |
720|`RSA_T(kc)` |`SAGR_T(kc)` |Right Shift and Right Alt when held, `kc` when tapped | 720|`RSA_T(kc)` | |Right Shift and Right Alt when held, `kc` when tapped |
721|`RSG_T(kc)` | |Right Shift and Right GUI when held, `kc` when tapped | 721|`RSG_T(kc)` | |Right Shift and Right GUI when held, `kc` when tapped |
722|`RAG_T(kc)` | |Right Alt and Right GUI when held, `kc` when tapped | 722|`RAG_T(kc)` | |Right Alt and Right GUI when held, `kc` when tapped |
723|`RCSG_T(kc)` | |Right Control, Right Shift and Right GUI when held, `kc` when tapped | 723|`RCSG_T(kc)` | |Right Control, Right Shift and Right GUI when held, `kc` when tapped |
724|`RCAG_T(kc)` | |Right Control, Right Alt and Right GUI when held, `kc` when tapped | 724|`RCAG_T(kc)` | |Right Control, Right Alt and Right GUI when held, `kc` when tapped |
725|`RSAG_T(kc)` | |Right Shift, Right Alt and Right GUI when held, `kc` when tapped | 725|`RSAG_T(kc)` | |Right Shift, Right Alt and Right GUI when held, `kc` when tapped |
726|`MEH_T(kc)` | |Left Control, Left Shift and Left Alt when held, `kc` when tapped | 726|`MEH_T(kc)` | |Left Control, Left Shift and Left Alt when held, `kc` when tapped |
727|`HYPR_T(kc)` |`ALL_T(kc)` |Left Control, Left Shift, Left Alt and Left GUI when held, `kc` when tapped| 727|`HYPR_T(kc)` | |Left Control, Left Shift, Left Alt and Left GUI when held, `kc` when tapped|
728 728
729## Tapping Term Keys {#tapping-term-keys} 729## Tapping Term Keys {#tapping-term-keys}
730 730
diff --git a/docs/mod_tap.md b/docs/mod_tap.md
index ebf79adb7f..67922c0915 100644
--- a/docs/mod_tap.md
+++ b/docs/mod_tap.md
@@ -37,7 +37,7 @@ For convenience, QMK includes some Mod-Tap shortcuts to make common combinations
37|`LCA_T(kc)` | |Left Control and Left Alt when held, `kc` when tapped | 37|`LCA_T(kc)` | |Left Control and Left Alt when held, `kc` when tapped |
38|`LCG_T(kc)` | |Left Control and Left GUI when held, `kc` when tapped | 38|`LCG_T(kc)` | |Left Control and Left GUI when held, `kc` when tapped |
39|`LSA_T(kc)` | |Left Shift and Left Alt when held, `kc` when tapped | 39|`LSA_T(kc)` | |Left Shift and Left Alt when held, `kc` when tapped |
40|`LSG_T(kc)` |`SGUI_T(kc)`, `SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and Left GUI when held, `kc` when tapped | 40|`LSG_T(kc)` | |Left Shift and Left GUI when held, `kc` when tapped |
41|`LAG_T(kc)` | |Left Alt and Left GUI when held, `kc` when tapped | 41|`LAG_T(kc)` | |Left Alt and Left GUI when held, `kc` when tapped |
42|`LCSG_T(kc)`| |Left Control, Left Shift and Left GUI when held, `kc` when tapped | 42|`LCSG_T(kc)`| |Left Control, Left Shift and Left GUI when held, `kc` when tapped |
43|`LCAG_T(kc)`| |Left Control, Left Alt and Left GUI when held, `kc` when tapped | 43|`LCAG_T(kc)`| |Left Control, Left Alt and Left GUI when held, `kc` when tapped |
@@ -49,14 +49,14 @@ For convenience, QMK includes some Mod-Tap shortcuts to make common combinations
49|`RCS_T(kc)` | |Right Control and Right Shift when held, `kc` when tapped | 49|`RCS_T(kc)` | |Right Control and Right Shift when held, `kc` when tapped |
50|`RCA_T(kc)` | |Right Control and Right Alt when held, `kc` when tapped | 50|`RCA_T(kc)` | |Right Control and Right Alt when held, `kc` when tapped |
51|`RCG_T(kc)` | |Right Control and Right GUI when held, `kc` when tapped | 51|`RCG_T(kc)` | |Right Control and Right GUI when held, `kc` when tapped |
52|`RSA_T(kc)` |`SAGR_T(kc)` |Right Shift and Right Alt when held, `kc` when tapped | 52|`RSA_T(kc)` | |Right Shift and Right Alt when held, `kc` when tapped |
53|`RSG_T(kc)` | |Right Shift and Right GUI when held, `kc` when tapped | 53|`RSG_T(kc)` | |Right Shift and Right GUI when held, `kc` when tapped |
54|`RAG_T(kc)` | |Right Alt and Right GUI when held, `kc` when tapped | 54|`RAG_T(kc)` | |Right Alt and Right GUI when held, `kc` when tapped |
55|`RCSG_T(kc)`| |Right Control, Right Shift and Right GUI when held, `kc` when tapped | 55|`RCSG_T(kc)`| |Right Control, Right Shift and Right GUI when held, `kc` when tapped |
56|`RCAG_T(kc)`| |Right Control, Right Alt and Right GUI when held, `kc` when tapped | 56|`RCAG_T(kc)`| |Right Control, Right Alt and Right GUI when held, `kc` when tapped |
57|`RSAG_T(kc)`| |Right Shift, Right Alt and Right GUI when held, `kc` when tapped | 57|`RSAG_T(kc)`| |Right Shift, Right Alt and Right GUI when held, `kc` when tapped |
58|`MEH_T(kc)` | |Left Control, Left Shift and Left Alt when held, `kc` when tapped | 58|`MEH_T(kc)` | |Left Control, Left Shift and Left Alt when held, `kc` when tapped |
59|`HYPR_T(kc)`|`ALL_T(kc)` |Left Control, Left Shift, Left Alt and Left GUI when held, `kc` when tapped<sup>1</sup>| 59|`HYPR_T(kc)`| |Left Control, Left Shift, Left Alt and Left GUI when held, `kc` when tapped<sup>1</sup>|
60 60
61<sup>1. More information on the Hyper key can be found on [this blog post by Brett Terpstra](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/).</sup> 61<sup>1. More information on the Hyper key can be found on [this blog post by Brett Terpstra](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/).</sup>
62 62