libtmux
Python

Choose a port 22

Scripting & web

Python
RubyNo matching page
LuaNo matching page
JuliaNo matching page
TypeScript
PerlNo matching page

Compiled & native

Rust Go C++
Common LispNo matching page
SwiftNo matching page
OCamlNo matching page
HaskellNo matching page

JVM

JavaNo matching page
KotlinNo matching page
ScalaNo matching page
ClojureNo matching page

.NET

C#
F#No matching page
PowerShellNo matching page

BEAM

ErlangNo matching page
ElixirNo matching page

tmux

tmux CLI

GitHub PyPI
Packages

Packages and source 10

Source

libtmuxtmux-python/libtmux pytest pluginplugin · src/libtmux/pytest_plugin.py libtmux.testmodule · src/libtmux/test libtmux-mcplibtmux-mcp/src/libtmux_mcp libtmux-mcptmux-python/libtmux-mcp tmuxptmuxp/src/tmuxp tmuxptmux-python/tmuxp

Packages

libtmuxPyPI libtmux-mcpPyPI tmuxpPyPI

Python · tmux-python/libtmux
Search
Colour scheme
Menu
Reference MCP
GitHub PyPI
Packages

Packages and source 10

Source

libtmuxtmux-python/libtmux pytest pluginplugin · src/libtmux/pytest_plugin.py libtmux.testmodule · src/libtmux/test libtmux-mcplibtmux-mcp/src/libtmux_mcp libtmux-mcptmux-python/libtmux-mcp tmuxptmuxp/src/tmuxp tmuxptmux-python/tmuxp

Packages

libtmuxPyPI libtmux-mcpPyPI tmuxpPyPI

Python · tmux-python/libtmux
Core Library0.xAPI Reference

Choose documentation 3

Python · latest · en
latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux latest

Pane.display_message

Display message to pane.

Source and package
Qualified name
libtmux.Pane.display_message
Module
libtmux
Declared in
Pane
Package
libtmux
Source
src/libtmux/pane.py
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScriptRustGo Java C#C++ Swift Kotlin Scala OCaml F# Clojure
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
method [source]

Description#

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.

Notes

Stderr from tmux is reported via warnings.warn, not raised. Callers that want to escalate to an exception can wrap the call in warnings.catch_warnings with filterwarnings("error").

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.

tmux command#

The tmux commands behind display_message.

display-message

tmux C API#

The C declarations in tmux that implement these commands.

cmd_display_message_entry cmd_display_message_exec

In other ports#

Show a message on the client viewing a pane

Equivalents of Show a message on the client viewing a pane in other languages
Language Equivalent
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.displayMessage
Rust pane.Pane.display
Go tmux.Pane.DisplayMessage
Java no equivalent on Pane
C# LibTmux.Pane.DisplayMessageAsync
C++ libtmux::Pane::show_message
Swift no equivalent on Pane
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#.

Related types#

Pane

tmux(1) Pane [pane_manual].

Esc

Type to search.

 Reference previewOpen reference