Window.display_message
Display message at window scope via $ tmux display-message.
Source and package
-
Description#
Like
Pane.display_message()but auto-injects-t @<window-id>instead of a pane id. Window-scoped format reads such as#{window_zoomed_flag}or#{window_active_clients}no longer require dropping toWindow.cmd().Notes
Stderr from tmux is reported via
warnings.warn, not raised. Callers that want to escalate to an exception can wrap the call inwarnings.catch_warningswithfilterwarnings("error").Examples#
Read the window's id format:
>>> result = window.display_message("#{window_id}", get_text=True)>>> result[0].startswith("@")TrueCheck zoom state (a common gap-#670 use case):
>>> result = window.display_message(... "#{window_zoomed_flag}", get_text=True... )>>> result[0] in {"0", "1"}True- Parameters
-
-
cmd(str) # – Format string to display or evaluate (e.g."#{window_zoomed_flag}"). added 0.57 -
get_text(bool) # – Return tmux's stdout instead of rendering to the status line (-pflag). added 0.57 -
format_string(str | None) # – Alternative format template (-Fflag). added 0.57 -
all_formats(bool | None) # – List all format variables (-aflag). added 0.57 -
verbose(bool | None) # – Show format variable types (-vflag). added 0.57 -
no_expand(bool | None) # – Output the literal string without format expansion (-lflag). Requires tmux 3.4+. added 0.57 -
target_client(str | None) # – Target client (-cflag). added 0.57 -
delay(int | None) # – Display time in milliseconds (-dflag). added 0.57 -
notify(bool | None) # – Do not wait for input (-Nflag). added 0.57
-
- Returns
-
list[str] | None Message output if
get_textis True, otherwiseNone.
tmux command#
The tmux commands behind display_message.
tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Show a message on the client viewing a window
| Language | Equivalent |
|---|---|
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | no equivalent on Window |
| Rust | window |
| Go | tmux |
| Java | no equivalent on Window |
| C# | Lib |
| C++ | libtmux:: |
| Swift | no equivalent on Window |
| 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#.