Python API

libtmux.Pane.copy_mode

Python

Enter copy mode via $ tmux copy-mode.

Parameters

scroll_up ( bool | None ) – Start scrolled up one page (-u flag).
exit_on_bottom ( bool | None ) – Exit copy mode when scrolling reaches the bottom of the history (-e flag).
mouse_drag ( bool | None ) – Start mouse drag (-M flag).
cancel ( bool | None ) – Cancel copy mode and any other modes (-q flag).
page_down ( bool | None ) – Scroll a page down if already in copy mode (-d flag). Requires tmux 3.5+.
source_pane ( str | None ) – Source pane whose contents should be displayed in copy mode (-s flag). Lets you scroll/copy from another pane's history. Requires tmux 3.2+.

In other ports Put a pane into copy mode

Examples

Python TypeScript

>>> pane.copy_mode()

await pane.enterCopyMode();

0 declared, 0 inherited