tmux.CopyModeRequest

struct tmux.CopyModeRequest

struct [source] ¶

struct [source] ¶

struct tmux.CopyModeRequest

CopyModeRequest configures tmux copy mode. Its zero value enters copy mode on the receiver without scrolling. Fields may be combined. tmux resolves the receiver and optional SourcePane before processing Cancel, so a stale target can prevent reset. After resolution, Cancel takes precedence over other actions, though SourcePane validation and the PageDown version probe still occur first.

Members

• Cancel attribute Cancel exits copy mode and any other active pane mode after tmux resolves the receiver and optional SourcePane. A resolution failure prevents the reset; after successful resolution, tmux ignores the other action fields.
• ExitOnBottom attribute ExitOnBottom makes copy mode exit after scrolling back to the visible screen, until another non-scrolling key disables that behavior.
• MouseDrag attribute MouseDrag begins a copy-mode mouse drag and is meaningful from a mouse binding.
• PageDown attribute PageDown enters copy mode one page below the current position. It requires tmux 3.5 and follows UnsupportedPolicy. Its version probe still occurs when Cancel is set.
• ScrollUp attribute ScrollUp enters copy mode one page above the current position.
• SourcePane attribute SourcePane selects a stable pane whose content is copied while the receiver remains the pane placed in copy mode. Zero uses the receiver. A nonzero value is validated by the library and resolved by tmux even when Cancel is set; a stale or nonexistent pane can prevent cancellation.