aboutsummaryrefslogtreecommitdiff
path: root/docs/keycodes.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/keycodes.md')
-rw-r--r--docs/keycodes.md81
1 files changed, 37 insertions, 44 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md
index dbafecb82..6d8525393 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -141,9 +141,9 @@ This is a reference only. Each group of keys links to the page documenting their
141|`KC_LOCKING_SCROLL` |`KC_LSCR` |Locking Scroll Lock | 141|`KC_LOCKING_SCROLL` |`KC_LSCR` |Locking Scroll Lock |
142|`KC_KP_COMMA` |`KC_PCMM` |Keypad `,` | 142|`KC_KP_COMMA` |`KC_PCMM` |Keypad `,` |
143|`KC_KP_EQUAL_AS400` | |Keypad `=` on AS/400 keyboards | 143|`KC_KP_EQUAL_AS400` | |Keypad `=` on AS/400 keyboards |
144|`KC_INT1` |`KC_RO` |JIS `\` and <code>&#124;</code> | 144|`KC_INT1` |`KC_RO` |JIS `\` and `_` |
145|`KC_INT2` |`KC_KANA` |JIS Katakana/Hiragana | 145|`KC_INT2` |`KC_KANA` |JIS Katakana/Hiragana |
146|`KC_INT3` |`KC_JYEN` |JIS `¥` | 146|`KC_INT3` |`KC_JYEN` |JIS `¥` and <code>&#124;</code> |
147|`KC_INT4` |`KC_HENK` |JIS Henkan | 147|`KC_INT4` |`KC_HENK` |JIS Henkan |
148|`KC_INT5` |`KC_MHEN` |JIS Muhenkan | 148|`KC_INT5` |`KC_MHEN` |JIS Muhenkan |
149|`KC_INT6` | |JIS Numpad `,` | 149|`KC_INT6` | |JIS Numpad `,` |
@@ -177,7 +177,7 @@ This is a reference only. Each group of keys links to the page documenting their
177|`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) | 177|`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) |
178|`KC_RCTRL` |`KC_RCTL` |Right Control | 178|`KC_RCTRL` |`KC_RCTL` |Right Control |
179|`KC_RSHIFT` |`KC_RSFT` |Right Shift | 179|`KC_RSHIFT` |`KC_RSFT` |Right Shift |
180|`KC_RALT` | |Right Alt | 180|`KC_RALT` |`KC_ALGR` |Right Alt (AltGr) |
181|`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key) | 181|`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key) |
182|`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down | 182|`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down |
183|`KC_SYSTEM_SLEEP` |`KC_SLEP` |System Sleep | 183|`KC_SYSTEM_SLEEP` |`KC_SLEP` |System Sleep |
@@ -203,29 +203,32 @@ This is a reference only. Each group of keys links to the page documenting their
203|`KC_WWW_FAVORITES` |`KC_WFAV` |Browser Favorites (Windows) | 203|`KC_WWW_FAVORITES` |`KC_WFAV` |Browser Favorites (Windows) |
204|`KC_MEDIA_FAST_FORWARD`|`KC_MFFD` |Next Track (macOS) | 204|`KC_MEDIA_FAST_FORWARD`|`KC_MFFD` |Next Track (macOS) |
205|`KC_MEDIA_REWIND` |`KC_MRWD` |Previous Track (macOS) | 205|`KC_MEDIA_REWIND` |`KC_MRWD` |Previous Track (macOS) |
206|`KC_BRIGHTNESS_UP` |`KC_BRIU` |Brightness Up |
207|`KC_BRIGHTNESS_DOWN` |`KC_BRID` |Brightness Down |
206 208
207## [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes) 209## [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes)
208 210
209|Key |Aliases |Description | 211|Key |Aliases |Description |
210|-------------|-----------|---------------------------------------------------------------------| 212|---------------|-----------|---------------------------------------------------------------------|
211|`RESET` | |Put the keyboard into DFU mode for flashing | 213|`RESET` | |Put the keyboard into DFU mode for flashing |
212|`DEBUG` | |Toggle debug mode | 214|`DEBUG` | |Toggle debug mode |
213|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI| 215|`EEPROM_RESET` |`EEP_RST` |Resets EEPROM state by reinitializing it |
214|`KC_LSPO` | |Left Shift when held, `(` when tapped | 216|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI|
215|`KC_RSPC` | |Right Shift when held, `)` when tapped | 217|`KC_LSPO` | |Left Shift when held, `(` when tapped |
216|`KC_LEAD` | |The [Leader key](feature_leader_key.md) | 218|`KC_RSPC` | |Right Shift when held, `)` when tapped |
217|`KC_LOCK` | |The [Lock key](feature_key_lock.md) | 219|`KC_LEAD` | |The [Leader key](feature_leader_key.md) |
218|`FUNC(n)` |`F(n)` |Call `fn_action(n)` (deprecated) | 220|`KC_LOCK` | |The [Lock key](feature_key_lock.md) |
219|`M(n)` | |Call macro `n` | 221|`FUNC(n)` |`F(n)` |Call `fn_action(n)` (deprecated) |
220|`MACROTAP(n)`| |Macro-tap `n` idk FIXME | 222|`M(n)` | |Call macro `n` |
223|`MACROTAP(n)` | |Macro-tap `n` idk FIXME |
221 224
222## [Audio Keys](feature_audio.md) 225## [Audio Keys](feature_audio.md)
223 226
224|Key |Aliases |Description | 227|Key |Aliases |Description |
225|----------------|---------|----------------------------------| 228|----------------|---------|----------------------------------|
226|`AU_ON` | |Audio mode on | 229|`AU_ON` | |Turns on Audio Feature |
227|`AU_OFF` | |Audio mode off | 230|`AU_OFF` | |Turns off Audio Feature |
228|`AU_TOG` | |Toggles Audio mode | 231|`AU_TOG` | |Toggles Audio state |
229|`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode | 232|`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode |
230|`CLICKY_UP` |`CK_UP` |Increases frequency of the clicks | 233|`CLICKY_UP` |`CK_UP` |Increases frequency of the clicks |
231|`CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks | 234|`CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks |
@@ -271,6 +274,7 @@ This is a reference only. Each group of keys links to the page documenting their
271|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`| |Unswap `\` and Backspace | 274|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`| |Unswap `\` and Backspace |
272|`MAGIC_UNHOST_NKRO` | |Force NKRO off | 275|`MAGIC_UNHOST_NKRO` | |Force NKRO off |
273|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI on both sides | 276|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI on both sides |
277|`MAGIC_TOGGLE_ALT_GUI` |`AG_TOGG`|Toggle Alt and GUI swap on both sides|
274|`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off | 278|`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off |
275 279
276## [Bluetooth](feature_bluetooth.md) 280## [Bluetooth](feature_bluetooth.md)
@@ -284,15 +288,16 @@ This is a reference only. Each group of keys links to the page documenting their
284 288
285## [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers) 289## [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers)
286 290
287|Key |Description | 291|Key |Description |
288|-----------------|---------------------------------------------------------------------| 292|----------------|----------------------------------------------------------------------------------|
289|`DF(layer)` |Switches the default layer | 293|`DF(layer)` |Set the base (default) layer |
290|`MO(layer)` |Momentarily activates layer, switches off when you let go | 294|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)|
291|`LM(layer, mod)` |As `MO(layer)` but with `mod` active | 295|`OSL(layer)` |Momentarily activates `layer` until a key is pressed. See [One Shot Keys](https://docs.qmk.fm/#/feature_advanced_keycodes?id=one-shot-keys) for details. |
292|`LT(layer, kc)` |Momentarily activates layer if held, sends kc if tapped | 296|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well.
293|`TG(layer)` |Toggles the layer (enables it if no active, and vise versa) | 297|`LT(layer, kc)` |Turn on `layer` when held, `kc` when tapped |
294|`TO(layer)` |Activates layer and deactivates all other layers | 298|`TG(layer)` |Toggle `layer` on or off |
295|`TT(layer)` |Momentarily activates layer if held, toggles it if tapped repeatedly | 299|`TO(layer)` |Turn on `layer` when pressed |
300|`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on |
296 301
297## [Mouse Keys](feature_mouse_keys.md) 302## [Mouse Keys](feature_mouse_keys.md)
298 303
@@ -318,7 +323,7 @@ This is a reference only. Each group of keys links to the page documenting their
318## [Modifiers](feature_advanced_keycodes.md#modifier-keys) 323## [Modifiers](feature_advanced_keycodes.md#modifier-keys)
319 324
320|Key |Aliases |Description | 325|Key |Aliases |Description |
321|----------|---------- |----------------------------------------------------| 326|----------|----------------------|----------------------------------------------------|
322|`KC_HYPR` | |Hold Left Control, Shift, Alt and GUI | 327|`KC_HYPR` | |Hold Left Control, Shift, Alt and GUI |
323|`KC_MEH` | |Hold Left Control, Shift and Alt | 328|`KC_MEH` | |Hold Left Control, Shift and Alt |
324|`LCTL(kc)`| |Hold Left Control and press `kc` | 329|`LCTL(kc)`| |Hold Left Control and press `kc` |
@@ -327,12 +332,11 @@ This is a reference only. Each group of keys links to the page documenting their
327|`LGUI(kc)`|`LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` | 332|`LGUI(kc)`|`LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` |
328|`RCTL(kc)`| |Hold Right Control and press `kc` | 333|`RCTL(kc)`| |Hold Right Control and press `kc` |
329|`RSFT(kc)`| |Hold Right Shift and press `kc` | 334|`RSFT(kc)`| |Hold Right Shift and press `kc` |
330|`RALT(kc)`| |Hold Right Alt and press `kc` | 335|`RALT(kc)`|`ALGR(kc)` |Hold Right Alt and press `kc` |
331|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)`|Hold Right GUI and press `kc` | 336|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)`|Hold Right GUI and press `kc` |
332|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`| 337|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`|
333|`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` | 338|`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` |
334|`LCAG(kc)`| |Hold Left Control, Alt and GUI and press `kc` | 339|`LCAG(kc)`| |Hold Left Control, Alt and GUI and press `kc` |
335|`ALTG(kc)`| |Hold Right Control and Alt and press `kc` |
336|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and GUI and press `kc` | 340|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and GUI and press `kc` |
337|`LCA(kc)` | |Hold Left Control and Alt and press `kc` | 341|`LCA(kc)` | |Hold Left Control and Alt and press `kc` |
338 342
@@ -353,7 +357,7 @@ This is a reference only. Each group of keys links to the page documenting their
353|`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped | 357|`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped |
354|`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped | 358|`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped |
355|`ALL_T(kc)` | |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)| 359|`ALL_T(kc)` | |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
356|`SCMD_T(kc)`|`SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped | 360|`SGUI_T(kc)`|`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped |
357|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped | 361|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped |
358 362
359## [RGB Lighting](feature_rgblight.md) 363## [RGB Lighting](feature_rgblight.md)
@@ -402,7 +406,7 @@ This is a reference only. Each group of keys links to the page documenting their
402|`PRINT_ON` |Start printing everything the user types| 406|`PRINT_ON` |Start printing everything the user types|
403|`PRINT_OFF`|Stop printing everything the user types | 407|`PRINT_OFF`|Stop printing everything the user types |
404 408
405## [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) 409## [US ANSI Shifted Symbols](keycodes_us_ansi_shifted.md)
406 410
407|Key |Aliases |Description | 411|Key |Aliases |Description |
408|------------------------|-------------------|-------------------| 412|------------------------|-------------------|-------------------|
@@ -428,18 +432,6 @@ This is a reference only. Each group of keys links to the page documenting their
428|`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` | 432|`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` |
429|`KC_QUESTION` |`KC_QUES` |`?` | 433|`KC_QUESTION` |`KC_QUES` |`?` |
430 434
431## [Switching and Toggling Layers](feature_advanced_keycodes.md#switching-and-toggling-layers)
432
433|Key |Description |
434|----------------|----------------------------------------------------------------------------------|
435|`LT(layer, kc)` |Turn on `layer` when held, `kc` when tapped |
436|`TO(layer)` |Turn on `layer` when pressed |
437|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)|
438|`DF(layer)` |Set the base (default) layer |
439|`TG(layer)` |Toggle `layer` on or off |
440|`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on |
441|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well. |
442
443## [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) 435## [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
444 436
445|Key |Description | 437|Key |Description |
@@ -459,6 +451,7 @@ This is a reference only. Each group of keys links to the page documenting their
459|`SH_MOFF` |Momentarily turns off swap. | 451|`SH_MOFF` |Momentarily turns off swap. |
460|`SH_TG` |Toggles swap on and off with every key press. | 452|`SH_TG` |Toggles swap on and off with every key press. |
461|`SH_TT` |Toggles with a tap; momentary when held. | 453|`SH_TT` |Toggles with a tap; momentary when held. |
454
462## [Unicode Support](feature_unicode.md) 455## [Unicode Support](feature_unicode.md)
463 456
464|Key |Aliases| | 457|Key |Aliases| |