tmux.CapturePaneRequest

struct tmux.CapturePaneRequest

struct [source] ¶

struct [source] ¶

struct tmux.CapturePaneRequest

CapturePaneRequest configures pane capture. Its zero value captures the visible screen with tmux's default text handling. Version-gated flags follow UnsupportedPolicy . CaptureBoundary selects the start of history for Start and the end of the visible pane for End.

Members

• AlternateScreen attribute AlternateScreen captures the alternate screen without history.
• End attribute End selects the last captured line. Empty uses tmux's visible-screen default; CaptureBoundary selects the end of the visible pane.
• EscapeNonPrintable attribute EscapeNonPrintable renders non-printable characters as octal escapes.
• EscapeSequences attribute EscapeSequences includes terminal attribute escape sequences.
• Hyperlinks attribute Hyperlinks captures hyperlink metadata for the selected lines. It requires tmux 3.7; see UnsupportedPolicy.
• JoinWrapped attribute JoinWrapped joins wrapped lines, preserves their trailing spaces, and implies tmux trimming independently of TrimTrailing.
• LineFlags attribute LineFlags prefixes each line with tmux line metadata flags. It requires tmux 3.7; see UnsupportedPolicy.
• LineNumbers attribute LineNumbers prefixes each line with its tmux line number. It requires tmux 3.7; see UnsupportedPolicy.
• ModeScreen attribute ModeScreen captures the active mode screen. It requires tmux 3.6; see UnsupportedPolicy.
• Pending attribute Pending captures only the beginning of an incomplete escape sequence.
• PreserveTrailing attribute PreserveTrailing preserves trailing spaces at each line end.
• Quiet attribute Quiet suppresses tmux's error when AlternateScreen is requested but no alternate screen exists.
• Start attribute Start selects the first captured line. Empty uses tmux's visible-screen default; CaptureBoundary selects the start of history.
• TrimTrailing attribute TrimTrailing omits trailing positions without characters. It requires tmux 3.4; see UnsupportedPolicy.