summaryrefslogtreecommitdiffstats
path: root/readme
diff options
context:
space:
mode:
authorTim Oram <dev@mitmaro.ca>2021-03-02 10:56:01 -0330
committerTim Oram <dev@mitmaro.ca>2021-03-02 18:50:30 -0330
commitc183c3fd8d6e5eb7cdf0551a5f003addf6b148a3 (patch)
tree18f8664ebdc8902b4a5fb954d9d441cf0e1f1d2a /readme
parent2204554cfee53dec8e3826ba8279d886ee694310 (diff)
Fix custom keybindings using modifiers
Almost all the modifiers with keybindings did not function as intended. This updates the config parsing for keybindings to support all modifiers. As a side effect, the modifiers can now be provided in any order. Also, since the tests for this were fragile and required a config file per test case, they have been refactored to generate a git configuration as needed instead.
Diffstat (limited to 'readme')
-rw-r--r--readme/customization.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/readme/customization.md b/readme/customization.md
index d44f488..ec453af 100644
--- a/readme/customization.md
+++ b/readme/customization.md
@@ -141,6 +141,7 @@ Keys that do not have easily printable characters, such as the arrow keys, are s
| `Down` | Down arrow key |
| `End` | End key |
| `Enter` | Enter key |
+| `Esc` | Escape key |
| `F{1..255}` | Function X key |
| `Home` | Home key |
| `Insert` | Insert key |
@@ -153,7 +154,17 @@ Keys that do not have easily printable characters, such as the arrow keys, are s
### Modifier Keys
-Most keybindings can be prefixed with `Shift`, `Control` or `Alt`. These bindings can also be combined, but if combined must be combined in the order defined above. That is `ShiftAltEnter` is valid but `AltShiftEnter` is not. This is a limitation that hopefully will be removed in the future. `Shift` combined with any ASCII alphabetic character will not work and the uppercase character must be used instead.
+Most keybindings can be prefixed with `Shift`, `Control` or `Alt`, followed by a `+`. These bindings can also be combined in any order, for example `Alt+Control+Delete`. `Shift` combined with any ASCII alphabetic character will not work and the uppercase character must be used instead.
+
+### Restricted Keys
+
+Some key combinations are restricted as they have special meaning. They are:
+
+| Key | Description |
+| ------------------ | ----------- |
+| `Control+c` | Immediately aborts the program without writing the rebase todo file to disk |
+| `Control+d` | Immediately writes the rebase todo file to disk and exits |
+
## External Editor