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.
Source and package
- Qualified name
-
tmux.Server Option Values - Package
- tmux
- Distribution
- github.com/libtmux/libtmux-go/tmux
- Source
- tmux/option_generated.go
Members28#
- Backspace method Backspace returns materialized "backspace" as
OptionValuewith value type OptionValuestringfrom server option values; it does not query tmux. Available as KEY; set it withServer.SetBackspace. - BufferLimit method BufferLimit returns materialized "buffer-limit" as
OptionValuewith value type OptionValueint64from server option values; it does not query tmux. Available as NUMBER; set it withServer.SetBufferLimit. - CodepointWidths method CodepointWidths returns materialized "codepoint-widths" as
OptionValuewith value type OptionValue[SparseArraystring] from server option values; it does not query tmux. Available as STRING since tmux 3.6; set it withServer.SetCodepointWidths. Its present SparseArray value preserves assigned tmux indexes, including gaps. - CommandAlias method CommandAlias returns materialized "command-alias" as
OptionValuewith value type OptionValue[SparseArraystring] from server option values; it does not query tmux. Available as STRING; set it withServer.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
ComplexOptionDecodeErrorvalues, each usable witherrors.Isorerrors.As; the returned projection still contains every valid entry and is owned by the caller. - CopyCommand method CopyCommand returns materialized "copy-command" as
OptionValuewith value type OptionValuestringfrom server option values; it does not query tmux. Available as STRING; set it withServer.SetCopyCommand. - DefaultClientCommand method DefaultClientCommand returns materialized "default-client-command" as
OptionValuewith value type OptionValuestringfrom server option values; it does not query tmux. Available as COMMAND since tmux 3.6; set it withServer.SetDefaultClientCommand. - DefaultTerminal method DefaultTerminal returns materialized "default-terminal" as
OptionValuewith value type OptionValuestringfrom server option values; it does not query tmux. Available as STRING; set it withServer.SetDefaultTerminal. - Editor method Editor returns materialized "editor" as
OptionValuewith value type OptionValuestringfrom server option values; it does not query tmux. Available as STRING; set it withServer.SetEditor. - EscapeTime method EscapeTime returns materialized "escape-time" as
OptionValuewith value type OptionValuetime.Durationfrom server option values; it does not query tmux. Available as NUMBER; set it withServer.SetEscapeTime. - ExitEmpty method ExitEmpty returns materialized "exit-empty" as
OptionValuewith value type OptionValueboolfrom server option values; it does not query tmux. Available as FLAG; set it withServer.SetExitEmpty. - ExitUnattached method ExitUnattached returns materialized "exit-unattached" as
OptionValuewith value type OptionValueboolfrom server option values; it does not query tmux. Available as FLAG; set it withServer.SetExitUnattached. - ExtendedKeys method ExtendedKeys returns materialized "extended-keys" as
OptionValuewith value type OptionValueExtendedKeysfrom server option values; it does not query tmux. Available as CHOICE (choices: "off", "on", "always"); set it withServer.SetExtendedKeys. - ExtendedKeysFormat method ExtendedKeysFormat returns materialized "extended-keys-format" as
OptionValuewith value type OptionValueExtendedKeysFormatfrom server option values; it does not query tmux. Available as CHOICE since tmux 3.5 (choices: "csi-u", "xterm"); set it withServer.SetExtendedKeysFormat. - FocusEvents method FocusEvents returns materialized "focus-events" as
OptionValuewith value type OptionValueboolfrom server option values; it does not query tmux. Available as FLAG; set it withServer.SetFocusEvents. - GetClipboard method GetClipboard returns materialized "get-clipboard" as
OptionValuewith value type OptionValueGetClipboardfrom server option values; it does not query tmux. Available as CHOICE since tmux 3.7 (choices: "off", "buffer", "request", "both"); set it withServer.SetGetClipboard. - HistoryFile method HistoryFile returns materialized "history-file" as
OptionValuewith value type OptionValuestringfrom server option values; it does not query tmux. Available as STRING; set it withServer.SetHistoryFile. - InputBufferSize method InputBufferSize returns materialized "input-buffer-size" as
OptionValuewith value type OptionValueint64from server option values; it does not query tmux. Available as NUMBER since tmux 3.6; set it withServer.SetInputBufferSize. - MessageLimit method MessageLimit returns materialized "message-limit" as
OptionValuewith value type OptionValueint64from server option values; it does not query tmux. Available as NUMBER; set it withServer.SetMessageLimit. - ParsedTerminalFeatures method ParsedTerminalFeatures parses terminal-features while preserving option presence and origin. A nonnil joined error contains
ComplexOptionDecodeErrorvalues 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
OptionValuewith value type OptionValuetime.Durationfrom server option values; it does not query tmux. Available as NUMBER since tmux 3.5; set it withServer.SetPrefixTimeout. - PromptHistoryLimit method PromptHistoryLimit returns materialized "prompt-history-limit" as
OptionValuewith value type OptionValueint64from server option values; it does not query tmux. Available as NUMBER; set it withServer.SetPromptHistoryLimit. - SetClipboard method SetClipboard returns materialized "set-clipboard" as
OptionValuewith value type OptionValueSetClipboardfrom server option values; it does not query tmux. Available as CHOICE (choices: "off", "external", "on"); set it withServer.SetClipboard. - TerminalFeatures method TerminalFeatures returns materialized "terminal-features" as
OptionValuewith value type OptionValue[SparseArraystring] from server option values; it does not query tmux. Available as STRING; set it withServer.SetTerminalFeatures. Its present SparseArray value preserves assigned tmux indexes, including gaps. - TerminalOverrides method TerminalOverrides returns materialized "terminal-overrides" as
OptionValuewith value type OptionValue[SparseArraystring] from server option values; it does not query tmux. Available as STRING; set it withServer.SetTerminalOverrides. Its present SparseArray value preserves assigned tmux indexes, including gaps. - UserKeys method UserKeys returns materialized "user-keys" as
OptionValuewith value type OptionValue[SparseArraystring] from server option values; it does not query tmux. Available as STRING; set it withServer.SetUserKeys. Its present SparseArray value preserves assigned tmux indexes, including gaps. - VariationSelectorAlwaysWide method VariationSelectorAlwaysWide returns materialized "variation-selector-always-wide" as
OptionValuewith value type OptionValueboolfrom server option values; it does not query tmux. Available as FLAG since tmux 3.6; set it withServer.SetVariationSelectorAlwaysWide.
tmux options#
Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.