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.

struct libtmux-go latest

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 Window and Pane scopes the evaluation; neither evaluates against the stream's attached session, which tmux always uses for a session-scoped subscription and which cannot be selected.

Source and package
Qualified name
tmux.SubscriptionRequest
Package
tmux
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/notification_stream.go
struct tmux.SubscriptionRequest

Description#

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.

Fields4#

SubscriptionRequest fields
NameTypeDescription
Format string Format is the tmux format to evaluate, such as #{pane_current_command}.
Name string Name identifies the subscription in each change and to Unsubscribe. It may not contain a colon or a space.
Pane PaneID Pane scopes evaluation to one pane.
Window WindowID Window scopes evaluation to one window.
Esc

Type to search.

Reference previewOpen reference