On this page

libtmux.Server.display_message

Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.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 server scope via $ tmux display-message.

Like Pane.display_message but without -t <pane-id> injection. tmux's cmd-display-message entry uses CMD_FIND_CANFAIL so the target is optional; server-scoped format reads (#{version}, #{socket_path}, #{pid}) resolve without a specific pane handle.

With no client attached and target_client omitted, the status-line path (get_text=False) issues a no current client warning. Use get_text=True for headless reads, or pair with ControlMode .

Examples

Read tmux version without needing a pane handle:

>>> result = server.display_message("#{version}", get_text=True)
>>> isinstance(result, list) and len(result) == 1
True

Dump every format variable:

>>> result = server.display_message("", get_text=True, all_formats=True)
>>> any("session_name=" in line for line in result)
True

Parameters

cmd ( str ) – Format string to display or evaluate (e.g. "#{version}"). Pass "" together with all_formats=True to dump every variable. 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