Core LibraryalphaAPI Reference

Choose documentation 3

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-cxx latest

Session.show_message

Put a message on the status line of every client attached here, and send it to a control client as message.

Source and package
Qualified name
libtmux::Session::show_message
Namespace
libtmux
Declared in
Session
Package
libtmux-cxx
Source
include/libtmux/entities.hpp
[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<void, CommandFailure> show_message(std::string_view text) const;

Description#

tmux expands the text as a format, so a #{...} in it is substituted rather than shown. Text built from data belongs in escape_literal() first.

Parameters

tmux command#

The tmux commands behind show_message.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference