aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKonstantin Đorđević <vomindoraan@gmail.com>2020-04-12 20:37:55 +0200
committerGitHub <noreply@github.com>2020-04-12 11:37:55 -0700
commit370577e4ed1a714e818bf11cc870e4915f82e93b (patch)
tree86d7ebc5a59caaa2de0576279727ff8dda43c76b /docs
parent6e84247ec2289b66ecbe5ad51643344145587558 (diff)
downloadqmk_firmware-370577e4ed1a714e818bf11cc870e4915f82e93b.tar.gz
qmk_firmware-370577e4ed1a714e818bf11cc870e4915f82e93b.zip
Add *OPT aliases for *ALT keycodes and macros (#8714)
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_advanced_keycodes.md6
-rw-r--r--docs/feature_macros.md4
-rw-r--r--docs/ja/feature_advanced_keycodes.md4
-rw-r--r--docs/keycodes.md12
-rw-r--r--docs/keycodes_basic.md4
-rw-r--r--docs/mod_tap.md4
6 files changed, 17 insertions, 17 deletions
diff --git a/docs/feature_advanced_keycodes.md b/docs/feature_advanced_keycodes.md
index b2abe5dae..b8664074a 100644
--- a/docs/feature_advanced_keycodes.md
+++ b/docs/feature_advanced_keycodes.md
@@ -6,11 +6,11 @@ These allow you to combine a modifier with a keycode. When pressed, the keydown
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)` |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|`RCTL(kc)`| |Hold Right Control and press `kc` | 11|`RCTL(kc)`| |Hold Right Control and press `kc` |
12|`RSFT(kc)`| |Hold Right Shift and press `kc` | 12|`RSFT(kc)`| |Hold Right Shift and press `kc` |
13|`RALT(kc)`|`ALGR(kc)` |Hold Right Alt and press `kc` | 13|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` |
14|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)` |Hold Right GUI and press `kc` | 14|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)` |Hold Right GUI and press `kc` |
15|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)` |Hold Left Shift and GUI and press `kc` | 15|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)` |Hold Left Shift and GUI and press `kc` |
16|`LCA(kc)` | |Hold Left Control and Alt and press `kc` | 16|`LCA(kc)` | |Hold Left Control and Alt and press `kc` |
@@ -18,7 +18,7 @@ These allow you to combine a modifier with a keycode. When pressed, the keydown
18|`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` | 18|`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` |
19|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`| 19|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`|
20 20
21You can also chain them, for example `LCTL(LALT(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress. 21You can also chain them, for example `LCTL(LALT(KC_DEL))` or `C(A(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress.
22 22
23# Legacy Content :id=legacy-content 23# Legacy Content :id=legacy-content
24 24
diff --git a/docs/feature_macros.md b/docs/feature_macros.md
index 1bd2d74e7..1c7705a51 100644
--- a/docs/feature_macros.md
+++ b/docs/feature_macros.md
@@ -161,11 +161,11 @@ There's also a couple of mod shortcuts you can use:
161 161
162* `SS_LCTL(string)` 162* `SS_LCTL(string)`
163* `SS_LSFT(string)` 163* `SS_LSFT(string)`
164* `SS_LALT(string)` 164* `SS_LALT(string)` or `SS_LOPT(string)`
165* `SS_LGUI(string)`, `SS_LCMD(string)` or `SS_LWIN(string)` 165* `SS_LGUI(string)`, `SS_LCMD(string)` or `SS_LWIN(string)`
166* `SS_RCTL(string)` 166* `SS_RCTL(string)`
167* `SS_RSFT(string)` 167* `SS_RSFT(string)`
168* `SS_RALT(string)` or `SS_ALGR(string)` 168* `SS_RALT(string)`, `SS_ROPT(string)` or `SS_ALGR(string)`
169* `SS_RGUI(string)`, `SS_RCMD(string)` or `SS_RWIN(string)` 169* `SS_RGUI(string)`, `SS_RCMD(string)` or `SS_RWIN(string)`
170 170
171These press the respective modifier, send the supplied string and then release the modifier. 171These press the respective modifier, send the supplied string and then release the modifier.
diff --git a/docs/ja/feature_advanced_keycodes.md b/docs/ja/feature_advanced_keycodes.md
index d208d7f92..c6e21feb9 100644
--- a/docs/ja/feature_advanced_keycodes.md
+++ b/docs/ja/feature_advanced_keycodes.md
@@ -54,11 +54,11 @@ QMK を使い始めたばかりの場合は、全てを単純にしたいでし
54|----------|-------------------------------|----------------------------------------------------| 54|----------|-------------------------------|----------------------------------------------------|
55| `LCTL(kc)` | `C(kc)` | 左 Control を押しながら `kc` を押します。 | 55| `LCTL(kc)` | `C(kc)` | 左 Control を押しながら `kc` を押します。 |
56| `LSFT(kc)` | `S(kc)` | 左 Shift を押しながら `kc` を押します。 | 56| `LSFT(kc)` | `S(kc)` | 左 Shift を押しながら `kc` を押します。 |
57| `LALT(kc)` | `A(kc)` | 左 Alt を押しながら `kc`を押します。 | 57| `LALT(kc)` | `A(kc)`, `LOPT(kc)` | 左 Alt を押しながら `kc`を押します。 |
58| `LGUI(kc)` | `G(kc)`, `LCMD(kc)`, `LWIN(kc)` | 左 GUI を押しながら `kc` を押します。 | 58| `LGUI(kc)` | `G(kc)`, `LCMD(kc)`, `LWIN(kc)` | 左 GUI を押しながら `kc` を押します。 |
59| `RCTL(kc)` | | 右 Control を押しながら `kc` を押します。 | 59| `RCTL(kc)` | | 右 Control を押しながら `kc` を押します。 |
60| `RSFT(kc)` | | 右 Shift を押しながら `kc` を押します。 | 60| `RSFT(kc)` | | 右 Shift を押しながら `kc` を押します。 |
61| `RALT(kc)` | `ALGR(kc)` | 右 Alt を押しながら `kc` を押します。 | 61| `RALT(kc)` | `ROPT(kc)`, `ALGR(kc)` | 右 Alt を押しながら `kc` を押します。 |
62| `RGUI(kc)` | `RCMD(kc)`, `LWIN(kc)` | 右 GUI を押しながら `kc` を押します。 | 62| `RGUI(kc)` | `RCMD(kc)`, `LWIN(kc)` | 右 GUI を押しながら `kc` を押します。 |
63| `SGUI(kc)` | `SCMD(kc)`, `SWIN(kc)` | 左 Shift と左 GUI を押しながら `kc` を押します。 | 63| `SGUI(kc)` | `SCMD(kc)`, `SWIN(kc)` | 左 Shift と左 GUI を押しながら `kc` を押します。 |
64| `LCA(kc)` | | 左 Control と左 Alt を押しながら `kc` を押します。 | 64| `LCA(kc)` | | 左 Control と左 Alt を押しながら `kc` を押します。 |
diff --git a/docs/keycodes.md b/docs/keycodes.md
index 1a388f106..18fd81118 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -175,11 +175,11 @@ See also: [Basic Keycodes](keycodes_basic.md)
175|`KC_EXSEL` | |ExSel | 175|`KC_EXSEL` | |ExSel |
176|`KC_LCTRL` |`KC_LCTL` |Left Control | 176|`KC_LCTRL` |`KC_LCTL` |Left Control |
177|`KC_LSHIFT` |`KC_LSFT` |Left Shift | 177|`KC_LSHIFT` |`KC_LSFT` |Left Shift |
178|`KC_LALT` | |Left Alt | 178|`KC_LALT` |`KC_LOPT` |Left Alt (Option) |
179|`KC_LGUI` |`KC_LCMD`, `KC_LWIN` |Left GUI (Windows/Command/Meta key) | 179|`KC_LGUI` |`KC_LCMD`, `KC_LWIN` |Left GUI (Windows/Command/Meta key) |
180|`KC_RCTRL` |`KC_RCTL` |Right Control | 180|`KC_RCTRL` |`KC_RCTL` |Right Control |
181|`KC_RSHIFT` |`KC_RSFT` |Right Shift | 181|`KC_RSHIFT` |`KC_RSFT` |Right Shift |
182|`KC_RALT` |`KC_ALGR` |Right Alt (AltGr) | 182|`KC_RALT` |`KC_ROPT`, `KC_ALGR` |Right Alt (Option/AltGr) |
183|`KC_RGUI` |`KC_RCMD`, `KC_RWIN` |Right GUI (Windows/Command/Meta key) | 183|`KC_RGUI` |`KC_RCMD`, `KC_RWIN` |Right GUI (Windows/Command/Meta key) |
184|`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down | 184|`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down |
185|`KC_SYSTEM_SLEEP` |`KC_SLEP` |System Sleep | 185|`KC_SYSTEM_SLEEP` |`KC_SLEP` |System Sleep |
@@ -378,11 +378,11 @@ See also: [Modifier Keys](feature_advanced_keycodes.md#modifier-keys)
378|----------|-------------------------------|----------------------------------------------------| 378|----------|-------------------------------|----------------------------------------------------|
379|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` | 379|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` |
380|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` | 380|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
381|`LALT(kc)`|`A(kc)` |Hold Left Alt and press `kc` | 381|`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` |
382|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` | 382|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` |
383|`RCTL(kc)`| |Hold Right Control and press `kc` | 383|`RCTL(kc)`| |Hold Right Control and press `kc` |
384|`RSFT(kc)`| |Hold Right Shift and press `kc` | 384|`RSFT(kc)`| |Hold Right Shift and press `kc` |
385|`RALT(kc)`|`ALGR(kc)` |Hold Right Alt and press `kc` | 385|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` |
386|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)` |Hold Right GUI and press `kc` | 386|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)` |Hold Right GUI and press `kc` |
387|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)` |Hold Left Shift and GUI and press `kc` | 387|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)` |Hold Left Shift and GUI and press `kc` |
388|`LCA(kc)` | |Hold Left Control and Alt and press `kc` | 388|`LCA(kc)` | |Hold Left Control and Alt and press `kc` |
@@ -401,11 +401,11 @@ See also: [Mod-Tap](mod_tap.md)
401|`MT(mod, kc)`| |`mod` when held, `kc` when tapped | 401|`MT(mod, kc)`| |`mod` when held, `kc` when tapped |
402|`LCTL_T(kc)` |`CTL_T(kc)` |Left Control when held, `kc` when tapped | 402|`LCTL_T(kc)` |`CTL_T(kc)` |Left Control when held, `kc` when tapped |
403|`LSFT_T(kc)` |`SFT_T(kc)` |Left Shift when held, `kc` when tapped | 403|`LSFT_T(kc)` |`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
404|`LALT_T(kc)` |`ALT_T(kc)` |Left Alt when held, `kc` when tapped | 404|`LALT_T(kc)` |`LOPT_T(kc)`, `ALT_T(kc)`, `OPT_T(kc)` |Left Alt when held, `kc` when tapped |
405|`LGUI_T(kc)` |`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped | 405|`LGUI_T(kc)` |`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped |
406|`RCTL_T(kc)` | |Right Control when held, `kc` when tapped | 406|`RCTL_T(kc)` | |Right Control when held, `kc` when tapped |
407|`RSFT_T(kc)` | |Right Shift when held, `kc` when tapped | 407|`RSFT_T(kc)` | |Right Shift when held, `kc` when tapped |
408|`RALT_T(kc)` |`ALGR_T(kc)` |Right Alt when held, `kc` when tapped | 408|`RALT_T(kc)` |`ROPT_T(kc)`, `ALGR_T(kc)` |Right Alt when held, `kc` when tapped |
409|`RGUI_T(kc)` |`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped | 409|`RGUI_T(kc)` |`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
410|`SGUI_T(kc)` |`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped | 410|`SGUI_T(kc)` |`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped |
411|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped | 411|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped |
diff --git a/docs/keycodes_basic.md b/docs/keycodes_basic.md
index 75d58c1f1..09efc8c9c 100644
--- a/docs/keycodes_basic.md
+++ b/docs/keycodes_basic.md
@@ -112,11 +112,11 @@ The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07
112|-----------|--------------------|------------------------------------| 112|-----------|--------------------|------------------------------------|
113|`KC_LCTRL` |`KC_LCTL` |Left Control | 113|`KC_LCTRL` |`KC_LCTL` |Left Control |
114|`KC_LSHIFT`|`KC_LSFT` |Left Shift | 114|`KC_LSHIFT`|`KC_LSFT` |Left Shift |
115|`KC_LALT` | |Left Alt | 115|`KC_LALT` |`KC_LOPT` |Left Alt (Option) |
116|`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) | 116|`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) |
117|`KC_RCTRL` |`KC_RCTL` |Right Control | 117|`KC_RCTRL` |`KC_RCTL` |Right Control |
118|`KC_RSHIFT`|`KC_RSFT` |Right Shift | 118|`KC_RSHIFT`|`KC_RSFT` |Right Shift |
119|`KC_RALT` |`KC_ALGR` |Right Alt (AltGr) | 119|`KC_RALT` |`KC_ROPT`, `KC_ALGR`|Right Alt (Option/AltGr) |
120|`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)| 120|`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)|
121 121
122## International 122## International
diff --git a/docs/mod_tap.md b/docs/mod_tap.md
index 2b86701ca..ced0beba9 100644
--- a/docs/mod_tap.md
+++ b/docs/mod_tap.md
@@ -31,11 +31,11 @@ For convenience, QMK includes some Mod-Tap shortcuts to make common combinations
31|------------|-----------------------------------------------------------------|-------------------------------------------------------| 31|------------|-----------------------------------------------------------------|-------------------------------------------------------|
32|`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped | 32|`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped |
33|`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped | 33|`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
34|`LALT_T(kc)`|`ALT_T(kc)` |Left Alt when held, `kc` when tapped | 34|`LALT_T(kc)`|`LOPT_T(kc)`, `ALT_T(kc)`, `OPT_T(kc)` |Left Alt when held, `kc` when tapped |
35|`LGUI_T(kc)`|`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped | 35|`LGUI_T(kc)`|`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped |
36|`RCTL_T(kc)`| |Right Control when held, `kc` when tapped | 36|`RCTL_T(kc)`| |Right Control when held, `kc` when tapped |
37|`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped | 37|`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped |
38|`RALT_T(kc)`|`ALGR_T(kc)` |Right Alt when held, `kc` when tapped | 38|`RALT_T(kc)`|`ROPT_T(kc)`, `ALGR_T(kc)` |Right Alt when held, `kc` when tapped |
39|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped | 39|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
40|`SGUI_T(kc)`|`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped | 40|`SGUI_T(kc)`|`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped |
41|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped | 41|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped |