Pane.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.
Source and package
- Qualified name
-
tmux.Pane. Copy Mode - Package
- tmux
- Declared in
Pane- Distribution
- github.com/libtmux/libtmux-go/tmux
- Source
- tmux/pane_modes.go
- Other languages
- Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustJavaC#C++ Swift Kotlin Scala OCaml F# Clojure
- func (p Pane) CopyMode( ctx context
.Context , request CopyMode , ) errorRequest -
Description#
Only stderr produces a redacted
CommandError; nonzero exits without stderr are ignored. Accepted mode changes are not rolled back.- Parameters
tmux command#
The tmux commands behind CopyMode.
tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Put a pane into copy mode
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Lua | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | pane |
| Rust | pane |
| Java | io |
| C# | Lib |
| C++ | libtmux:: |
| 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#.