aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/_summary.md1
-rw-r--r--docs/build_environment_setup.md4
-rw-r--r--docs/faq_keymap.md4
-rw-r--r--docs/key_lock.md11
-rw-r--r--docs/make_instructions.md4
-rw-r--r--docs/quantum_keycodes.md1
6 files changed, 22 insertions, 3 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index 723377de9..0f65de0dd 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -17,6 +17,7 @@
17 * [Mouse keys](mouse_keys.md) 17 * [Mouse keys](mouse_keys.md)
18 * [Unicode](unicode.md) 18 * [Unicode](unicode.md)
19 * [Stenography](stenography.md) 19 * [Stenography](stenography.md)
20 * [Key Lock](key_lock.md)
20 21
21* Reference 22* Reference
22 * [Glossary](glossary.md) 23 * [Glossary](glossary.md)
diff --git a/docs/build_environment_setup.md b/docs/build_environment_setup.md
index 2282e9d13..d2d63defb 100644
--- a/docs/build_environment_setup.md
+++ b/docs/build_environment_setup.md
@@ -50,10 +50,10 @@ If you have trouble and want to ask for help, it is useful to generate a *Win_Ch
50If you're using [homebrew,](http://brew.sh/) you can use the following commands: 50If you're using [homebrew,](http://brew.sh/) you can use the following commands:
51 51
52 brew tap osx-cross/avr 52 brew tap osx-cross/avr
53 brew install avr-libc 53 brew install avr-gcc
54 brew install dfu-programmer 54 brew install dfu-programmer
55 55
56This is the recommended method. If you don't have homebrew, [install it!](http://brew.sh/) It's very much worth it for anyone who works in the command line. Note that the `make` and `make install` portion during the homebrew installation of avr-libc can take over 20 minutes and exhibit high CPU usage. 56This is the recommended method. If you don't have homebrew, [install it!](http://brew.sh/) It's very much worth it for anyone who works in the command line. Note that the `make` and `make install` portion during the homebrew installation of avr-gcc can take over 20 minutes and exhibit high CPU usage.
57 57
58You can also try these instructions: 58You can also try these instructions:
59 59
diff --git a/docs/faq_keymap.md b/docs/faq_keymap.md
index d6442ac53..3c2795816 100644
--- a/docs/faq_keymap.md
+++ b/docs/faq_keymap.md
@@ -116,7 +116,9 @@ https://github.com/tekezo/Karabiner/issues/403
116 116
117## Esc and `~ on a key 117## Esc and `~ on a key
118 118
119Use `GRAVE_ESC` or `KC_GESC` in your keymap. 119Use `GRAVE_ESC` or `KC_GESC` in your keymap. `GUI`+`GRAVE_ESC` results in `\`` and `SHIFT`+`GRAVE_ESC` results in `~`.
120
121Note that this will break the CTRL+SHIFT+ESC shortcut to the Windows task manager. Use `#define GRAVE_ESC_CTRL_OVERRIDE` in your `config.h` to get the shortcut back. With this option, `ESC_GRAVE` results in `ESC` if `CTRL` is held, even if `SHIFT` or `GUI` are also held.
120 122
121## Arrow on Right Modifier keys with Dual-Role 123## Arrow on Right Modifier keys with Dual-Role
122This turns right modifer keys into arrow keys when the keys are tapped while still modifiers when the keys are hold. In TMK the dual-role function is dubbed **TAP**. 124This turns right modifer keys into arrow keys when the keys are tapped while still modifiers when the keys are hold. In TMK the dual-role function is dubbed **TAP**.
diff --git a/docs/key_lock.md b/docs/key_lock.md
new file mode 100644
index 000000000..e424061a9
--- /dev/null
+++ b/docs/key_lock.md
@@ -0,0 +1,11 @@
1## Key Lock: Holding down keys for you
2
3Sometimes, you need to hold down a specific key for a long period of time. Whether this is while typing in ALL CAPS, or playing a video game that hasn't implemented auto-run, Key Lock is here to help. Key Lock adds a new keycode, `KC_LOCK`, that will hold down the next key you hit for you. The key is released when you hit it again. Here's an example: let's say you need to type in all caps for a few sentences. You hit KC_LOCK, and then shift. Now, shift will be considered held until you hit it again. You can think of key lock as caps lock, but supercharged.
4
5Here's how to use it:
6
71. Pick a key on your keyboard. This will be the key lock key. Assign it the keycode `KC_LOCK`. This will be a single-action key: you won't be able to use it for anything else.
82. Enable key lock by including `KEY_LOCK_ENABLE = yes` in your Makefile.
93. That's it!
10
11Important: switching layers does not cancel the key lock. Additionally, key lock is only able to hold standard action keys and One Shot modifier keys (for example, if you have your shift defined as `OSM(KC_LSFT)`; see [One Shot Keys](quantum_keycodes.md#one-shot-keys)). 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](basic_keycodes.md) list, it can be held. If it's not, then it can't be.
diff --git a/docs/make_instructions.md b/docs/make_instructions.md
index 64c1cb0f0..299c5785b 100644
--- a/docs/make_instructions.md
+++ b/docs/make_instructions.md
@@ -158,6 +158,10 @@ This enables using the Quantum SYSEX API to send strings (somewhere?)
158 158
159This consumes about 5390 bytes. 159This consumes about 5390 bytes.
160 160
161`KEY_LOCK_ENABLE`
162
163This enables [key lock](key_lock.md). This consumes an additional 260 bytes.
164
161## Customizing Makefile options on a per-keymap basis 165## Customizing Makefile options on a per-keymap basis
162 166
163If your keymap directory has a file called `Makefile` (note the filename), any Makefile options you set in that file will take precedence over other Makefile options for your particular keyboard. 167If your keymap directory has a file called `Makefile` (note the filename), any Makefile options you set in that file will take precedence over other Makefile options for your particular keyboard.
diff --git a/docs/quantum_keycodes.md b/docs/quantum_keycodes.md
index 36dbda7a9..f13801ef5 100644
--- a/docs/quantum_keycodes.md
+++ b/docs/quantum_keycodes.md
@@ -17,6 +17,7 @@ On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are
17|`FUNC(n)`/`F(n)`|Call `fn_action(n)`| 17|`FUNC(n)`/`F(n)`|Call `fn_action(n)`|
18|`M(n)`|to call macro n| 18|`M(n)`|to call macro n|
19|`MACROTAP(n)`|to macro-tap n idk FIXME| 19|`MACROTAP(n)`|to macro-tap n idk FIXME|
20|`KC_LOCK`|The [lock key](key_lock.md)|
20 21
21## Bootmagic Keycodes 22## Bootmagic Keycodes
22 23