Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

interface libtmux-ts latest

CaptureOptions

Which part of a pane is read, and in what form.

Source and package
Qualified name
CaptureOptions
Module
types
Package
libtmux
Source
packages/libtmux/src/types.ts
interface types.CaptureOptions

Description#

A capture reads what the pane is showing, not what the program in it intended: a redrawn screen and a scrolled-off line are both gone.

Members5#

  • alternateScreen: boolean property Capture the screen saved underneath a full-screen program, tmux's -a.
  • end: number property Last line to capture; negative counts back from the visible bottom.
  • escapeSequences: boolean property Keep the escape sequences that colour and style the text, tmux's -e.
  • joinWrapped: boolean property Join wrapped lines, matching tmux's -J.
  • start: number property First line to capture; negative reaches into scrollback history.
Esc

Type to search.

Reference previewOpen reference