aboutsummaryrefslogtreecommitdiff
path: root/docs/keycodes.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/keycodes.md')
-rw-r--r--docs/keycodes.md44
1 files changed, 22 insertions, 22 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md
index b70f1c44d..f8c8a75ed 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -4,7 +4,7 @@ When defining a [keymap](keymap.md) each key needs a valid key definition. This
4 4
5This is a reference only. Each group of keys links to the page documenting their functionality in more detail. 5This is a reference only. Each group of keys links to the page documenting their functionality in more detail.
6 6
7## Basic Keycodes 7## Basic Keycodes :id=basic-keycodes
8 8
9See also: [Basic Keycodes](keycodes_basic.md) 9See also: [Basic Keycodes](keycodes_basic.md)
10 10
@@ -208,7 +208,7 @@ See also: [Basic Keycodes](keycodes_basic.md)
208|`KC_BRIGHTNESS_UP` |`KC_BRIU` |Brightness Up | 208|`KC_BRIGHTNESS_UP` |`KC_BRIU` |Brightness Up |
209|`KC_BRIGHTNESS_DOWN` |`KC_BRID` |Brightness Down | 209|`KC_BRIGHTNESS_DOWN` |`KC_BRID` |Brightness Down |
210 210
211## Quantum Keycodes 211## Quantum Keycodes :id=quantum-keycodes
212 212
213See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes) 213See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes)
214 214
@@ -218,7 +218,7 @@ See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes)
218|`DEBUG` | |Toggle debug mode | 218|`DEBUG` | |Toggle debug mode |
219|`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)| 219|`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)|
220 220
221## Audio Keys 221## Audio Keys :id=audio-keys
222 222
223See also: [Audio](feature_audio.md) 223See also: [Audio](feature_audio.md)
224 224
@@ -236,7 +236,7 @@ See also: [Audio](feature_audio.md)
236|`MU_TOG` | |Toggles Music Mode | 236|`MU_TOG` | |Toggles Music Mode |
237|`MU_MOD` | |Cycles through the music modes | 237|`MU_MOD` | |Cycles through the music modes |
238 238
239## Backlighting 239## Backlighting :id=backlighting
240 240
241See also: [Backlighting](feature_backlight.md) 241See also: [Backlighting](feature_backlight.md)
242 242
@@ -250,7 +250,7 @@ See also: [Backlighting](feature_backlight.md)
250|`BL_DEC` |Decrease the backlight level | 250|`BL_DEC` |Decrease the backlight level |
251|`BL_BRTG`|Toggle backlight breathing | 251|`BL_BRTG`|Toggle backlight breathing |
252 252
253## Bootmagic 253## Bootmagic :id=bootmagic
254 254
255See also: [Bootmagic](feature_bootmagic.md) 255See also: [Bootmagic](feature_bootmagic.md)
256 256
@@ -286,7 +286,7 @@ See also: [Bootmagic](feature_bootmagic.md)
286|`MAGIC_EE_HANDS_LEFT` |`EH_LEFT`|Set the master half of a split keyboard as the left hand (for `EE_HANDS`) | 286|`MAGIC_EE_HANDS_LEFT` |`EH_LEFT`|Set the master half of a split keyboard as the left hand (for `EE_HANDS`) |
287|`MAGIC_EE_HANDS_RIGHT` |`EH_RGHT`|Set the master half of a split keyboard as the right hand (for `EE_HANDS`)| 287|`MAGIC_EE_HANDS_RIGHT` |`EH_RGHT`|Set the master half of a split keyboard as the right hand (for `EE_HANDS`)|
288 288
289## Bluetooth 289## Bluetooth :id=bluetooth
290 290
291See also: [Bluetooth](feature_bluetooth.md) 291See also: [Bluetooth](feature_bluetooth.md)
292 292
@@ -296,7 +296,7 @@ See also: [Bluetooth](feature_bluetooth.md)
296|`OUT_USB` |USB only | 296|`OUT_USB` |USB only |
297|`OUT_BT` |Bluetooth only | 297|`OUT_BT` |Bluetooth only |
298 298
299## Dynamic Macros 299## Dynamic Macros :id=dynamic-macros
300 300
301See also: [Dynamic Macros](feature_dynamic_macros.md) 301See also: [Dynamic Macros](feature_dynamic_macros.md)
302 302
@@ -308,7 +308,7 @@ See also: [Dynamic Macros](feature_dynamic_macros.md)
308|`DYN_MACRO_PLAY2`|`DM_PLY2`|Replay Macro 2 | 308|`DYN_MACRO_PLAY2`|`DM_PLY2`|Replay Macro 2 |
309|`DYN_REC_STOP` |`DM_RSTP`|Finish the macro that is currently being recorded.| 309|`DYN_REC_STOP` |`DM_RSTP`|Finish the macro that is currently being recorded.|
310 310
311## Grave Escape 311## Grave Escape :id=grave-escape
312 312
313See also: [Grave Escape](feature_grave_esc.md) 313See also: [Grave Escape](feature_grave_esc.md)
314 314
@@ -316,7 +316,7 @@ See also: [Grave Escape](feature_grave_esc.md)
316|-----------|---------|------------------------------------------------------------------| 316|-----------|---------|------------------------------------------------------------------|
317|`GRAVE_ESC`|`KC_GESC`|Escape when pressed, <code>&#96;</code> when Shift or GUI are held| 317|`GRAVE_ESC`|`KC_GESC`|Escape when pressed, <code>&#96;</code> when Shift or GUI are held|
318 318
319## Key Lock 319## Key Lock :id=key-lock
320 320
321See also: [Key Lock](feature_key_lock.md) 321See also: [Key Lock](feature_key_lock.md)
322 322
@@ -324,7 +324,7 @@ See also: [Key Lock](feature_key_lock.md)
324|---------|--------------------------------------------------------------| 324|---------|--------------------------------------------------------------|
325|`KC_LOCK`|Hold down the next key pressed, until the key is pressed again| 325|`KC_LOCK`|Hold down the next key pressed, until the key is pressed again|
326 326
327## Layer Switching 327## Layer Switching :id=layer-switching
328 328
329See also: [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers) 329See also: [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers)
330 330
@@ -339,7 +339,7 @@ See also: [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-
339|`TO(layer)` |Turns on `layer` and turns off all other layers, except the default layer | 339|`TO(layer)` |Turns on `layer` and turns off all other layers, except the default layer |
340|`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on | 340|`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on |
341 341
342## Leader Key 342## Leader Key :id=leader-key
343 343
344See also: [Leader Key](feature_leader_key.md) 344See also: [Leader Key](feature_leader_key.md)
345 345
@@ -347,7 +347,7 @@ See also: [Leader Key](feature_leader_key.md)
347|---------|------------------------| 347|---------|------------------------|
348|`KC_LEAD`|Begins a leader sequence| 348|`KC_LEAD`|Begins a leader sequence|
349 349
350## Mouse Keys 350## Mouse Keys :id=mouse-keys
351 351
352See also: [Mouse Keys](feature_mouse_keys.md) 352See also: [Mouse Keys](feature_mouse_keys.md)
353 353
@@ -370,7 +370,7 @@ See also: [Mouse Keys](feature_mouse_keys.md)
370|`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1| 370|`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1|
371|`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2| 371|`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2|
372 372
373## Modifiers 373## Modifiers :id=modifiers
374 374
375See also: [Modifier Keys](feature_advanced_keycodes.md#modifier-keys) 375See also: [Modifier Keys](feature_advanced_keycodes.md#modifier-keys)
376 376
@@ -392,7 +392,7 @@ See also: [Modifier Keys](feature_advanced_keycodes.md#modifier-keys)
392|`KC_MEH` | |Left Control, Shift and Alt | 392|`KC_MEH` | |Left Control, Shift and Alt |
393|`KC_HYPR` | |Left Control, Shift, Alt and GUI | 393|`KC_HYPR` | |Left Control, Shift, Alt and GUI |
394 394
395## Mod-Tap Keys 395## Mod-Tap Keys :id=mod-tap-keys
396 396
397See also: [Mod-Tap](mod_tap.md) 397See also: [Mod-Tap](mod_tap.md)
398 398
@@ -415,7 +415,7 @@ See also: [Mod-Tap](mod_tap.md)
415|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped| 415|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped|
416|`HYPR_T(kc)` |`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/)| 416|`HYPR_T(kc)` |`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/)|
417 417
418## RGB Lighting 418## RGB Lighting :id=rgb-lighting
419 419
420See also: [RGB Lighting](feature_rgblight.md) 420See also: [RGB Lighting](feature_rgblight.md)
421 421
@@ -440,7 +440,7 @@ See also: [RGB Lighting](feature_rgblight.md)
440|`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode | 440|`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode |
441|`RGB_MODE_RGBTEST` |`RGB_M_T` |Red,Green,Blue test animation mode | 441|`RGB_MODE_RGBTEST` |`RGB_M_T` |Red,Green,Blue test animation mode |
442 442
443## RGB Matrix Lighting 443## RGB Matrix Lighting :id=rgb-matrix-lighting
444 444
445See also: [RGB Matrix Lighting](feature_rgb_matrix.md) 445See also: [RGB Matrix Lighting](feature_rgb_matrix.md)
446 446
@@ -458,7 +458,7 @@ See also: [RGB Matrix Lighting](feature_rgb_matrix.md)
458|`RGB_SPI` | |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held| 458|`RGB_SPI` | |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held|
459|`RGB_SPD` | |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held| 459|`RGB_SPD` | |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held|
460 460
461## Thermal Printer 461## Thermal Printer :id=thermal-printer
462 462
463See also: [Thermal Printer](feature_thermal_printer.md) 463See also: [Thermal Printer](feature_thermal_printer.md)
464 464
@@ -467,7 +467,7 @@ See also: [Thermal Printer](feature_thermal_printer.md)
467|`PRINT_ON` |Start printing everything the user types| 467|`PRINT_ON` |Start printing everything the user types|
468|`PRINT_OFF`|Stop printing everything the user types | 468|`PRINT_OFF`|Stop printing everything the user types |
469 469
470## US ANSI Shifted Symbols 470## US ANSI Shifted Symbols :id=us-ansi-shifted-symbols
471 471
472See also: [US ANSI Shifted Symbols](keycodes_us_ansi_shifted.md) 472See also: [US ANSI Shifted Symbols](keycodes_us_ansi_shifted.md)
473 473
@@ -495,7 +495,7 @@ See also: [US ANSI Shifted Symbols](keycodes_us_ansi_shifted.md)
495|`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` | 495|`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` |
496|`KC_QUESTION` |`KC_QUES` |`?` | 496|`KC_QUESTION` |`KC_QUES` |`?` |
497 497
498## One Shot Keys 498## One Shot Keys :id=one-shot-keys
499 499
500See also: [One Shot Keys](one_shot_keys.md) 500See also: [One Shot Keys](one_shot_keys.md)
501 501
@@ -504,7 +504,7 @@ See also: [One Shot Keys](one_shot_keys.md)
504|`OSM(mod)` |Hold `mod` for one keypress | 504|`OSM(mod)` |Hold `mod` for one keypress |
505|`OSL(layer)`|Switch to `layer` for one keypress| 505|`OSL(layer)`|Switch to `layer` for one keypress|
506 506
507## Space Cadet 507## Space Cadet :id=space-cadet
508 508
509See also: [Space Cadet](feature_space_cadet.md) 509See also: [Space Cadet](feature_space_cadet.md)
510 510
@@ -518,7 +518,7 @@ See also: [Space Cadet](feature_space_cadet.md)
518|`KC_RAPC` |Right Alt when held, `)` when tapped | 518|`KC_RAPC` |Right Alt when held, `)` when tapped |
519|`KC_SFTENT`|Right Shift when held, Enter when tapped| 519|`KC_SFTENT`|Right Shift when held, Enter when tapped|
520 520
521## Swap Hands 521## Swap Hands :id=swap-hands
522 522
523See also: [Swap Hands](feature_swap_hands.md) 523See also: [Swap Hands](feature_swap_hands.md)
524 524
@@ -532,7 +532,7 @@ See also: [Swap Hands](feature_swap_hands.md)
532|`SH_TG` |Toggles swap on and off with every key press. | 532|`SH_TG` |Toggles swap on and off with every key press. |
533|`SH_TT` |Toggles with a tap; momentary when held. | 533|`SH_TT` |Toggles with a tap; momentary when held. |
534 534
535## Unicode Support 535## Unicode Support :id=unicode-support
536 536
537See also: [Unicode Support](feature_unicode.md) 537See also: [Unicode Support](feature_unicode.md)
538 538