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

Window.show_message

Show a message to the clients watching this window's session.

Source and package
Qualified name
libtmux::Window::show_message
Namespace
libtmux
Declared in
Window
Package
libtmux-cxx
Source
include/libtmux/entities.hpp
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript RustGo Java C# Swift Kotlin Scala OCaml F# Clojure
[[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#

The window is the context the text expands in, not just who sees it: #{window_name} in a message sent from here names this window even while another is the active one.

Parameters

tmux command#

The tmux commands behind show_message.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Show a message on the client viewing a window

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

Esc

Type to search.

Reference previewOpen reference