aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_audio.md2
-rw-r--r--docs/feature_bootmagic.md11
-rw-r--r--docs/keycodes.md11
3 files changed, 20 insertions, 4 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index 7511598bc..5132dfe97 100644
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@@ -21,6 +21,8 @@ STARTUP_SONG // plays when the keyboard starts up (audio.c)
21GOODBYE_SONG // plays when you press the RESET key (quantum.c) 21GOODBYE_SONG // plays when you press the RESET key (quantum.c)
22AG_NORM_SONG // plays when you press AG_NORM (quantum.c) 22AG_NORM_SONG // plays when you press AG_NORM (quantum.c)
23AG_SWAP_SONG // plays when you press AG_SWAP (quantum.c) 23AG_SWAP_SONG // plays when you press AG_SWAP (quantum.c)
24CG_NORM_SONG // plays when you press CG_NORM (quantum.c)
25CG_SWAP_SONG // plays when you press CG_SWAP (quantum.c)
24MUSIC_ON_SONG // plays when music mode is activated (process_music.c) 26MUSIC_ON_SONG // plays when music mode is activated (process_music.c)
25MUSIC_OFF_SONG // plays when music mode is deactivated (process_music.c) 27MUSIC_OFF_SONG // plays when music mode is deactivated (process_music.c)
26CHROMATIC_SONG // plays when the chromatic music mode is selected (process_music.c) 28CHROMATIC_SONG // plays when the chromatic music mode is selected (process_music.c)
diff --git a/docs/feature_bootmagic.md b/docs/feature_bootmagic.md
index 225189ccb..fc37a3302 100644
--- a/docs/feature_bootmagic.md
+++ b/docs/feature_bootmagic.md
@@ -64,8 +64,11 @@ Hold down the Bootmagic key (Space by default) and the desired hotkey while plug
64|`MAGIC_NO_GUI` | |Disable the GUI keys (useful when gaming) | 64|`MAGIC_NO_GUI` | |Disable the GUI keys (useful when gaming) |
65|`MAGIC_UNNO_GUI` | |Enable the GUI keys | 65|`MAGIC_UNNO_GUI` | |Enable the GUI keys |
66|`MAGIC_SWAP_ALT_GUI` |`AG_SWAP`|Swap Alt and GUI on both sides (for macOS)| 66|`MAGIC_SWAP_ALT_GUI` |`AG_SWAP`|Swap Alt and GUI on both sides (for macOS)|
67|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Left Alt and Left GUI | 67|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI |
68|`MAGIC_TOGGLE_ALT_GUI` |`AG_TOGG`|Toggle Left Alt and GUI swap | 68|`MAGIC_TOGGLE_ALT_GUI` |`AG_TOGG`|Toggle Alt and GUI swap |
69|`MAGIC_SWAP_CTL_GUI` |`CG_SWAP`|Swap Ctrl and GUI on both sides (for macOS)|
70|`MAGIC_UNSWAP_CTL_GUI` |`CG_NORM`|Unswap Ctrl and GUI |
71|`MAGIC_TOGGLE_CTL_GUI` |`CG_TOGG`|Toggle Ctrl and GUI swap |
69|`MAGIC_SWAP_BACKSLASH_BACKSPACE` | |Swap `\` and Backspace | 72|`MAGIC_SWAP_BACKSLASH_BACKSPACE` | |Swap `\` and Backspace |
70|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`| |Unswap `\` and Backspace | 73|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`| |Unswap `\` and Backspace |
71|`MAGIC_SWAP_CONTROL_CAPSLOCK` | |Swap Left Control and Caps Lock | 74|`MAGIC_SWAP_CONTROL_CAPSLOCK` | |Swap Left Control and Caps Lock |
@@ -76,6 +79,10 @@ Hold down the Bootmagic key (Space by default) and the desired hotkey while plug
76|`MAGIC_UNSWAP_LALT_LGUI` | |Unswap Left Alt and Left GUI | 79|`MAGIC_UNSWAP_LALT_LGUI` | |Unswap Left Alt and Left GUI |
77|`MAGIC_SWAP_RALT_RGUI` | |Swap Right Alt and Right GUI | 80|`MAGIC_SWAP_RALT_RGUI` | |Swap Right Alt and Right GUI |
78|`MAGIC_UNSWAP_RALT_RGUI` | |Unswap Right Alt and Right GUI | 81|`MAGIC_UNSWAP_RALT_RGUI` | |Unswap Right Alt and Right GUI |
82|`MAGIC_SWAP_LCTL_LGUI` | |Swap Left Control and Left GUI |
83|`MAGIC_UNSWAP_LCTL_LGUI` | |Unswap Left Control and Left GUI |
84|`MAGIC_SWAP_RCTL_RGUI` | |Swap Right Control and Right GUI |
85|`MAGIC_UNSWAP_RCTL_RGUI` | |Unswap Right Control and Right GUI |
79 86
80## Configuration 87## Configuration
81 88
diff --git a/docs/keycodes.md b/docs/keycodes.md
index bd4dd61a5..e17fef6fd 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -261,6 +261,8 @@ This is a reference only. Each group of keys links to the page documenting their
261|----------------------------------|---------|------------------------------------| 261|----------------------------------|---------|------------------------------------|
262|`MAGIC_SWAP_CONTROL_CAPSLOCK` | |Swap Caps Lock and Left Control | 262|`MAGIC_SWAP_CONTROL_CAPSLOCK` | |Swap Caps Lock and Left Control |
263|`MAGIC_CAPSLOCK_TO_CONTROL` | |Treat Caps Lock as Control | 263|`MAGIC_CAPSLOCK_TO_CONTROL` | |Treat Caps Lock as Control |
264|`MAGIC_SWAP_LCTL_LGUI` | |Swap Left Control and GUI |
265|`MAGIC_SWAP_RCTL_RGUI` | |Swap Right Control and GUI |
264|`MAGIC_SWAP_LALT_LGUI` | |Swap Left Alt and GUI | 266|`MAGIC_SWAP_LALT_LGUI` | |Swap Left Alt and GUI |
265|`MAGIC_SWAP_RALT_RGUI` | |Swap Right Alt and GUI | 267|`MAGIC_SWAP_RALT_RGUI` | |Swap Right Alt and GUI |
266|`MAGIC_NO_GUI` | |Disable the GUI key | 268|`MAGIC_NO_GUI` | |Disable the GUI key |
@@ -268,8 +270,11 @@ This is a reference only. Each group of keys links to the page documenting their
268|`MAGIC_SWAP_BACKSLASH_BACKSPACE` | |Swap `\` and Backspace | 270|`MAGIC_SWAP_BACKSLASH_BACKSPACE` | |Swap `\` and Backspace |
269|`MAGIC_HOST_NKRO` | |Force NKRO on | 271|`MAGIC_HOST_NKRO` | |Force NKRO on |
270|`MAGIC_SWAP_ALT_GUI` |`AG_SWAP`|Swap Alt and GUI on both sides | 272|`MAGIC_SWAP_ALT_GUI` |`AG_SWAP`|Swap Alt and GUI on both sides |
273|`MAGIC_SWAP_CTL_GUI` |`CG_SWAP`|Swap Ctrl and GUI on both sides (for macOS)|
271|`MAGIC_UNSWAP_CONTROL_CAPSLOCK` | |Unswap Caps Lock and Left Control | 274|`MAGIC_UNSWAP_CONTROL_CAPSLOCK` | |Unswap Caps Lock and Left Control |
272|`MAGIC_UNCAPSLOCK_TO_CONTROL` | |Stop treating Caps Lock as Control | 275|`MAGIC_UNCAPSLOCK_TO_CONTROL` | |Stop treating Caps Lock as Control |
276|`MAGIC_UNSWAP_LCTL_LGUI` | |Unswap Left Control and GUI |
277|`MAGIC_UNSWAP_RCTL_RGUI` | |Unswap Right Control and GUI |
273|`MAGIC_UNSWAP_LALT_LGUI` | |Unswap Left Alt and GUI | 278|`MAGIC_UNSWAP_LALT_LGUI` | |Unswap Left Alt and GUI |
274|`MAGIC_UNSWAP_RALT_RGUI` | |Unswap Right Alt and GUI | 279|`MAGIC_UNSWAP_RALT_RGUI` | |Unswap Right Alt and GUI |
275|`MAGIC_UNNO_GUI` | |Enable the GUI key | 280|`MAGIC_UNNO_GUI` | |Enable the GUI key |
@@ -277,8 +282,10 @@ This is a reference only. Each group of keys links to the page documenting their
277|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`| |Unswap `\` and Backspace | 282|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`| |Unswap `\` and Backspace |
278|`MAGIC_UNHOST_NKRO` | |Force NKRO off | 283|`MAGIC_UNHOST_NKRO` | |Force NKRO off |
279|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI on both sides | 284|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI on both sides |
280|`MAGIC_TOGGLE_ALT_GUI` |`AG_TOGG`|Toggle Alt and GUI swap on both sides| 285|`MAGIC_UNSWAP_CTL_GUI` |`CG_NORM`|Unswap Ctrl and GUI on both sides |
281|`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off | 286|`MAGIC_TOGGLE_ALT_GUI` |`AG_TOGG`|Toggle Alt and GUI swap on both sides |
287|`MAGIC_TOGGLE_CTL_GUI` |`CG_TOGG`|Toggle Ctrl and GUI swap on both sides |
288|`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off |
282 289
283## [Bluetooth](feature_bluetooth.md) 290## [Bluetooth](feature_bluetooth.md)
284 291