docs/feature_key_lock.md

   1 # Key Lock
   2
   3 Sometimes you may find yourself needing to hold down a specific key for a long period of time. Key Lock holds down the next key you press for you. Press it again, and it will be released.
   4
   5 Let's say you need to type in ALL CAPS for a few sentences. Hit `KC_LOCK`, and then Shift. Now, Shift will be considered held until you tap it again. You can think of Key Lock as Caps Lock, but supercharged.
   6
   7 ## Usage
   8
   9 First, enable Key Lock by setting `KEY_LOCK_ENABLE = yes` in your `rules.mk`. Then pick a key in your keymap and assign it the keycode `KC_LOCK`.
  10
  11 ## Keycodes
  12
  13 |Keycode  |Description                                                   |
  14 |---------|--------------------------------------------------------------|
  15 |`KC_LOCK`|Hold down the next key pressed, until the key is pressed again|
  16
  17 ## Caveats
  18
  19 Key Lock is only able to hold standard action keys and [One Shot modifier](quantum_keycodes.md#one-shot-keys) keys (for example, if you have your Shift defined as `OSM(KC_LSFT)`).
  20 This does not include any of the QMK special functions (except One Shot modifiers), or shifted versions of keys such as `KC_LPRN`. If it's in the [Basic Keycodes](keycodes_basic.md) list, it can be held.
  21
  22 Switching layers will not cancel the Key Lock.