tmuxtmuxOptions, hooks and formats

Choose documentation 1

latest

tmux catalog version

Latest (3.7c) 3.7c 3.2a
English

option tmux3.7c

set-clipboard

Attempt to set the terminal clipboard content using the xterm(1) escape sequence, if there is an Ms entry in the terminfo(5) description (see the TERMINFO EXTENSIONS section).

Scope
server
Type
Choice
Default
external
Values
off external on
Set
set-option -s set-clipboard value
Read
show-options -s set-clipboard

Description#

Attempt to set the terminal clipboard content using the xterm(1) escape sequence, if there is an Ms entry in the terminfo(5) description (see the TERMINFO EXTENSIONS section).

If set to on, tmux will both accept the escape sequence to create a buffer and attempt to set the terminal clipboard. If set to external, tmux will attempt to set the terminal clipboard but ignore attempts by applications to set tmux buffers. If off, tmux will neither accept the clipboard escape sequence nor attempt to set the clipboard.

Note that this feature needs to be enabled in xterm(1) by setting the resource:

disallowedWindowOps: 20,21,SetXprop

Or changing this property from the xterm(1) interactive menu when required.

Releases#

Source#

Defined in
options-table.c:508
C source reference
options_table
CLI Manual
Original manual entry

Used by#

Library documentation that names this option.

Rust
options.generated.SET_CLIPBOARD
Go
tmux.Server.SetClipboard, tmux.ServerOptionValues.SetClipboard, tmux.SetClipboard
Esc

Type to search.

Reference preview Open reference