libtmux Reference MCP Search
On this page

tmux.Pane.DisplayPopup

View as Markdown

Module
tmux
Declared in
Pane
Package
github.com/libtmux/libtmux-go/tmux
Source
tmux/pane_popup.go
DisplayPopup ( ctx : context.Context , request : DisplayPopupRequest ) error
method [source]
method [source]
DisplayPopup

DisplayPopup displays an overlay on the selected client and waits until it closes after command exit or user dismissal. A zero request starts tmux's default command or default shell and may wait indefinitely. The API exposes no popup process handle, stdout, or child exit status.

The command carries the receiver's exact linked session-window-pane target, which supplies format and working-directory context. TargetClient selects the overlay client; it does not turn the operation into pane delivery. tmux interprets Command as a shell command; outer-parser escaping does not quote or neutralize that inner command.

Title, BorderLines, Style, BorderStyle, Environment, and NoBorder require tmux 3.3. CloseOnAnyKey and NoKeys require tmux 3.6. Unsupported fields follow UnsupportedPolicy .

Invalid fields fail before display. Only stderr produces a redacted CommandError ; nonzero exits without stderr are ignored. Cancellation cannot dismiss an accepted popup, which may remain visible.

0 declared, 0 inherited

Esc

Type to search.