aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRichard Turner <63139+zygous@users.noreply.github.com>2023-07-27 09:10:40 +0100
committerGitHub <noreply@github.com>2023-07-27 08:10:40 +0000
commitc0449955e38da95a88893337bef0b004e135e177 (patch)
treeca3c9ef9212a00549d107c17baa999ccf38a0dd9 /docs
parentBump config from 0.13.2 to 0.13.3 (#646) (diff)
downloadatuin-c0449955e38da95a88893337bef0b004e135e177.zip
use Ctrl-n instead of Alt-n on macOS (#1106)
* use Ctrl-n instead of Alt-n on macOS * make ctrl-n instead of alt-n configurable
Diffstat (limited to '')
-rw-r--r--docs/docs/config/config.md9
-rw-r--r--docs/docs/key-binding.md9
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/docs/config/config.md b/docs/docs/config/config.md
index 1f4e1668..209d34cd 100644
--- a/docs/docs/config/config.md
+++ b/docs/docs/config/config.md
@@ -231,3 +231,12 @@ history_filter = [
"^innocuous-cmd .*--secret=.+"
]
```
+
+## macOS <kbd>Ctrl-n</kbd> key shortcuts
+
+macOS does not have an <kbd>Alt</kbd> key, although terminal emulators can often be configured to map the <kbd>Option</kbd> key to be used as <kbd>Alt</kbd>. *However*, remapping <kbd>Option</kbd> this way may prevent typing some characters, such as using <kbd>Option-3</kbd> to type `#` on the British English layout. For such a scenario, set the `ctrl_n_shortcuts` option to `true` in your config file to replace <kbd>Alt-0</kbd> to <kbd>Alt-9</kbd> shortcuts with <kbd>Ctrl-0</kbd> to <kbd>Ctrl-9</kbd> instead:
+
+```
+# Use Ctrl-0 .. Ctrl-9 instead of Alt-0 .. Alt-9 UI shortcuts
+ctrl_n_shortcuts = true
+```
diff --git a/docs/docs/key-binding.md b/docs/docs/key-binding.md
index 2069e250..c3931977 100644
--- a/docs/docs/key-binding.md
+++ b/docs/docs/key-binding.md
@@ -46,6 +46,15 @@ eval "$(atuin init zsh)"
You can then choose to bind Atuin if needed, do this after the call to init.
+## <kbd>Ctrl-n</kbd> key shortcuts
+
+macOS does not have an <kbd>Alt</kbd> key, although terminal emulators can often be configured to map the <kbd>Option</kbd> key to be used as <kbd>Alt</kbd>. *However*, remapping <kbd>Option</kbd> this way may prevent typing some characters, such as using <kbd>Option-3</kbd> to type `#` on the British English layout. For such a scenario, set the `ctrl_n_shortcuts` option to `true` in your config file to replace <kbd>Alt-0</kbd> to <kbd>Alt-9</kbd> shortcuts with <kbd>Ctrl-0</kbd> to <kbd>Ctrl-9</kbd> instead:
+
+```
+# Use Ctrl-0 .. Ctrl-9 instead of Alt-0 .. Alt-9 UI shortcuts
+ctrl_n_shortcuts = true
+```
+
## zsh
If you'd like to customize your bindings further, it's possible to do so with custom shell config: