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.Builder

Collects the choices, each named for what it does rather than for the flag it sets.

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

Members15#

  • build method The finished spec.
  • escapingNonPrintable method Writes anything unprintable as an octal escape rather than dropping it.
  • from method Starts at a line, counted from the top of the visible area.
  • fromAlternateScreen method Reads the alternate screen, which is what a full-screen program draws on.
  • fromModeScreen method Reads what a mode is showing rather than the pane beneath it. Requires tmux 3.6.
  • fromStartOfHistory method Starts at the oldest line tmux still has.
  • joiningWrappedLines method Joins a line tmux wrapped back into the one line it was.
  • pendingOnly method Reads only output tmux has not drawn yet.
  • preservingTrailingSpace method Keeps the spaces at the end of a line, which tmux otherwise drops.
  • to method Ends at a line, counted the same way as #from().
  • toEndOfHistory method Ends at the newest line, including anything below the visible area.
  • trimmingTrailingSpace method Drops trailing space and the empty lines below the content. Requires tmux 3.4.
  • withEscapeSequences method Keeps the escape sequences that colour and position the text.
  • withHyperlinks method Keeps hyperlink markers. Requires tmux 3.7.
  • withLineNumbers method Prefixes each line with its number. Requires tmux 3.7.
Esc

Type to search.

Reference previewOpen reference