CapturePaneRequest
CapturePaneRequest configures pane capture. Its zero value captures the visible screen with tmux's default text handling. Version-gated flags follow UnsupportedPolicy. tmux.CaptureBoundary selects the start of history for Start and the end of the visible pane for End.
Source and package
- Qualified name
-
tmux.Capture Pane Request - Package
- tmux
- Distribution
- github.com/libtmux/libtmux-go/tmux
- Source
- tmux/pane_capture.go
Fields14#
| Name | Type | Description |
|---|---|---|
| End | Capture | End selects the last captured line. Empty uses tmux's visible-screen default; CaptureBoundary selects the end of the visible pane. |
| AlternateScreen | bool | AlternateScreen captures the alternate screen without history. |
| EscapeNonPrintable | bool | EscapeNonPrintable renders non-printable characters as octal escapes. |
| EscapeSequences | bool | EscapeSequences includes terminal attribute escape sequences. |
| Hyperlinks | bool | Hyperlinks captures hyperlink metadata for the selected lines. It requires tmux 3.7; see UnsupportedPolicy. |
| JoinWrapped | bool | JoinWrapped joins wrapped lines, preserves their trailing spaces, and implies tmux trimming independently of TrimTrailing. |
| LineFlags | bool | LineFlags prefixes each line with tmux line metadata flags. It requires tmux 3.7; see UnsupportedPolicy. |
| LineNumbers | bool | LineNumbers prefixes each line with its tmux line number. It requires tmux 3.7; see UnsupportedPolicy. |
| ModeScreen | bool | ModeScreen captures the active mode screen. It requires tmux 3.6; see UnsupportedPolicy. |
| Pending | bool | Pending captures only the beginning of an incomplete escape sequence. |
| PreserveTrailing | bool | PreserveTrailing preserves trailing spaces at each line end. |
| Quiet | bool | Quiet suppresses tmux's error when AlternateScreen is requested but no alternate screen exists. |
| Start | Capture | Start selects the first captured line. Empty uses tmux's visible-screen default; CaptureBoundary selects the start of history. |
| TrimTrailing | bool | TrimTrailing omits trailing positions without characters. It requires tmux 3.4; see UnsupportedPolicy. |
Guides#
Pages that discuss CapturePaneRequest.
- Examples