Python API

method libtmux stable

Server.show_messages

Show server message log via $ tmux show-messages.

Source and package

Qualified name: libtmux.Server.show_messages
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: PowerShell Julia Ruby Lua TypeScript Rust GoJavaC# C++ Swift Kotlin Scala F#

show_messages ( self, target_client: str | None = None, terminals: bool | None = None, jobs: bool | None = None, ) → list[str] method [source] ¶

Description#

Without -T/-J, tmux resolves the message log against a target client; if no client is attached and target_client is omitted, tmux raises no current client. Provide target_client (e.g. via ControlMode ) when running headless, or use terminals/jobs — those modes don't require a client.

Examples#

>>> with control_mode() as ctl:
...     result = server.show_messages(target_client=ctl.client_name)
>>> isinstance(result, list)
True

Parameters

target_client (str | None) # – Target client (-t flag).
terminals (bool | None) # – List terminal capabilities and flags instead of the message log (-T flag).
jobs (bool | None) # – Print the tmux job server summary instead of the message log (-J flag).

Returns

list[str] Server message log lines (or terminal/job summary when terminals/jobs is set).

tmux command show-messages

In other ports Read the server's message log

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
tmux.Server.ShowMessages
Java
io.github.libtmux.MessageLog.lines
C#
LibTmux.Server.GetMessagesAsync
C++
Server::show_message posts a message rather than reading the log
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.

Scripting & web

Compiled & native

JVM

.NET

tmux

Server.show_messages

Description#

Examples#

Description#

Examples#

Related types#