Pane.display_popup
Display a popup overlay via $ tmux display-popup.
Source and package
- Qualified name
-
libtmux.Pane. display _popup - Module
- libtmux
- Declared in
Pane- Package
- libtmux
- Source
- src/libtmux/pane.py
- Other languages
- Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript Rust Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure
-
Description#
Requires tmux 3.2+ and an attached client. Use
ControlModein tests to provide a client.Examples#
Not directly testable — popup rendering requires a TTY-backed client. Control-mode provides an attached client for invocation but the popup itself is not visible or verifiable.
>>> with control_mode() as ctl:... pane.display_popup(command='true', close_on_exit=True)- Parameters
-
-
close_on_exit(bool | None) # – Close popup when command exits (-Eflag). -
close_on_success(bool | None) # – Close popup only on success exit code (-EEflag, passing-Etwice). -
close_existing(bool | None) # – Close any existing popup on the client (-Cflag). -
target_client(str | None) # – Display the popup on this specific client (-cflag). When omitted, tmux selects the client attached to this pane's session. With multiple clients attached, pass target_client to direct the popup at one of them. -
start_directory(StrPath | None) # – Working directory (-dflag). -
title(str | None) # – Popup title (-Tflag). Requires tmux 3.3+. -
border_lines(str | None) # – Border line style (-bflag). Requires tmux 3.3+. -
style(str | None) # – Popup style (-sflag). Requires tmux 3.3+. -
border_style(str | None) # – Border style (-Sflag). Requires tmux 3.3+. -
environment(dict[str, str] | None) # – Environment variables (-eflag). Requires tmux 3.3+. -
no_border(bool | None) # – Open the popup without a border (-Bflag). If border_lines is also set, tmux ignores it. Requires tmux 3.3+. -
close_on_any_key(bool | None) # – Dismiss the popup on any key press once the inner command has exited (-kflag). Requires tmux 3.6+. -
no_keys(bool | None) # – Do not auto-close the popup on any close-trigger keys (-Nflag). Requires tmux 3.6+.
tmux command#
The tmux commands behind display_popup.
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 |
|---|---|
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | pane |
| Rust | no equivalent on Pane |
| Go | tmux |
| 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#.