tmux.SubscriptionRequest

struct tmux.SubscriptionRequest

struct [source] ¶

struct [source] ¶

struct tmux.SubscriptionRequest

SubscriptionRequest names a format for tmux to evaluate and report on this stream whenever its value changes. Its zero value is invalid because Name and Format are required. At most one of Session, Window, and Pane scopes the evaluation; none evaluates against the stream's attached session.

tmux stops evaluating a pane-scoped subscription once that pane's process has exited, so a subscription that must observe pane death is scoped to the window and reads the pane from the change it reports.

Members

• Format attribute Format is the tmux format to evaluate, such as #{pane_current_command}.
• Name attribute Name identifies the subscription in each change and to Unsubscribe. It may not contain a colon or a space.
• Pane attribute Pane scopes evaluation to one pane.
• Session attribute Session scopes evaluation to the stream's attached session. tmux always evaluates a session-scoped subscription against the control client's own session, so this only requests that scope; it is not a selector, and any value is equivalent to the stream's own session.
• Window attribute Window scopes evaluation to one window.