diff options
-rw-r--r-- | docs/keycodes.md | 22 | ||||
-rw-r--r-- | docs/keycodes_basic.md | 142 |
2 files changed, 82 insertions, 82 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md index c6403c80b..058998d4d 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md | |||
@@ -124,17 +124,17 @@ See also: [Basic Keycodes](keycodes_basic.md) | |||
124 | |`KC_F22` | |F22 |✔ | |✔ | | 124 | |`KC_F22` | |F22 |✔ | |✔ | |
125 | |`KC_F23` | |F23 |✔ | |✔ | | 125 | |`KC_F23` | |F23 |✔ | |✔ | |
126 | |`KC_F24` | |F24 |✔ | |✔ | | 126 | |`KC_F24` | |F24 |✔ | |✔ | |
127 | |`KC_EXECUTE` |`KC_EXEC` |Execute | | |✔ | | 127 | |`KC_EXECUTE` |`KC_EXEC` |Execute | | |✔ | |
128 | |`KC_HELP` | |Help | | |✔ | | 128 | |`KC_HELP` | |Help | | |✔ | |
129 | |`KC_MENU` | |Menu | | |✔ | | 129 | |`KC_MENU` | |Menu | | |✔ | |
130 | |`KC_SELECT` |`KC_SLCT` |Select | | |✔ | | 130 | |`KC_SELECT` |`KC_SLCT` |Select | | |✔ | |
131 | |`KC_STOP` | |Stop | | |✔ | | 131 | |`KC_STOP` | |Stop | | |✔ | |
132 | |`KC_AGAIN` |`KC_AGIN` |Again | | |✔ | | 132 | |`KC_AGAIN` |`KC_AGIN` |Again | | |✔ | |
133 | |`KC_UNDO` | |Undo | | |✔ | | 133 | |`KC_UNDO` | |Undo | | |✔ | |
134 | |`KC_CUT` | |Cut | | |✔ | | 134 | |`KC_CUT` | |Cut | | |✔ | |
135 | |`KC_COPY` | |Copy | | |✔ | | 135 | |`KC_COPY` | |Copy | | |✔ | |
136 | |`KC_PASTE` |`KC_PSTE` |Paste | | |✔ | | 136 | |`KC_PASTE` |`KC_PSTE` |Paste | | |✔ | |
137 | |`KC_FIND` | |Find | | |✔ | | 137 | |`KC_FIND` | |Find | | |✔ | |
138 | |`KC__MUTE` | |Mute | |✔ |✔ | | 138 | |`KC__MUTE` | |Mute | |✔ |✔ | |
139 | |`KC__VOLUP` | |Volume Up | |✔ |✔ | | 139 | |`KC__VOLUP` | |Volume Up | |✔ |✔ | |
140 | |`KC__VOLDOWN` | |Volume Down | |✔ |✔ | | 140 | |`KC__VOLDOWN` | |Volume Down | |✔ |✔ | |
diff --git a/docs/keycodes_basic.md b/docs/keycodes_basic.md index 09efc8c9c..6a31204f3 100644 --- a/docs/keycodes_basic.md +++ b/docs/keycodes_basic.md | |||
@@ -144,48 +144,48 @@ The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07 | |||
144 | 144 | ||
145 | ## Commands | 145 | ## Commands |
146 | 146 | ||
147 | |Key |Aliases |Description | | 147 | |Key |Aliases |Description | |
148 | |------------------|------------------------------|------------------------------| | 148 | |------------------|------------------------------|--------------------------------------| |
149 | |`KC_PSCREEN` |`KC_PSCR` |Print Screen | | 149 | |`KC_PSCREEN` |`KC_PSCR` |Print Screen | |
150 | |`KC_PAUSE` |`KC_PAUS`, `KC_BRK`, `KC_BRMU`|Pause, Brightness Up (macOS) | | 150 | |`KC_PAUSE` |`KC_PAUS`, `KC_BRK`, `KC_BRMU`|Pause, Brightness Up (macOS) | |
151 | |`KC_INSERT` |`KC_INS` |Insert | | 151 | |`KC_INSERT` |`KC_INS` |Insert | |
152 | |`KC_HOME` | |Home | | 152 | |`KC_HOME` | |Home | |
153 | |`KC_PGUP` | |Page Up | | 153 | |`KC_PGUP` | |Page Up | |
154 | |`KC_DELETE` |`KC_DEL` |Forward Delete | | 154 | |`KC_DELETE` |`KC_DEL` |Forward Delete | |
155 | |`KC_END` | |End | | 155 | |`KC_END` | |End | |
156 | |`KC_PGDOWN` |`KC_PGDN` |Page Down | | 156 | |`KC_PGDOWN` |`KC_PGDN` |Page Down | |
157 | |`KC_RIGHT` |`KC_RGHT` |Right Arrow | | 157 | |`KC_RIGHT` |`KC_RGHT` |Right Arrow | |
158 | |`KC_LEFT` | |Left Arrow | | 158 | |`KC_LEFT` | |Left Arrow | |
159 | |`KC_DOWN` | |Down Arrow | | 159 | |`KC_DOWN` | |Down Arrow | |
160 | |`KC_UP` | |Up Arrow | | 160 | |`KC_UP` | |Up Arrow | |
161 | |`KC_APPLICATION` |`KC_APP` |Application (Windows Menu Key)| | 161 | |`KC_APPLICATION` |`KC_APP` |Application (Windows Context Menu Key)| |
162 | |`KC_POWER` | |System Power (macOS/Linux) | | 162 | |`KC_POWER` | |System Power | |
163 | |`KC_EXECUTE` |`KC_EXEC` |Execute | | 163 | |`KC_EXECUTE` |`KC_EXEC` |Execute | |
164 | |`KC_HELP` | |Help | | 164 | |`KC_HELP` | |Help | |
165 | |`KC_MENU` | |Menu | | 165 | |`KC_MENU` | |Menu | |
166 | |`KC_SELECT` |`KC_SLCT` |Select | | 166 | |`KC_SELECT` |`KC_SLCT` |Select | |
167 | |`KC_STOP` | |Stop | | 167 | |`KC_STOP` | |Stop | |
168 | |`KC_AGAIN` |`KC_AGIN` |Again | | 168 | |`KC_AGAIN` |`KC_AGIN` |Again | |
169 | |`KC_UNDO` | |Undo | | 169 | |`KC_UNDO` | |Undo | |
170 | |`KC_CUT` | |Cut | | 170 | |`KC_CUT` | |Cut | |
171 | |`KC_COPY` | |Copy | | 171 | |`KC_COPY` | |Copy | |
172 | |`KC_PASTE` |`KC_PSTE` |Paste | | 172 | |`KC_PASTE` |`KC_PSTE` |Paste | |
173 | |`KC_FIND` | |Find | | 173 | |`KC_FIND` | |Find | |
174 | |`KC__MUTE` | |Mute (macOS) | | 174 | |`KC__MUTE` | |Mute | |
175 | |`KC__VOLUP` | |Volume Up (macOS) | | 175 | |`KC__VOLUP` | |Volume Up | |
176 | |`KC__VOLDOWN` | |Volume Down (macOS) | | 176 | |`KC__VOLDOWN` | |Volume Down | |
177 | |`KC_ALT_ERASE` |`KC_ERAS` |Alternate Erase | | 177 | |`KC_ALT_ERASE` |`KC_ERAS` |Alternate Erase | |
178 | |`KC_SYSREQ` | |SysReq/Attention | | 178 | |`KC_SYSREQ` | |SysReq/Attention | |
179 | |`KC_CANCEL` | |Cancel | | 179 | |`KC_CANCEL` | |Cancel | |
180 | |`KC_CLEAR` |`KC_CLR` |Clear | | 180 | |`KC_CLEAR` |`KC_CLR` |Clear | |
181 | |`KC_PRIOR` | |Prior | | 181 | |`KC_PRIOR` | |Prior | |
182 | |`KC_RETURN` | |Return | | 182 | |`KC_RETURN` | |Return | |
183 | |`KC_SEPARATOR` | |Separator | | 183 | |`KC_SEPARATOR` | |Separator | |
184 | |`KC_OUT` | |Out | | 184 | |`KC_OUT` | |Out | |
185 | |`KC_OPER` | |Oper | | 185 | |`KC_OPER` | |Oper | |
186 | |`KC_CLEAR_AGAIN` | |Clear/Again | | 186 | |`KC_CLEAR_AGAIN` | |Clear/Again | |
187 | |`KC_CRSEL` | |CrSel/Props | | 187 | |`KC_CRSEL` | |CrSel/Props | |
188 | |`KC_EXSEL` | |ExSel | | 188 | |`KC_EXSEL` | |ExSel | |
189 | 189 | ||
190 | ## Media Keys | 190 | ## Media Keys |
191 | 191 | ||
@@ -193,34 +193,34 @@ These keycodes are not part of the Keyboard/Keypad usage page. The `SYSTEM_` key | |||
193 | 193 | ||
194 | ?> Some of these keycodes may behave differently depending on the OS. For example, on macOS, the keycodes `KC_MEDIA_FAST_FORWARD`, `KC_MEDIA_REWIND`, `KC_MEDIA_NEXT_TRACK` and `KC_MEDIA_PREV_TRACK` skip within the current track when held, but skip the entire track when tapped. | 194 | ?> Some of these keycodes may behave differently depending on the OS. For example, on macOS, the keycodes `KC_MEDIA_FAST_FORWARD`, `KC_MEDIA_REWIND`, `KC_MEDIA_NEXT_TRACK` and `KC_MEDIA_PREV_TRACK` skip within the current track when held, but skip the entire track when tapped. |
195 | 195 | ||
196 | |Key |Aliases |Description | | 196 | |Key |Aliases |Description | |
197 | |-----------------------|---------|-----------------------------| | 197 | |-----------------------|---------|-------------------| |
198 | |`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down | | 198 | |`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down | |
199 | |`KC_SYSTEM_SLEEP` |`KC_SLEP`|System Sleep | | 199 | |`KC_SYSTEM_SLEEP` |`KC_SLEP`|System Sleep | |
200 | |`KC_SYSTEM_WAKE` |`KC_WAKE`|System Wake | | 200 | |`KC_SYSTEM_WAKE` |`KC_WAKE`|System Wake | |
201 | |`KC_AUDIO_MUTE` |`KC_MUTE`|Mute | | 201 | |`KC_AUDIO_MUTE` |`KC_MUTE`|Mute | |
202 | |`KC_AUDIO_VOL_UP` |`KC_VOLU`|Volume Up | | 202 | |`KC_AUDIO_VOL_UP` |`KC_VOLU`|Volume Up | |
203 | |`KC_AUDIO_VOL_DOWN` |`KC_VOLD`|Volume Down | | 203 | |`KC_AUDIO_VOL_DOWN` |`KC_VOLD`|Volume Down | |
204 | |`KC_MEDIA_NEXT_TRACK` |`KC_MNXT`|Next Track | | 204 | |`KC_MEDIA_NEXT_TRACK` |`KC_MNXT`|Next Track | |
205 | |`KC_MEDIA_PREV_TRACK` |`KC_MPRV`|Previous Track | | 205 | |`KC_MEDIA_PREV_TRACK` |`KC_MPRV`|Previous Track | |
206 | |`KC_MEDIA_STOP` |`KC_MSTP`|Stop Track (Windows) | | 206 | |`KC_MEDIA_STOP` |`KC_MSTP`|Stop Track | |
207 | |`KC_MEDIA_PLAY_PAUSE` |`KC_MPLY`|Play/Pause Track | | 207 | |`KC_MEDIA_PLAY_PAUSE` |`KC_MPLY`|Play/Pause Track | |
208 | |`KC_MEDIA_SELECT` |`KC_MSEL`|Launch Media Player (Windows)| | 208 | |`KC_MEDIA_SELECT` |`KC_MSEL`|Launch Media Player| |
209 | |`KC_MEDIA_EJECT` |`KC_EJCT`|Eject (macOS) | | 209 | |`KC_MEDIA_EJECT` |`KC_EJCT`|Eject | |
210 | |`KC_MAIL` | |Launch Mail (Windows) | | 210 | |`KC_MAIL` | |Launch Mail | |
211 | |`KC_CALCULATOR` |`KC_CALC`|Launch Calculator (Windows) | | 211 | |`KC_CALCULATOR` |`KC_CALC`|Launch Calculator | |
212 | |`KC_MY_COMPUTER` |`KC_MYCM`|Launch My Computer (Windows) | | 212 | |`KC_MY_COMPUTER` |`KC_MYCM`|Launch My Computer | |
213 | |`KC_WWW_SEARCH` |`KC_WSCH`|Browser Search (Windows) | | 213 | |`KC_WWW_SEARCH` |`KC_WSCH`|Browser Search | |
214 | |`KC_WWW_HOME` |`KC_WHOM`|Browser Home (Windows) | | 214 | |`KC_WWW_HOME` |`KC_WHOM`|Browser Home | |
215 | |`KC_WWW_BACK` |`KC_WBAK`|Browser Back (Windows) | | 215 | |`KC_WWW_BACK` |`KC_WBAK`|Browser Back | |
216 | |`KC_WWW_FORWARD` |`KC_WFWD`|Browser Forward (Windows) | | 216 | |`KC_WWW_FORWARD` |`KC_WFWD`|Browser Forward | |
217 | |`KC_WWW_STOP` |`KC_WSTP`|Browser Stop (Windows) | | 217 | |`KC_WWW_STOP` |`KC_WSTP`|Browser Stop | |
218 | |`KC_WWW_REFRESH` |`KC_WREF`|Browser Refresh (Windows) | | 218 | |`KC_WWW_REFRESH` |`KC_WREF`|Browser Refresh | |
219 | |`KC_WWW_FAVORITES` |`KC_WFAV`|Browser Favorites (Windows) | | 219 | |`KC_WWW_FAVORITES` |`KC_WFAV`|Browser Favorites | |
220 | |`KC_MEDIA_FAST_FORWARD`|`KC_MFFD`|Next Track (macOS) | | 220 | |`KC_MEDIA_FAST_FORWARD`|`KC_MFFD`|Next Track | |
221 | |`KC_MEDIA_REWIND` |`KC_MRWD`|Previous Track (macOS) | | 221 | |`KC_MEDIA_REWIND` |`KC_MRWD`|Previous Track | |
222 | |`KC_BRIGHTNESS_UP` |`KC_BRIU`|Brightness Up | | 222 | |`KC_BRIGHTNESS_UP` |`KC_BRIU`|Brightness Up | |
223 | |`KC_BRIGHTNESS_DOWN` |`KC_BRID`|Brightness Down | | 223 | |`KC_BRIGHTNESS_DOWN` |`KC_BRID`|Brightness Down | |
224 | 224 | ||
225 | ## Number Pad | 225 | ## Number Pad |
226 | 226 | ||
@@ -248,7 +248,7 @@ These keycodes are not part of the Keyboard/Keypad usage page. The `SYSTEM_` key | |||
248 | 248 | ||
249 | ## Special Keys | 249 | ## Special Keys |
250 | 250 | ||
251 | In addition to these, keycodes in the range of `0xA5-DF` are reserved for internal use by TMK. | 251 | In addition to these, keycodes in the range of `0xA5-DF` are reserved for internal use. |
252 | 252 | ||
253 | |Key |Aliases |Description | | 253 | |Key |Aliases |Description | |
254 | |----------------|--------------------|---------------------------------------| | 254 | |----------------|--------------------|---------------------------------------| |