Skip to content

Commit 74b0ff7

Browse files
committed
Document @yank_action
1 parent f855b93 commit 74b0ff7

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,18 @@ You can change this by setting `@yank_selection_mouse`:
219219
220220
set -g @yank_selection_mouse 'clipboard' # or 'primary' or 'secondary'
221221
```
222+
223+
### Controlling Yank Behavior
224+
225+
By default, `tmux-yank` will exit copy mode after yanking text. If you wish to
226+
remain in copy mode, you can set `@yank_action`:
227+
228+
``` tmux
229+
# ~/.tmux.conf
230+
231+
set -g @yank_action 'copy-pipe' # or 'copy-pipe-and-cancel' for the default
232+
```
233+
222234
### Mouse Support
223235
224236
`tmux-yank` has mouse support enabled by default. It will only work if `tmux`'s
@@ -237,6 +249,9 @@ the `MouseDragEnd1Pane` event, you can do so with:
237249
set -g @yank_with_mouse off # or 'on'
238250
```
239251

252+
If you want to remain in copy mode after making a mouse selection, set
253+
`@yank_action` as described above.
254+
240255
### vi mode support
241256

242257
If using `tmux` 2.3 or older *and* using vi keys then you'll have add the

0 commit comments

Comments
 (0)