C++ API

method libtmux-cxx latest

Pane.enter_copy_mode

Put this pane into copy mode, where its contents can be scrolled and selected rather than typed into.

Source and package

Qualified name: libtmux::Pane::enter_copy_mode
Namespace: libtmux
Declared in: Pane
Package: libtmux-cxx
Source: include/libtmux/entities.hpp
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC# Swift Kotlin Scala OCaml F# Clojure

[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<void, CommandFailure> enter_copy_mode() const; method readonly [source] ¶: Description#

Needs no attached client: the mode is pane state, which in_mode() reports. Entering twice is harmless.

tmux command#

The tmux commands behind enter_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
Python	`libtmux.Pane.copy_mode`
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`
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#.