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.

class libtmux-java latest

CaptureSpec

What part of a pane to read, and how.

Source and package
Qualified name
io.github.libtmux.CaptureSpec
Package
io.github.libtmux
Distribution
io.github.libtmux:libtmux
Source
libtmux/src/main/java/io/github/libtmux/CaptureSpec.java
class io.github.libtmux.CaptureSpec

Description#

The shape SplitSpec uses. A plain Pane#capture() reads what is on screen; this is how to reach the scrollback above it, or to keep what tmux otherwise strips.

Lines are numbered from the top of the visible area, so 0 is the first row on screen and negatives climb into the history. fromStartOfHistory() is the whole of what tmux kept.

Examples#

List<String> everything = pane.capture(c -> c.fromStartOfHistory());
List<String> lastTen = pane.capture(c -> c.from(-10));

Members3#

  • argv method The command that reads the pane.
  • builder method A builder that reads what is on screen and nothing else.
  • Builder class Collects the choices, each named for what it does rather than for the flag it sets.
Esc

Type to search.

Reference previewOpen reference