2020-06-17 10:08:43 +03:00
|
|
|
Both the keyboard and the mouse bindings are configurable.
|
2020-05-22 18:05:59 +03:00
|
|
|
|
|
|
|
The assignments are based around a triggering event, such as a keypress or
|
|
|
|
mouse button click, which is combined with a set of modifier keys to produce
|
|
|
|
an action.
|
|
|
|
|
|
|
|
A full list of possible keys, mouse events and actions are included below,
|
|
|
|
after these tables describing the default assignments.
|
|
|
|
|
2020-06-20 23:37:59 +03:00
|
|
|
## Alt / Option Key Behavior & Composed Keys
|
|
|
|
|
|
|
|
The operating system has its own user selectable keymap that is sometimes at
|
|
|
|
odds with old-school terminal emulation that pre-dates internationalization as
|
|
|
|
a concept. WezTerm tries to behave reasonably by default, but also give you
|
|
|
|
control in other situations.
|
|
|
|
|
|
|
|
### Layouts with an AltGr key
|
|
|
|
|
|
|
|
If you have, for example, a European keyboard layout with an AltGr key then
|
|
|
|
wezterm will respect the composition effects of AltGr produced by the system.
|
|
|
|
For example, in a German keymap, `AltGr <` will produce `|`.
|
|
|
|
|
|
|
|
If your physical keyboard doesn't match the keyboard layout (eg: using a US
|
|
|
|
keyboard with DEU selected in the OS), then the right hand `Alt` key is often
|
|
|
|
re-interpreted as having the `AltGr` function with behavior as described above.
|
|
|
|
|
|
|
|
The left `Alt` will be treated as a modifier with no composition effects.
|
|
|
|
|
|
|
|
### macOS Left and Right Option Key
|
|
|
|
|
2020-06-21 02:07:21 +03:00
|
|
|
*since: 20200620-160318-e00b076c*
|
2020-06-20 23:37:59 +03:00
|
|
|
|
|
|
|
The default behavior is to treat the left `Option` key as the `Alt` modifier
|
|
|
|
with no composition effects, while the right `Option` key performs composition
|
|
|
|
(making it approximately equivalent to `AltGr` on other operating systems).
|
|
|
|
|
|
|
|
You can control this behavior in your configuration:
|
|
|
|
|
|
|
|
```lua
|
|
|
|
return {
|
|
|
|
send_composed_key_when_left_alt_is_pressed=false,
|
|
|
|
send_composed_key_when_right_alt_is_pressed=true,
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
If you're running an earlier release the options were a bit more limited;
|
|
|
|
both left and right `Option` keys behave identically and composition
|
|
|
|
behavior was influenced for both of them via the `send_composed_key_when_alt_is_pressed`
|
|
|
|
configuration option.
|
|
|
|
|
|
|
|
### macOS and the Input Method Editor (IME)
|
|
|
|
|
2020-10-19 00:07:23 +03:00
|
|
|
WezTerm has support for using the operating system Input Method Editor (IME) on
|
|
|
|
macOS. This is useful in cases where you need to type kanji or are using a
|
|
|
|
keyboard layout with dead keys. However, the input method editor can get in
|
|
|
|
the way and has a couple of irritating side effects such as preventing key
|
|
|
|
repeat for a subset of keys.
|
2020-06-20 23:37:59 +03:00
|
|
|
|
|
|
|
You can control whether the IME is enabled on macOS in your configuration file:
|
|
|
|
|
|
|
|
```lua
|
|
|
|
return {
|
|
|
|
use_ime = false,
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2020-06-21 02:07:21 +03:00
|
|
|
*since: 20200620-160318-e00b076c*
|
2020-06-20 23:37:59 +03:00
|
|
|
|
|
|
|
The default for `use_ime` is false. The default in earlier releases was `true`.
|
|
|
|
|
2020-10-16 22:13:30 +03:00
|
|
|
### Microsoft Windows and Dead Keys
|
|
|
|
|
2020-11-01 01:51:08 +03:00
|
|
|
*since: 20201031-154415-9614e117*
|
2020-10-16 22:13:30 +03:00
|
|
|
|
|
|
|
By default, if you are using a layout with *dead keys* (eg: US International
|
|
|
|
layout, or a number of European layouts such as German or French) pressing
|
|
|
|
a dead key in wezterm will "hold" the dead key until the next character is
|
|
|
|
pressed, resulting in a combined character with a diacritic. For example,
|
|
|
|
pressing `^` and then `e` will produce `ê`. Pressing `^` then `SPACE`
|
|
|
|
will produce `^` on its own.
|
|
|
|
|
|
|
|
If you are a heavy user of Vi style editors then you may wish to disable
|
|
|
|
dead key processing so that `^` can be used with a single keypress.
|
|
|
|
|
|
|
|
You can tell WezTerm to disable dead keys by setting this in your configuration
|
|
|
|
file:
|
|
|
|
|
|
|
|
```lua
|
|
|
|
return {
|
|
|
|
use_dead_keys = false
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2020-06-20 23:37:59 +03:00
|
|
|
### Defining Assignments for key combinations that may be composed
|
|
|
|
|
|
|
|
When a key combination produces a composed key result, wezterm will look up
|
|
|
|
both the composed and uncomposed versions of the keypress in your key mappings.
|
|
|
|
If either lookup matches your assignment, that will take precedence over
|
|
|
|
the normal key processing.
|
|
|
|
|
|
|
|
## Default Shortcut / Key Binding Assignments
|
2019-12-30 07:41:08 +03:00
|
|
|
|
|
|
|
The default key bindings are:
|
|
|
|
|
|
|
|
| Modifiers | Key | Action |
|
|
|
|
| --------- | --- | ------ |
|
|
|
|
| `SUPER` | `c` | `Copy` |
|
|
|
|
| `SUPER` | `v` | `Paste` |
|
|
|
|
| `CTRL+SHIFT` | `c` | `Copy` |
|
|
|
|
| `CTRL+SHIFT` | `v` | `Paste` |
|
|
|
|
| `SHIFT` | `Insert` | `Paste` |
|
|
|
|
| `SUPER` | `m` | `Hide` |
|
|
|
|
| `SUPER` | `n` | `SpawnWindow` |
|
|
|
|
| `CTRL+SHIFT` | `n` | `SpawnWindow` |
|
|
|
|
| `ALT` | `Enter` | `ToggleFullScreen` |
|
|
|
|
| `SUPER` | `-` | `DecreaseFontSize` |
|
|
|
|
| `CTRL` | `-` | `DecreaseFontSize` |
|
|
|
|
| `SUPER` | `=` | `IncreaseFontSize` |
|
|
|
|
| `CTRL` | `=` | `IncreaseFontSize` |
|
|
|
|
| `SUPER` | `0` | `ResetFontSize` |
|
|
|
|
| `CTRL` | `0` | `ResetFontSize` |
|
2020-06-27 02:49:07 +03:00
|
|
|
| `SUPER` | `t` | `SpawnTab="CurrentPaneDomain"` |
|
|
|
|
| `CTRL+SHIFT` | `t` | `SpawnTab="CurrentPaneDomain"` |
|
2020-05-22 09:09:57 +03:00
|
|
|
| `SUPER+SHIFT` | `T` | `SpawnTab="DefaultDomain"` |
|
2019-12-30 07:41:08 +03:00
|
|
|
| `SUPER` | `w` | `CloseCurrentTab` |
|
2020-05-22 09:09:57 +03:00
|
|
|
| `SUPER` | `1` | `ActivateTab=0` |
|
|
|
|
| `SUPER` | `2` | `ActivateTab=1` |
|
|
|
|
| `SUPER` | `3` | `ActivateTab=2` |
|
|
|
|
| `SUPER` | `4` | `ActivateTab=3` |
|
|
|
|
| `SUPER` | `5` | `ActivateTab=4` |
|
|
|
|
| `SUPER` | `6` | `ActivateTab=5` |
|
|
|
|
| `SUPER` | `7` | `ActivateTab=6` |
|
|
|
|
| `SUPER` | `8` | `ActivateTab=7` |
|
2020-06-20 22:42:39 +03:00
|
|
|
| `SUPER` | `9` | `ActivateTab=-1` |
|
2019-12-30 07:41:08 +03:00
|
|
|
| `CTRL+SHIFT` | `w` | `CloseCurrentTab` |
|
2020-05-22 09:09:57 +03:00
|
|
|
| `CTRL+SHIFT` | `1` | `ActivateTab=0` |
|
|
|
|
| `CTRL+SHIFT` | `2` | `ActivateTab=1` |
|
|
|
|
| `CTRL+SHIFT` | `3` | `ActivateTab=2` |
|
|
|
|
| `CTRL+SHIFT` | `4` | `ActivateTab=3` |
|
|
|
|
| `CTRL+SHIFT` | `5` | `ActivateTab=4` |
|
|
|
|
| `CTRL+SHIFT` | `6` | `ActivateTab=5` |
|
|
|
|
| `CTRL+SHIFT` | `7` | `ActivateTab=6` |
|
|
|
|
| `CTRL+SHIFT` | `8` | `ActivateTab=7` |
|
2020-06-20 22:42:39 +03:00
|
|
|
| `CTRL+SHIFT` | `9` | `ActivateTab=-1` |
|
2020-05-22 09:09:57 +03:00
|
|
|
| `SUPER+SHIFT` | `[` | `ActivateTabRelative=-1` |
|
|
|
|
| `SUPER+SHIFT` | `]` | `ActivateTabRelative=1` |
|
2020-11-24 21:13:41 +03:00
|
|
|
| `CTRL+SHIFT` | `PageUp` | `MoveTabRelative=-1` |
|
|
|
|
| `CTRL+SHIFT` | `PageDown` | `MoveTabRelative=1` |
|
|
|
|
| `SHIFT` | `PageUp` | `ScrollByPage=-1` |
|
|
|
|
| `SHIFT` | `PageDown` | `ScrollByPage=1` |
|
2020-05-22 18:05:59 +03:00
|
|
|
| `ALT` | `9` | `ShowTabNavigator` |
|
|
|
|
| `SUPER` | `r` | `ReloadConfiguration` |
|
|
|
|
| `CTRL+SHIFT` | `R` | `ReloadConfiguration` |
|
|
|
|
| `SUPER` | `h` | `HideApplication` (macOS only) |
|
2020-05-26 03:29:22 +03:00
|
|
|
| `SUPER` | `k` | `ClearScrollback` |
|
|
|
|
| `CTRL+SHIFT` | `K` | `ClearScrollback` |
|
2020-06-05 18:07:46 +03:00
|
|
|
| `SUPER` | `f` | `Search={CaseSensitiveString=""}` |
|
|
|
|
| `CTRL+SHIFT` | `F` | `Search={CaseSensitiveString=""}` |
|
|
|
|
| `CTRL+SHIFT` | `X` | `ActivateCopyMode` |
|
2020-10-10 19:50:18 +03:00
|
|
|
| `CTRL+SHIFT+ALT` | `"` | `SplitVertical={domain="CurrentPaneDomain"}` |
|
|
|
|
| `CTRL+SHIFT+ALT` | `%` | `SplitHorizontal={domain="CurrentPaneDomain"}` |
|
|
|
|
| `CTRL+SHIFT+ALT` | `LeftArrow` | `AdjustPaneSize={"Left", 1}` |
|
|
|
|
| `CTRL+SHIFT+ALT` | `RightArrow` | `AdjustPaneSize={"Right", 1}` |
|
|
|
|
| `CTRL+SHIFT+ALT` | `UpArrow` | `AdjustPaneSize={"Up", 1}` |
|
|
|
|
| `CTRL+SHIFT+ALT` | `DownArrow` | `AdjustPaneSize={"Down", 1}` |
|
|
|
|
| `CTRL+SHIFT` | `LeftArrow` | `ActivatePaneDirection="Left"` |
|
|
|
|
| `CTRL+SHIFT` | `RightArrow` | `ActivatePaneDirection="Right"` |
|
|
|
|
| `CTRL+SHIFT` | `UpArrow` | `ActivatePaneDirection="Up"` |
|
|
|
|
| `CTRL+SHIFT` | `DownArrow` | `ActivatePaneDirection="Down"` |
|
|
|
|
| `CTRL` | `Z` | `TogglePaneZoomState` |
|
2020-05-22 18:05:59 +03:00
|
|
|
|
2020-09-26 06:06:50 +03:00
|
|
|
If you don't want the default assignments to be registered, you can
|
|
|
|
disable all of them with this configuration; if you chose to do this,
|
|
|
|
you must explicitly register every binding.
|
|
|
|
|
|
|
|
```lua
|
|
|
|
return {
|
|
|
|
disable_default_key_bindings = true,
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2020-05-22 18:05:59 +03:00
|
|
|
## Default Mouse Assignments
|
|
|
|
|
|
|
|
In the table below, `Triple Left Down` means that the left mouse button is
|
|
|
|
being triple clicked and that the event matches the downstroke of the third
|
|
|
|
quick consecutive press. `Triple Left Up` matches the subsequent release event
|
|
|
|
of that triple click, so for a triple click both
|
|
|
|
`SelectTextAtMouseCursor="Line"` and `CompleteSelection` will be triggered in
|
|
|
|
that order.
|
|
|
|
|
|
|
|
| Event | Modifiers | Action |
|
|
|
|
| --------- | --- | ------ |
|
|
|
|
| Triple Left Down | `NONE` | `SelectTextAtMouseCursor="Line"` |
|
|
|
|
| Double Left Down | `NONE` | `SelectTextAtMouseCursor="Word"` |
|
|
|
|
| Single Left Down | `NONE` | `SelectTextAtMouseCursor="Cell"` |
|
2020-09-27 20:34:03 +03:00
|
|
|
| Single Left Down | `SHIFT` | `ExtendSelectionToMouseCursor={}` |
|
2020-05-22 18:05:59 +03:00
|
|
|
| Single Left Up | `NONE` | `CompleteSelectionOrOpenLinkAtMouseCursor` |
|
|
|
|
| Double Left Up | `NONE` | `CompleteSelection` |
|
|
|
|
| Triple Left Up | `NONE` | `CompleteSelection` |
|
|
|
|
| Single Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Cell"` |
|
|
|
|
| Double Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Word"` |
|
|
|
|
| Triple Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Line"` |
|
|
|
|
| Single Middle Down | `NONE` | `Paste` |
|
|
|
|
|
2020-09-26 06:06:50 +03:00
|
|
|
If you don't want the default assignments to be registered, you can
|
|
|
|
disable all of them with this configuration; if you chose to do this,
|
|
|
|
you must explicitly register every binding.
|
|
|
|
|
|
|
|
```lua
|
|
|
|
return {
|
|
|
|
disable_default_mouse_bindings = true,
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2020-05-22 18:05:59 +03:00
|
|
|
## Configuring Mouse Assignments
|
|
|
|
|
2020-06-17 10:08:43 +03:00
|
|
|
*since: 20200607-144723-74889cd4*
|
2020-05-22 18:05:59 +03:00
|
|
|
|
|
|
|
You can define mouse actions using the `mouse_bindings` configuration section:
|
|
|
|
|
|
|
|
```lua
|
|
|
|
local wezterm = require 'wezterm';
|
|
|
|
|
|
|
|
return {
|
|
|
|
mouse_bindings = {
|
|
|
|
-- Right click sends "woot" to the terminal
|
|
|
|
{
|
|
|
|
event={Down={streak=1, button="Right"}},
|
|
|
|
mods="NONE",
|
|
|
|
action=wezterm.action{SendString="woot"}
|
|
|
|
},
|
|
|
|
|
|
|
|
-- Change the default click behavior so that it only selects
|
|
|
|
-- text and doesn't open hyperlinks
|
|
|
|
{
|
|
|
|
event={Up={streak=1, button="Left"}},
|
|
|
|
mods="NONE",
|
|
|
|
action="CompleteSelection",
|
|
|
|
},
|
|
|
|
|
|
|
|
-- and make CTRL-Click open hyperlinks
|
|
|
|
{
|
|
|
|
event={Up={streak=1, button="Left"}},
|
|
|
|
mods="CTRL",
|
|
|
|
action="OpenLinkAtMouseCursor",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
The `action` and `mods` portions are described in more detail in the key assignment
|
|
|
|
information below.
|
|
|
|
|
|
|
|
The `event` portion has three components;
|
|
|
|
|
|
|
|
* Whether it is a `Down`, `Up` or `Drag` event
|
|
|
|
* The number of consecutive clicks within the click threshold (the *click streak*)
|
|
|
|
* The mouse button; `Left`, `Right`, or `Middle`.
|
|
|
|
|
|
|
|
A double click is a `down-up-down` sequence where either the second button down
|
|
|
|
is held for long enough or is released and no subsequent down event occurs
|
|
|
|
within the click threshold. When recognized, it emits a `Down` event with
|
|
|
|
`streak=2`. If the mouse is moved while the button is held, a `Drag` event
|
|
|
|
with `streak=2` is generated. When the mouse button is released an `Up` event
|
|
|
|
with `streak=2` is generated.
|
|
|
|
|
|
|
|
The mouse event recognizer supports an arbitrary click streak, so if
|
|
|
|
you wanted quadruple-click bindings you can specify `streak=4`.
|
|
|
|
|
|
|
|
| Event | Lua Representation |
|
|
|
|
| ----------------- | ------------------- |
|
|
|
|
| Triple Left Down | `event={Down={streak=3, button="Left"}}` |
|
|
|
|
| Double Left Up | `event={Up={streak=2, button="Left"}}` |
|
|
|
|
| Single Left Drag | `event={Drag={streak=1, button="Left"}}` |
|
|
|
|
|
|
|
|
|
|
|
|
## Configuring Key Assignments
|
|
|
|
|
2019-12-30 07:41:08 +03:00
|
|
|
|
2020-04-07 02:32:16 +03:00
|
|
|
These can be overridden using the `keys` section in your `~/.wezterm.lua` config file.
|
2019-12-30 07:41:08 +03:00
|
|
|
For example, you can disable a default assignment like this:
|
|
|
|
|
2020-04-07 02:32:16 +03:00
|
|
|
```lua
|
|
|
|
local wezterm = require 'wezterm';
|
|
|
|
|
|
|
|
return {
|
|
|
|
keys = {
|
|
|
|
-- Turn off the default CMD-m Hide action on macOS by making it
|
|
|
|
-- send the empty string instead of hiding the window
|
2020-05-22 09:09:57 +03:00
|
|
|
{key="m", mods="CMD", action="Nop"}
|
2020-04-07 02:32:16 +03:00
|
|
|
}
|
|
|
|
}
|
2019-12-30 07:41:08 +03:00
|
|
|
```
|
|
|
|
|
|
|
|
The `key` value can be one of the following keycode identifiers. Note that not
|
|
|
|
all of these are meaningful on all platforms:
|
|
|
|
|
|
|
|
`Hyper`, `Super`, `Meta`, `Cancel`, `Backspace`, `Tab`, `Clear`, `Enter`,
|
|
|
|
`Shift`, `Escape`, `LeftShift`, `RightShift`, `Control`, `LeftControl`,
|
|
|
|
`RightControl`, `Alt`, `LeftAlt`, `RightAlt`, `Menu`, `LeftMenu`, `RightMenu`,
|
|
|
|
`Pause`, `CapsLock`, `PageUp`, `PageDown`, `End`, `Home`, `LeftArrow`,
|
|
|
|
`RightArrow`, `UpArrow`, `DownArrow`, `Select`, `Print`, `Execute`,
|
|
|
|
`PrintScreen`, `Insert`, `Delete`, `Help`, `LeftWindows`, `RightWindows`,
|
|
|
|
`Applications`, `Sleep`, `Numpad0`, `Numpad1`, `Numpad2`, `Numpad3`,
|
|
|
|
`Numpad4`, `Numpad5`, `Numpad6`, `Numpad7`, `Numpad8`, `Numpad9`, `Multiply`,
|
|
|
|
`Add`, `Separator`, `Subtract`, `Decimal`, `Divide`, `NumLock`, `ScrollLock`,
|
|
|
|
`BrowserBack`, `BrowserForward`, `BrowserRefresh`, `BrowserStop`,
|
|
|
|
`BrowserSearch`, `BrowserFavorites`, `BrowserHome`, `VolumeMute`,
|
|
|
|
`VolumeDown`, `VolumeUp`, `MediaNextTrack`, `MediaPrevTrack`, `MediaStop`,
|
|
|
|
`MediaPlayPause`, `ApplicationLeftArrow`, `ApplicationRightArrow`,
|
|
|
|
`ApplicationUpArrow`, `ApplicationDownArrow`.
|
|
|
|
|
|
|
|
Alternatively, a single unicode character can be specified to indicate
|
|
|
|
pressing the corresponding key.
|
|
|
|
|
|
|
|
Possible Modifier labels are:
|
|
|
|
|
|
|
|
* `SUPER`, `CMD`, `WIN` - these are all equivalent: on macOS the `Command` key,
|
|
|
|
on Windows the `Windows` key, on Linux this can also be the `Super` or `Hyper`
|
|
|
|
key. Left and right are equivalent.
|
|
|
|
* `SHIFT` - The shift key. Left and right are equivalent.
|
|
|
|
* `ALT`, `OPT`, `META` - these are all equivalent: on macOS the `Option` key,
|
|
|
|
on other systems the `Alt` or `Meta` key. Left and right are equivalent.
|
|
|
|
|
|
|
|
You can combine modifiers using the `|` symbol (eg: `"CMD|CTRL"`).
|
|
|
|
|
2020-10-10 19:57:38 +03:00
|
|
|
### Leader Key
|
|
|
|
|
2020-11-01 01:51:08 +03:00
|
|
|
*Since: 20201031-154415-9614e117*
|
2020-10-10 19:57:38 +03:00
|
|
|
|
|
|
|
A *leader* key is a a modal modifier key. If leader is specified in the
|
|
|
|
configuration then pressing that key combination will enable a virtual `LEADER`
|
|
|
|
modifier.
|
|
|
|
|
|
|
|
While `LEADER` is active, only defined key assignments that include
|
|
|
|
`LEADER` in the `mods` mask will be recognized. Other keypresses
|
|
|
|
will be swallowed and NOT passed through to the terminal.
|
|
|
|
|
|
|
|
`LEADER` stays active until a keypress is registered (whether it
|
|
|
|
matches a key binding or not), or until it has been active for
|
|
|
|
the duration specified by `timeout_milliseconds`, at which point
|
|
|
|
it will automatically cancel itself.
|
|
|
|
|
|
|
|
Here's an example configuration using `LEADER`. In this configuration,
|
|
|
|
pressing `CTRL-A` activates the leader key for up to 1 second (1000
|
|
|
|
milliseconds). While `LEADER` is active, the `|` key (with no other modifiers)
|
|
|
|
will trigger the current pane to be split.
|
|
|
|
|
|
|
|
```lua
|
|
|
|
local wezterm = require 'wezterm';
|
|
|
|
|
|
|
|
return {
|
|
|
|
-- timeout_milliseconds defaults to 1000 and can be omitted
|
|
|
|
leader = { key="a", mods="CTRL", timeout_milliseconds=1000 },
|
|
|
|
keys = {
|
|
|
|
{key="|", mods="LEADER", action=wezterm.action{SplitHorizontal={domain="CurrentPaneDomain"}}},
|
|
|
|
-- Send "CTRL-A" to the terminal when pressing CTRL-A, CTRL-A
|
|
|
|
{key="a", mods="LEADER|CTRL", action=wezterm.action{SendString="\x01"}},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2020-10-10 18:40:14 +03:00
|
|
|
# Available Actions
|
2019-12-30 07:41:08 +03:00
|
|
|
|
2020-10-10 18:40:14 +03:00
|
|
|
See the [`KeyAssignment` reference](lua/keyassignment/index.md) for information
|
|
|
|
on available actions.
|
2019-12-30 07:41:08 +03:00
|
|
|
|