Server.display_message
Display message at server scope via $ tmux display-message.
Source and package
-
Description#
Like
Pane.display_messagebut without-t <pane-id>injection. tmux'scmd-display-messageentry usesCMD_FIND_CANFAILso the target is optional; server-scoped format reads (#{version},#{socket_path},#{pid}) resolve without a specific pane handle.With no client attached and
target_clientomitted, the status-line path (get_text=False) issues ano current clientwarning. Useget_text=Truefor headless reads, or pair withControlMode.Notes
Stderr from tmux is reported via
warnings.warn, not raised. tmux uses stderr for both genuine errors and informational messages, and the right escalation depends on tmux version and call shape. Callers that want to escalate to an exception can wrap the call inwarnings.catch_warningswithfilterwarnings("error").Examples#
Read tmux version without needing a pane handle:
>>> result = server.display_message("#{version}", get_text=True)>>> isinstance(result, list) and len(result) == 1TrueDump 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 withall_formats=Trueto dump every variable. 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.
In other ports Show a message on a client
- PowerShell No source-verified PowerShell equivalent is recorded for this operation.
- Julia No source-verified Julia equivalent is recorded for this operation.
- Ruby No source-verified Ruby equivalent is recorded for this operation.
- Lua No source-verified Lua equivalent is recorded for this operation.
- TypeScript no equivalent on
Server - Rust no equivalent on
Server - Go
- Java no equivalent on
Server - C#
- C++
- Swift no equivalent on
Server - Kotlin No source-verified Kotlin equivalent is recorded for this operation.
- Scala No source-verified Scala equivalent is recorded for this operation.
- F# No source-verified F# equivalent is recorded for this operation.