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.
Source and package
- Qualified name
-
tmux.Display Message Request - Package
- tmux
- Distribution
- github.com/libtmux/libtmux-go/tmux
- Source
- tmux/display_message.go
Fields9#
| Name | Type | Description |
|---|---|---|
| AllFormats | bool | AllFormats includes every available format value. |
| Delay | *time | 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 | *string | Format selects tmux output formatting. |
| Message | string | Message is the optional status message; an empty message leaves tmux's default behavior. |
| NoExpand | bool | NoExpand disables format expansion and requires tmux 3.4; see UnsupportedPolicy. |
| Notify | bool | Notify makes the status message ignore key presses, closing only once Delay elapses. |
bool | Print returns message output instead of only displaying it. | |
| TargetClient | Client | TargetClient selects the stable client receiving the display; zero omits -c. |
| Verbose | bool | Verbose requests verbose tmux output. |