Pane.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.
Source and package
- Qualified name
-
tmux.Pane. Display Popup - Package
- tmux
- Declared in
Pane- Distribution
- github.com/libtmux/libtmux-go/tmux
- Source
- tmux/pane_popup.go
- Other languages
- Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Rust Java C# C++ Swift Kotlin Scala OCaml F# Clojure
- func (p Pane) DisplayPopup( ctx context
.Context , request DisplayPopup , ) errorRequest -
Description#
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.
CloseOnAnyKey and NoKeys require tmux 3.6. Unsupported fields follow
UnsupportedPolicy. NoKeys is omitted from tmux 3.9, whose popups are floating panes with no earlier popup to modify. 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.- Parameters
tmux command#
The tmux commands behind DisplayPopup.
tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Open a popup over the client showing a pane
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | pane |
| Rust | no equivalent on Pane |
| Java | no equivalent on Pane |
| C# | Lib |
| C++ | no equivalent on Pane |
| Swift | no equivalent on Pane |
| OCaml | No direct public OCaml equivalent is recorded for this operation. |
| Perl | No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands. |
No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.