Struct tmux_interface::commands::windows_and_panes::capture_pane::CapturePane
source · pub struct CapturePane<'a> {Show 13 fields
pub alternate_screen: bool,
pub escape_sequences: bool,
pub stdout: bool,
pub pane: bool,
pub quiet: bool,
pub escape_non_printable: bool,
pub join: bool,
pub trailing_spaces: bool,
pub ignore_trailing_positions: bool,
pub buffer_name: Option<Cow<'a, str>>,
pub end_line: Option<Cow<'a, str>>,
pub start_line: Option<Cow<'a, str>>,
pub target_pane: Option<Cow<'a, str>>,
}
Expand description
§Manual
tmux ^3.4:
capture-pane [-aAepPqCJNT] [-b buffer-name] [-E end-line] [-S start-line] [-t target-pane]
(alias: capturep)
tmux ^3.1:
capture-pane [-aepPqCJN] [-b buffer-name] [-E end-line] [-S start-line] [-t target-pane]
(alias: capturep)
tmux ^2.4:
capture-pane [-aepPqCJ] [-b buffer-name] [-E end-line] [-S start-line] [-t target-pane]
(alias: capturep)
tmux ^1.8:
capture-pane [-aepPq] [-b buffer-name] [-E end-line] [-S start-line] [-t target-pane]
(alias: capturep)
tmux ^1.5:
capture-pane [-b buffer-index] [-E end-line] [-S start-line] [-t target-pane]
(alias: capturep)
tmux ^1.2:
capture-pane [-b buffer-index] [-t target-pane]
(alias: capturep)
Fields§
§alternate_screen: bool
[-a]
- the alternate screen is used, and the history is not accessible
escape_sequences: bool
[-e]
- the output includes escape sequences for text and background attributes
stdout: bool
[-p]
- the output goes to stdout
pane: bool
[-P]
- capture only any output that the pane has received that is the beginning of an
as-yet incomplete escape sequence
quiet: bool
[-q]
- quiet
escape_non_printable: bool
[-C]
- escape non-printable characters as octal \xxx
join: bool
[-J]
- preserve trailing spaces and joins any wrapped lines
trailing_spaces: bool
[-N]
- preserves trailing spaces at each line’s end
ignore_trailing_positions: bool
[-T]
- ignores trailing positions that do not contain a character
buffer_name: Option<Cow<'a, str>>
[-b buffer-name]
- buffer-name
end_line: Option<Cow<'a, str>>
[-E end-line]
- specify the ending line number
start_line: Option<Cow<'a, str>>
[-S start-line]
- specify the starting line number
target_pane: Option<Cow<'a, str>>
[-t target-pane]
- specify target-pane
Implementations§
source§impl<'a> CapturePane<'a>
impl<'a> CapturePane<'a>
pub fn new() -> Self
sourcepub fn alternate_screen(self) -> Self
pub fn alternate_screen(self) -> Self
[-a]
- the alternate screen is used, and the history is not accessible
sourcepub fn escape_sequences(self) -> Self
pub fn escape_sequences(self) -> Self
[-e]
- the output includes escape sequences for text and background attributes
sourcepub fn pane(self) -> Self
pub fn pane(self) -> Self
[-P]
- capture only any output that the pane has received that is the beginning of an
as-yet incomplete escape sequence
sourcepub fn escape_non_printable(self) -> Self
pub fn escape_non_printable(self) -> Self
[-C]
- escape non-printable characters as octal \xxx
sourcepub fn trailing_spaces(self) -> Self
pub fn trailing_spaces(self) -> Self
[-N]
- preserves trailing spaces at each line’s end
sourcepub fn ignore_trailing_positions(self) -> Self
pub fn ignore_trailing_positions(self) -> Self
[-T]
- ignores trailing positions that do not contain a character
sourcepub fn buffer_name<S: Into<Cow<'a, str>>>(self, buffer_name: S) -> Self
pub fn buffer_name<S: Into<Cow<'a, str>>>(self, buffer_name: S) -> Self
[-b buffer-name]
- buffer-name
sourcepub fn end_line<S: Into<Cow<'a, str>>>(self, end_line: S) -> Self
pub fn end_line<S: Into<Cow<'a, str>>>(self, end_line: S) -> Self
[-E end-line]
- specify the ending line number
sourcepub fn start_line<S: Into<Cow<'a, str>>>(self, start_line: S) -> Self
pub fn start_line<S: Into<Cow<'a, str>>>(self, start_line: S) -> Self
[-S start-line]
- specify the starting line number
sourcepub fn target_pane<S: Into<Cow<'a, str>>>(self, target_pane: S) -> Self
pub fn target_pane<S: Into<Cow<'a, str>>>(self, target_pane: S) -> Self
[-t target-pane]
- specify target-pane
pub fn build(self) -> TmuxCommand<'a>
Trait Implementations§
source§impl<'a> Clone for CapturePane<'a>
impl<'a> Clone for CapturePane<'a>
source§fn clone(&self) -> CapturePane<'a>
fn clone(&self) -> CapturePane<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'a> Debug for CapturePane<'a>
impl<'a> Debug for CapturePane<'a>
source§impl<'a> Default for CapturePane<'a>
impl<'a> Default for CapturePane<'a>
source§fn default() -> CapturePane<'a>
fn default() -> CapturePane<'a>
source§impl<'a> From<CapturePane<'a>> for TmuxCommand<'a>
impl<'a> From<CapturePane<'a>> for TmuxCommand<'a>
source§fn from(item: CapturePane<'a>) -> Self
fn from(item: CapturePane<'a>) -> Self
source§impl<'a> Hash for CapturePane<'a>
impl<'a> Hash for CapturePane<'a>
source§impl<'a> Ord for CapturePane<'a>
impl<'a> Ord for CapturePane<'a>
source§fn cmp(&self, other: &CapturePane<'a>) -> Ordering
fn cmp(&self, other: &CapturePane<'a>) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl<'a> PartialEq for CapturePane<'a>
impl<'a> PartialEq for CapturePane<'a>
source§fn eq(&self, other: &CapturePane<'a>) -> bool
fn eq(&self, other: &CapturePane<'a>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<'a> PartialOrd for CapturePane<'a>
impl<'a> PartialOrd for CapturePane<'a>
source§fn partial_cmp(&self, other: &CapturePane<'a>) -> Option<Ordering>
fn partial_cmp(&self, other: &CapturePane<'a>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more