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

TmuxPaneFlowEvent

tmux paused or resumed output for a pane that fell behind.

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

Description#

This connection answers every pause it observes with its own refresh-client -A <pane>:continue (see WatchOptions.pauseAfterSeconds), whether tmux paused the pane on its own or a caller paused it directly with server.cmd("refresh-client", ["-A", "<pane>:pause"]) on this same connection's client. A pause held that way is resumed within one round trip; it does not stay paused for the caller to inspect.

pause/continue and off/on (refresh-client -A <pane>:off / :on) are independent pairs tmux tracks separately. Resuming with the wrong verb

  • off then continue, or pause then on - returns success but leaves

the pane's output undelivered; off stops tmux from reading that pane's pty at all, which also freezes it for every other client, not only this connection's.

Members2#

Esc

Type to search.

Reference previewOpen reference