capture_pane: Capture the contents of a tmux pane

In datascienceworkshops/tmuxr: Manage 'tmux' Sessions, Windows, and Panes

Capture the contents of a tmux pane

Description

Capture the contents of a tmux pane

Usage

capture_pane(
  target = NULL,
  start = NULL,
  end = NULL,
  escape = FALSE,
  escape_control = FALSE,
  trailing_spaces = FALSE,
  join = FALSE,
  cat = FALSE
)

Arguments

target	A tmuxr_session, tmuxr_window, or tmuxr_pane. If NULL, the currently active pane is used. Default: NULL.
start, end	An integer or a dash (-). First and last lines to capture. 0 is the first line of the visible pane and negative integers are lines in the history. A dash (-) for start is the start of the history and to end the end of the visible pane. The default is to capture only the visible contents of the pane.
escape	A logical. If TRUE, include escape sequences for text and background attributes. Default: FALSE.
escape_control	A logical. If TRUE, also escape control characters as octal \xxx. Default: FALSE.
trailing_spaces	A logical. If TRUE, preserve trailing spaces at each line. Default: FALSE.
join	A logical. If TRUE, join wrapped lines and preserve trailing spaces at each line. Default: FALSE.
cat	A logical. If TRUE, concatenate lines into one string. Default: FALSE.

Value

A vector of strings or one string when cat is TRUE.

See Also

send_keys()

datascienceworkshops/tmuxr documentation built on April 26, 2024, 5:26 a.m.