On this page

libtmux.Pane.display_message

Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/pane.py

display_message ( 11 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 = ... , update_pane : bool | None = ... ) → list[str] ( 11 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 = ... , update_pane : bool | None = ... ) → None ( 11 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 , update_pane : bool | None = None ) → list[str] | None method3 overloads [source] ¶ method3 overloads [source] ¶ display_message

Display message to pane.

Displays a message in target-client status line. The get_text=False path renders in the status line and is not programmatically verifiable; only get_text=True returns output.

Parameters

cmd ( str ) – Special parameters to request from pane.
get_text ( bool ) – Returns only text without displaying a message in target-client status line.
format_string ( str | None ) – Format string for output (-F flag). added 0.56
all_formats ( bool | None ) – List all format variables (-a flag). added 0.56
verbose ( bool | None ) – Show format variable types (-v flag). added 0.56
no_expand ( bool | None ) – Suppress format expansion; output is returned as a literal string (-l flag). Requires tmux 3.4+. added 0.56
target_client ( str | None ) – Target client (-c flag). added 0.56
delay ( int | None ) – Display time in milliseconds (-d flag). added 0.56
notify ( bool | None ) – Do not wait for input (-N flag). added 0.56
update_pane ( bool | None ) – Allow the pane to keep updating while the message is displayed (-C flag). By default tmux freezes the pane while a status message is shown. Requires tmux 3.6+ (introduced upstream by commit 80eb460f). added 0.56

Returns

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

0 declared, 0 inherited