tmux.DisplayMessageRequest

struct tmux.DisplayMessageRequest

struct [source] ¶

struct [source] ¶

struct tmux.DisplayMessageRequest

DisplayMessageRequest configures display-message options shared by server, window, and pane scope. A zero request displays tmux's default message and returns nil. Print returns an owned stdout slice instead of displaying only to a client status line. Nil pointer fields omit their flags while pointers to empty values are explicit; a zero TargetClient omits its flag.

Members

• AllFormats attribute AllFormats includes every available format value.
• Delay attribute Delay sets the display duration. Nil uses tmux's display-time option; an explicit zero waits for a key press unless Notify is set. Values must be whole milliseconds from zero through 4294967295 milliseconds. Invalid values return ErrInvalidServerCommandRequest before tmux I/O.
• Format attribute Format selects tmux output formatting.
• Message attribute Message is the optional status message; an empty message leaves tmux's default behavior.
• NoExpand attribute NoExpand disables format expansion and requires tmux 3.4; see UnsupportedPolicy.
• Notify attribute Notify makes the status message ignore key presses, closing only once Delay elapses.
• Print attribute Print returns message output instead of only displaying it.
• TargetClient attribute TargetClient selects the stable client receiving the display; zero omits -c.
• Verbose attribute Verbose requests verbose tmux output.