diff options
author | Canop <cano.petrole@gmail.com> | 2023-12-02 07:58:56 +0100 |
---|---|---|
committer | Canop <cano.petrole@gmail.com> | 2023-12-02 07:58:56 +0100 |
commit | 870f840f880922bccf038474650f5a637f42cc49 (patch) | |
tree | 9582eac5a5de458c84c99b269124baea6c6ff695 | |
parent | 74c0f230ae49fd2091d3a05d645cc67aafda3570 (diff) |
website: improve doc on key combination problems
-rw-r--r-- | website/docs/common-problems.md | 8 | ||||
-rw-r--r-- | website/docs/conf_verbs.md | 2 |
2 files changed, 6 insertions, 4 deletions
diff --git a/website/docs/common-problems.md b/website/docs/common-problems.md index 4d16578..c0aabd6 100644 --- a/website/docs/common-problems.md +++ b/website/docs/common-problems.md @@ -30,13 +30,13 @@ Additionally, if backgrounds can't be properly displayed, you may consider [mark Another problem is the fact the `br` function doesn't set a proper pane name (you'll probably see the name of your shell instead of broot). This may be [solved with a modified shell function](https://github.com/Canop/broot/issues/270). -# Missing shortcut +# Key combination problem Most terminals intercept a few keyboard shortcut for their own features. You may need to remap your terminal's default keyboard shortcuts. I've made a small program which tells you what key combinations are available: [print_key](https://github.com/Canop/print_key). -## Windows Terminal +**Windows Terminal** [Windows Terminal](https://docs.microsoft.com/en-us/windows/terminal/) binds `alt+enter` to the "toggle fullscreen" command by default. To reclaim `alt+enter` for Broot, [add an 'unbound' entry to the actions array in settings.json](https://docs.microsoft.com/en-us/windows/terminal/customize-settings/actions#unbind-keys): @@ -44,14 +44,14 @@ I've made a small program which tells you what key combinations are available: [ {"command": "unbound", "keys": "alt+enter"} ``` -## iTerm2 +**iTerm2** For Mac users, iTerm2 must also be configured to enable this shortcut: Go to *Preferences->Profiles->Default->Keys* and add a mapping that maps `⌥Return↩` to `Send Hex Codes: 0x1b 0x0d`. This can be done by clicking the + sign at the bottom to add a mapping, clicking the "Click to Set" area, pressing the desired key combination (⌥Enter a.k.a ⌥Return), choosing the "Send Hex Code" option from the drop-down menu and inserting the following string there: "0x1b 0x0d". Note that this will change the behavior of `alt+enter` for all terminal windows, and it will no longer send the `return` sequence. -## remap in Broot +**Remap in Broot** If a shortcut isn't available for broot and you can't or don't want to remap the one of your terminal, the solution is to change the shortcut in broot. diff --git a/website/docs/conf_verbs.md b/website/docs/conf_verbs.md index 9285d28..48d6374 100644 --- a/website/docs/conf_verbs.md +++ b/website/docs/conf_verbs.md @@ -272,6 +272,8 @@ Then, Beware that consoles intercept some possible keys. Many keyboard shortcuts aren't available, depending on your configuration. Some keys are also reserved in broot for some uses, for example the <kbd>enter</kbd> key always validate an input command if there's some. The <kbd>Tab</kbd>, <kbd>delete</kbd>, <kbd>backspace</kbd>, <kbd>esc</kbd> keys are reserved too. +If your chosen key doesn't seem to work, see [Key Combination Problem](../common-problems/#key-combination-problem). + ## Verbs not leaving broot If you set `leave_broot = false`, broot won't quit when executing your command, but it will update the tree. |