Python API

method libtmux stable

Pane.copy_mode

Enter copy mode via $ tmux copy-mode.

Source and package

Qualified name: libtmux.Pane.copy_mode
Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/pane.py
Other languages: PowerShell Julia RubyLuaTypeScriptRustGoJavaC#C++ Swift Kotlin Scala F#

Examples#

>>> pane.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+.

tmux command copy-mode

In other ports Put a pane into copy mode

PowerShell
No source-verified PowerShell equivalent is recorded for this operation.
Julia
No source-verified Julia equivalent is recorded for this operation.
Ruby
LibTmux::Pane#copy_mode
Lua
libtmux.Pane:copy_mode
TypeScript
pane.Pane.enterCopyMode
Rust
pane.Pane.copy_mode
Go
tmux.Pane.CopyMode
Java
io.github.libtmux.Pane.copyMode
C#
LibTmux.Pane.EnterCopyModeAsync
C++
libtmux::Pane::enter_copy_mode
Swift
no equivalent on Pane
Kotlin
No source-verified Kotlin equivalent is recorded for this operation.
Scala
No source-verified Scala equivalent is recorded for this operation.
F#
No source-verified F# equivalent is recorded for this operation.