Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Go API

Go documentation

View as Markdown

Module
tmux
Declared in
Pane
Package
github.com/libtmux/libtmux-go/tmux
Source
tmux/pane_modes.go
Other languages
PythonRubyLuaTypeScriptRustJava.NETC++ Swift
CopyMode ( ctx : context.Context , request : CopyModeRequest ) → error
method [source]
method [source]
CopyMode

CopyMode enters or cancels copy mode using the receiver's exact linked session-window-pane target. PageDown requires tmux 3.5 and follows UnsupportedPolicy . A version-probe error stops the operation. tmux resolves the receiver and optional SourcePane before processing Cancel; a stale target can therefore fail without resetting the current mode. Cancel then takes precedence over other actions.

Only stderr produces a redacted CommandError ; nonzero exits without stderr are ignored. Accepted mode changes are not rolled back.

In other ports Put a pane into copy mode

0 declared, 0 inherited

Esc

Type to search.