4.7 KiB
since: 20200607-144723-74889cd4
Copy mode allows you to make selections using the keyboard; no need to reach for your mouse or trackpad. Copy mode is similar to quick select mode but is geared up for describing selections based on keyboard control, whereas quick select mode is used to quickly select and copy commonly used patterns. The colors of the highlighted/selected text can be configured.
The ActivateCopyMode key assignment is used to enter copy mode; it is
bound to CTRL-SHIFT-X by default.
When copy mode is activated, the title is prefixed with "Copy Mode" and the behavior of the tab is changed; keyboard input now controls the cursor and allows moving it through the scrollback, scrolling the viewport as needed, in a style similar to that of the Vim editor.
Move the cursor to the start of the region you wish to select and press v to
toggle selection mode (it is off by default), then move the cursor to the end
of that region. You can then use Copy (by default: CTRL-SHIFT-C) to copy
that region to the clipboard.
Key Assignments
The default key assignments in copy mode are as follows:
| Action | Key Assignment |
|---|---|
| Activate copy mode | Ctrl + Shift + X |
| Copy and exit copy mode | y |
| Exit copy mode | Esc |
| Ctrl + C | |
| Ctrl + G | |
| q | |
| Cell selection | v |
| Line selection | Shift + V |
| Rectangular selection | Ctrl + V (since: 20220624-141144-bd1b7c5d) |
| Move Left | LeftArrow |
| h | |
| Move Down | DownArrow |
| j | |
| Move Up | UpArrow |
| k | |
| Move Right | RightArrow |
| l | |
| Move forward one word | Alt + RightArrow |
| Alt + F | |
| Tab | |
| w | |
| Move backward one word | Alt + LeftArrow |
| Alt + B | |
| Shift + Tab | |
| b | |
| Move forward one word end | e (since: nightly builds only) |
| Move to start of this line | 0 |
| Home | |
| Move to start of next line | Enter |
| Move to end of this line | $ |
| End | |
| Move to start of indented line | Alt + M |
| ^ | |
| Move to bottom of scrollback | Shift + G |
| Move to top of scrollback | g |
| Move to top of viewport | Shift + H |
| Move to middle of viewport | Shift + M |
| Move to bottom of viewport | Shift + L |
| Move up one screen | PageUp |
| Ctrl + B | |
| Move up half a screen | Ctrl + U (since: nightly builds only) |
| Move down one screen | PageDown |
| Ctrl + F | |
| Move down half a screen | Ctrl + D (since: nightly builds only) |
| Move to other end of the selection | o |
| Move to other end of the selection horizontally | Shift + O (useful in Rectangular mode) |
Configurable Key Assignments
Since: 20220624-141144-bd1b7c5d
The key assignments for copy mode are specified by the copy_mode Key Table.
You may provide your own definition of this key table if you wish to customize it.
You may use wezterm.gui.default_key_tables to obtain the defaults and extend them. In earlier versions of wezterm there wasn't a way to override portions of the key table, only to replace the entire table.
The default configuration at the time that these docs were built (which may be more recent than your version of wezterm) is shown below.
You can see the configuration in your version of wezterm by running
wezterm show-keys --lua --key-table copy_mode.
{% include "examples/default-copy-mode-key-table.markdown" %}