tmux.Pane.DisplayPopup
Go
- Python
- Ruby Unavailable
- Lua Unavailable
- TypeScript
- Rust Unavailable
- Go
- Java Unavailable
- .NET
- C++ Unavailable
- Swift Unavailable
- Module
- tmux
- Declared in
- Pane
- Package
- github.com/libtmux/libtmux-go/tmux
- Source
- tmux/pane_popup.go
- Other languages
- Python Ruby Lua TypeScript Rust Java .NET C++ Swift
- DisplayPopup ( ctx : context.Context , request : DisplayPopupRequest ) error
-
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. On tmux 3.8 and later, an explicit TargetClient that resolves to a control-mode client returnsErrInvalidServerCommandRequestunless CloseExisting is set: tmux itself answers that combination exactly as it answers success, so nothing on the wire would otherwise say the popup never ran. CloseExisting is exempt because tmux handles it before that refusal on every version, clearing whatever overlay the target has - nothing, for a control-mode client - without creating anything either way.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.In other ports Open a popup over the client showing a pane
- Python
libtmux.Pane.display_popup - Ruby No source-verified Ruby equivalent is recorded for this operation.
- Lua No source-verified Lua equivalent is recorded for this operation.
- TypeScript
pane.Pane.displayPopup - Rust no equivalent on
Pane - Java no equivalent on
Pane - .NET
LibTmux.Pane.DisplayPopupAsync - C++ no equivalent on
Pane - Swift no equivalent on
Pane
- Python
0 declared, 0 inherited