libtmux
Python

Choose a port 15

Scripting & web

Python
RubyNo matching page
LuaNo matching page
JuliaNo matching page
TypeScript

Compiled & native

Rust Go C++
SwiftNo matching page

JVM

JavaNo matching page
KotlinNo matching page
ScalaNo matching page

.NET

C#
F#No matching page
PowerShellNo matching page

tmux

tmux CLI

GitHub

Source on GitHub 3

Core Library

libtmuxtmux-python/libtmux

MCP

libtmux-mcptmux-python/libtmux-mcp

Workspace Manager

tmuxptmux-python/tmuxp

Python · tmux-python/libtmux
Packages

Packages on PyPI 3

Core Library

libtmuxPyPI

MCP

libtmux-mcpPyPI

Workspace Manager

tmuxpPyPI

Python · PyPI
Search
Colour scheme
Menu
Reference MCP
GitHub

Source on GitHub 3

Core Library

libtmuxtmux-python/libtmux

MCP

libtmux-mcptmux-python/libtmux-mcp

Workspace Manager

tmuxptmux-python/tmuxp

Python · tmux-python/libtmux
Packages

Packages on PyPI 3

Core Library

libtmuxPyPI

MCP

libtmux-mcpPyPI

Workspace Manager

tmuxpPyPI

Python · PyPI
Core LibrarystableAPI Reference

Choose documentation 3

Python · stable · en
stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

method libtmux stable

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
PowerShell Julia Ruby Lua TypeScriptRustGo Java C#C++ Swift Kotlin Scala F#
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.

In other ports Show a message on the client viewing a pane
  • 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
    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
  • 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.

Related types#

Pane

tmux(1) Pane [pane_manual].

Esc

Type to search.

 Reference preview Open reference