On this page

libtmux.Server.show_messages

Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py

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

Show server message log via $ tmux show-messages.

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).

0 declared, 0 inherited