On this page

libtmux.Window.display_message

Module: libtmux
Declared in: Window
Package: libtmux
Source: src/libtmux/window.py

display_message ( 10 parameters ) ( self , cmd : str , get_text : t.Literal[True] , format_string : str | None = ... , all_formats : bool | None = ... , verbose : bool | None = ... , no_expand : bool | None = ... , target_client : str | None = ... , delay : int | None = ... , notify : bool | None = ... ) → list[str] ( 10 parameters ) ( self , cmd : str , get_text : t.Literal[False] = ... , format_string : str | None = ... , all_formats : bool | None = ... , verbose : bool | None = ... , no_expand : bool | None = ... , target_client : str | None = ... , delay : int | None = ... , notify : bool | None = ... ) → None ( 10 parameters ) ( self , cmd : str , get_text : bool = False , format_string : str | None = None , all_formats : bool | None = None , verbose : bool | None = None , no_expand : bool | None = None , target_client : str | None = None , delay : int | None = None , notify : bool | None = None ) → list[str] | None method3 overloads [source] ¶ method3 overloads [source] ¶ display_message

Display message at window scope via $ tmux display-message.

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 to Window.cmd .

Examples

Read the window's id format:

>>> result = window.display_message("#{window_id}", get_text=True)
>>> result[0].startswith("@")
True

Check 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 (-p flag). added 0.57
format_string ( str | None ) – Alternative format template (-F flag). added 0.57
all_formats ( bool | None ) – List all format variables (-a flag). added 0.57
verbose ( bool | None ) – Show format variable types (-v flag). added 0.57
no_expand ( bool | None ) – Output the literal string without format expansion (-l flag). Requires tmux 3.4+. added 0.57
target_client ( str | None ) – Target client (-c flag). added 0.57
delay ( int | None ) – Display time in milliseconds (-d flag). added 0.57
notify ( bool | None ) – Do not wait for input (-N flag). added 0.57

Returns

list[str] | None Message output if get_text is True, otherwise None.

0 declared, 0 inherited