Core Library0.xAPI 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.

struct libtmux-go latest

CommandPromptRequest

CommandPromptRequest configures a background tmux command prompt. Its zero value is invalid because Template is required; nil pointer fields omit flags while explicit empty values are passed to tmux.

Source and package
Qualified name
tmux.CommandPromptRequest
Package
tmux
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/server_interactive.go
struct tmux.CommandPromptRequest

Fields13#

CommandPromptRequest fields
NameTypeDescription
BackspaceExit bool BackspaceExit exits on backspace and requires tmux 3.7; see UnsupportedPolicy.
ExpandFormat bool ExpandFormat expands formats in the prompt result.
Inputs *string Inputs supplies initial prompt inputs when nonnil.
KeyOnly bool KeyOnly limits accepted input to keys.
Literal bool Literal disables key-name parsing and requires tmux 3.6; see UnsupportedPolicy.
NoFreeze bool NoFreeze leaves the pane unfrozen and requires tmux 3.7; see UnsupportedPolicy.
Numeric bool Numeric restricts accepted input to a number.
OneKey bool OneKey accepts one key rather than a line.
OnInputChange bool OnInputChange runs Template after each input change.
Prompt *string Prompt replaces tmux's prompt text when nonnil.
TargetClient ClientName TargetClient selects the stable client that displays the prompt.
Template string Template is the required tmux command template submitted by the prompt.
Type PromptType Type selects the associated prompt-history class; zero omits -T.
Esc

Type to search.

Reference previewOpen reference