tmux.SendKeysRequest

struct tmux.SendKeysRequest

struct [source] ¶

struct [source] ¶

struct tmux.SendKeysRequest

SendKeysRequest configures tmux key input. Pointer values are copied before I/O and must not be mutated concurrently.

Command must be nonnil unless Reset, Repeat, or CopyModeCommand is set. A nonnil empty Command is an explicit key operand and is followed by Enter unless SkipEnter is set. CopyModeCommand takes precedence over Command and suppresses Enter. HexKeys takes precedence over Literal when both are set.

Members

• Command attribute Command is one tmux key operand. Nil selects a flag-only invocation; nonnil, including an empty string, supplies the operand.
• CopyModeCommand attribute CopyModeCommand sends a tmux copy-mode command instead of Command. A nonnil empty string remains an explicit operand.
• ExpandFormats attribute ExpandFormats asks tmux to expand format expressions in key operands.
• HexKeys attribute HexKeys interprets key operands as hexadecimal ASCII values and takes precedence over Literal.
• KeyName attribute KeyName routes keys through the selected client's key table rather than delivering them to the pane.
• Literal attribute Literal disables tmux key-name lookup and treats Command as literal UTF-8. It does not bypass interpretation by the pane's application or shell.
• Repeat attribute Repeat repeats the key input a positive number of times. Zero omits the repeat count.
• Reset attribute Reset asks tmux to reset terminal state before processing key input.
• SkipEnter attribute SkipEnter prevents the separate Enter key sent after Command.
• SuppressHistory attribute SuppressHistory prefixes Command with one space. Whether that excludes the text from history depends on the application or shell in the pane.
• TargetClient attribute TargetClient selects the client used by KeyName. Zero leaves client selection to tmux; without KeyName it does not redirect pane input.