tmux.ServerOptionValues

struct tmux.ServerOptionValues

struct [source] ¶

struct [source] ¶

struct tmux.ServerOptionValues

ServerOptionValues is an immutable materialized view of known server option values; its zero value is empty and it does not refresh. Obtain it with Server.Options . OptionValue.Get reports presence and OptionValue.Origin reports inheritance. Use Server.RawOption for caller-named or undecoded values.

Members

• Backspace method Backspace returns materialized "backspace" as OptionValue with value type OptionValuestring from server option values; it does not query tmux. Available as KEY since tmux 3.2a; set it with Server.SetBackspace .
• BufferLimit method BufferLimit returns materialized "buffer-limit" as OptionValue with value type OptionValueint64 from server option values; it does not query tmux. Available as NUMBER since tmux 3.2a; set it with Server.SetBufferLimit .
• CodepointWidths method CodepointWidths returns materialized "codepoint-widths" as OptionValue with value type OptionValue[SparseArraystring] from server option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Server.SetCodepointWidths . Its present SparseArray value preserves assigned tmux indexes, including gaps.
• CommandAlias method CommandAlias returns materialized "command-alias" as OptionValue with value type OptionValue[SparseArraystring] from server option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Server.SetCommandAlias . Its present SparseArray value preserves assigned tmux indexes, including gaps.
• CommandAliases method CommandAliases parses command-alias while preserving option presence and origin. A nonnil joined error contains ComplexOptionDecodeError values, each usable with errors.Is or errors.As; the returned projection still contains every valid entry and is owned by the caller.
• CopyCommand method CopyCommand returns materialized "copy-command" as OptionValue with value type OptionValuestring from server option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Server.SetCopyCommand .
• DefaultClientCommand method DefaultClientCommand returns materialized "default-client-command" as OptionValue with value type OptionValuestring from server option values; it does not query tmux. Available as COMMAND since tmux 3.6; set it with Server.SetDefaultClientCommand .
• DefaultTerminal method DefaultTerminal returns materialized "default-terminal" as OptionValue with value type OptionValuestring from server option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Server.SetDefaultTerminal .
• Editor method Editor returns materialized "editor" as OptionValue with value type OptionValuestring from server option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Server.SetEditor .
• EscapeTime method EscapeTime returns materialized "escape-time" as OptionValue with value type OptionValueint64 from server option values; it does not query tmux. Available as NUMBER since tmux 3.2a; set it with Server.SetEscapeTime .
• ExitEmpty method ExitEmpty returns materialized "exit-empty" as OptionValue with value type OptionValuebool from server option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Server.SetExitEmpty .
• ExitUnattached method ExitUnattached returns materialized "exit-unattached" as OptionValue with value type OptionValuebool from server option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Server.SetExitUnattached .
• ExtendedKeys method ExtendedKeys returns materialized "extended-keys" as OptionValue with value type OptionValue ExtendedKeys from server option values; it does not query tmux. Available as CHOICE since tmux 3.2a (choices: "off", "on", "always"); set it with Server.SetExtendedKeys .
• ExtendedKeysFormat method ExtendedKeysFormat returns materialized "extended-keys-format" as OptionValue with value type OptionValue ExtendedKeysFormat from server option values; it does not query tmux. Available as CHOICE since tmux 3.5 (choices: "csi-u", "xterm"); set it with Server.SetExtendedKeysFormat .
• FocusEvents method FocusEvents returns materialized "focus-events" as OptionValue with value type OptionValuebool from server option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Server.SetFocusEvents .
• GetClipboard method GetClipboard returns materialized "get-clipboard" as OptionValue with value type OptionValue GetClipboard from server option values; it does not query tmux. Available as CHOICE since tmux 3.7 (choices: "off", "buffer", "request", "both"); set it with Server.SetGetClipboard .
• HistoryFile method HistoryFile returns materialized "history-file" as OptionValue with value type OptionValuestring from server option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Server.SetHistoryFile .
• InputBufferSize method InputBufferSize returns materialized "input-buffer-size" as OptionValue with value type OptionValueint64 from server option values; it does not query tmux. Available as NUMBER since tmux 3.6; set it with Server.SetInputBufferSize .
• MessageLimit method MessageLimit returns materialized "message-limit" as OptionValue with value type OptionValueint64 from server option values; it does not query tmux. Available as NUMBER since tmux 3.2a; set it with Server.SetMessageLimit .
• ParsedTerminalFeatures method ParsedTerminalFeatures parses terminal-features while preserving option presence and origin. A nonnil joined error contains ComplexOptionDecodeError values and the returned owned projection contains every valid entry.
• ParsedTerminalOverrides method ParsedTerminalOverrides parses terminal-overrides while preserving option presence and origin. Terminal-overrides syntax is permissive: no malformed entry error is returned, and the result owns its parsed projection.
• PrefixTimeout method PrefixTimeout returns materialized "prefix-timeout" as OptionValue with value type OptionValueint64 from server option values; it does not query tmux. Available as NUMBER since tmux 3.5; set it with Server.SetPrefixTimeout .
• PromptHistoryLimit method PromptHistoryLimit returns materialized "prompt-history-limit" as OptionValue with value type OptionValueint64 from server option values; it does not query tmux. Available as NUMBER since tmux 3.3; set it with Server.SetPromptHistoryLimit .
• SetClipboard method SetClipboard returns materialized "set-clipboard" as OptionValue with value type OptionValue SetClipboard from server option values; it does not query tmux. Available as CHOICE since tmux 3.2a (choices: "off", "external", "on"); set it with Server.SetClipboard .
• TerminalFeatures method TerminalFeatures returns materialized "terminal-features" as OptionValue with value type OptionValue[SparseArraystring] from server option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Server.SetTerminalFeatures . Its present SparseArray value preserves assigned tmux indexes, including gaps.
• TerminalOverrides method TerminalOverrides returns materialized "terminal-overrides" as OptionValue with value type OptionValue[SparseArraystring] from server option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Server.SetTerminalOverrides . Its present SparseArray value preserves assigned tmux indexes, including gaps.
• UserKeys method UserKeys returns materialized "user-keys" as OptionValue with value type OptionValue[SparseArraystring] from server option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Server.SetUserKeys . Its present SparseArray value preserves assigned tmux indexes, including gaps.
• VariationSelectorAlwaysWide method VariationSelectorAlwaysWide returns materialized "variation-selector-always-wide" as OptionValue with value type OptionValuebool from server option values; it does not query tmux. Available as FLAG since tmux 3.6; set it with Server.SetVariationSelectorAlwaysWide .