FAQ-Keymap.md

   1 # Keymap
   2 ## How to get keycode
   3 See [doc/keycode.txt](https://github.com/tmk/tmk_keyboard/blob/master/doc/keycode.txt).
   4 Keycodes are actually defined in [common/keycode.h](https://github.com/tmk/tmk_keyboard/blob/master/common/keycode.h).
   5
   6 ## Sysrq key
   7 Use keycode for Print Screen(`KC_PSCREEN` or `KC_PSCR`) instead of `KC_SYSREQ`. Key combination of 'Alt + Print Screen' is recognized as 'System request'.
   8
   9 See [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) and
  10 - http://en.wikipedia.org/wiki/Magic_SysRq_key
  11 - http://en.wikipedia.org/wiki/System_request
  12
  13 ## Power key doesn't work
  14 Use `KC_PWR` instead of `KC_POWER` or vice versa.
  15 - `KC_PWR` works with Windows and Linux, not with OSX.
  16 - `KC_POWER` works with OSX and Linux, not with Windows.
  17
  18 http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264
  19
  20 ## Oneshot modifier
  21 Solves my personal 'the' problem. I often got 'the' or 'THe' wrongly instead of 'The'.  Oneshot Shift mitgates this for me.
  22 https://github.com/tmk/tmk_keyboard/issues/67
  23
  24 ## Modifier/Layer stuck
  25 Modifier keys or layers can be stuck unless layer switching is configured properly.
  26 For Modifier keys and layer actions you have to place `KC_TRANS` on same position of destination layer to  unregister the modifier key or return to previous layer on release event.
  27
  28 https://github.com/tmk/tmk_keyboard/blob/master/doc/keymap.md#31-momentary-switching
  29 http://geekhack.org/index.php?topic=57008.msg1492604#msg1492604
  30
  31
  32 ## Mechanical Lock Switch Support
  33 https://github.com/tmk/tmk_keyboard#mechanical-locking-support
  34
  35 This feature is for *mechanical lock switch* like this Alps one.
  36 http://deskthority.net/wiki/Alps_SKCL_Lock
  37
  38 Using enabling this feature and using keycodes `LCAP`, `LNUM` or `LSCR` in keymap you can use physical locking CapsLock, NumLock or ScrollLock keys as you expected.
  39
  40 Old vintage mechanical keyboards occasionally have lock switches but modern ones don't have. ***You don't need this feature in most case and just use keycodes `CAPS`, `NLCK` and `SLCK`.***
  41
  42
  43 ## Input special charactors other than ASCII like Cédille 'Ç'
  44 NO UNIVERSAL METHOD TO INPUT THOSE WORKS OVER ALL SYSTEMS. You have to define **MACRO** in way specific to your OS or layout.
  45
  46 See this post for example **MACRO** code.
  47
  48 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p195620
  49
  50 On **Windows** you can use `AltGr` key or **Alt code**.
  51 - http://en.wikipedia.org/wiki/AltGr_key
  52 - http://en.wikipedia.org/wiki/Alt_code
  53
  54 On **Mac** OS defines `Option` key combinations.
  55 - http://en.wikipedia.org/wiki/Option_key#Alternative_keyboard_input
  56
  57 On **Xorg** you can use `compose` key, instead.
  58 - http://en.wikipedia.org/wiki/Compose_key
  59
  60 And see this for **Unicode** input.
  61 - http://en.wikipedia.org/wiki/Unicode_input