Display a message — display

Display a message.

Usage

display_message(target = NULL, message = NULL, verbose = FALSE, stdout = TRUE)

Arguments

target: A session, window, or pane.
message: A string. The message to display. Refer to the FORMATS section of the tmux man page for the format.
verbose: A logical. Print verbose logging as the format is parsed? Default: FALSE.
stdout: A logical. If TRUE, the message is printed to standard output. If FALSE, the message is sent to target. Default: TRUE.

Value

A string if stdout is TRUE, otherwise NULL.

Note

The verbose argument is not supported for tmux version < 2.9 and will be ignored. If verbose is TRUE a warning will be given.

Examples

if (FALSE) {
s <- new_session("jazz", height = 12)
display_message(s, "#{window_active}")
display_message(s, "session '#{session_name}' has height #{window_height}.")
kill_session(s)
}