Python API

method libtmux latest

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: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp RubyLuaTypeScriptRustGoJavaC#C++ Swift Kotlin Scala OCaml F# Clojure

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

The tmux commands behind copy_mode.

The C declarations in tmux that implement these commands.

Put a pane into copy mode

Equivalents of Put a pane into copy mode in other languages
Language	Equivalent
Ruby	`LibTmux::Pane#copy_mode`
Lua	`libtmux.Pane:copy_mode`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
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`
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.