Go API

struct libtmux-go latest

SessionOptionValues

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

Source and package

Qualified name: tmux.SessionOptionValues
Package: tmux
Distribution: github.com/libtmux/libtmux-go/tmux
Source: tmux/option_generated.go

struct tmux.SessionOptionValues struct [source] ¶

Members54#

ActivityAction method ActivityAction returns materialized "activity-action" as OptionValue with value type OptionValueActivityAction from session option values; it does not query tmux. Available as CHOICE (choices: "none", "any", "current", "other"); set it with Session.SetActivityAction or GlobalSessionScope.SetActivityAction.
AssumePasteTime method AssumePasteTime returns materialized "assume-paste-time" as OptionValue with value type OptionValuetime.Duration from session option values; it does not query tmux. Available as NUMBER; set it with Session.SetAssumePasteTime or GlobalSessionScope.SetAssumePasteTime.
BaseIndex method BaseIndex returns materialized "base-index" as OptionValue with value type OptionValueint64 from session option values; it does not query tmux. Available as NUMBER; set it with Session.SetBaseIndex or GlobalSessionScope.SetBaseIndex.
BellAction method BellAction returns materialized "bell-action" as OptionValue with value type OptionValueBellAction from session option values; it does not query tmux. Available as CHOICE (choices: "none", "any", "current", "other"); set it with Session.SetBellAction or GlobalSessionScope.SetBellAction.
DefaultCommand method DefaultCommand returns materialized "default-command" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetDefaultCommand or GlobalSessionScope.SetDefaultCommand.
DefaultShell method DefaultShell returns materialized "default-shell" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetDefaultShell or GlobalSessionScope.SetDefaultShell.
DefaultSize method DefaultSize returns materialized "default-size" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetDefaultSize or GlobalSessionScope.SetDefaultSize.
DestroyUnattached method DestroyUnattached returns materialized "destroy-unattached" as OptionValue with value type OptionValueDestroyUnattached from session option values; it does not query tmux. Available as FLAG; CHOICE since tmux 3.4 (choices: "off", "on", "keep-last", "keep-group"); set it with Session.SetDestroyUnattached or GlobalSessionScope.SetDestroyUnattached.
DetachOnDestroy method DetachOnDestroy returns materialized "detach-on-destroy" as OptionValue with value type OptionValueDetachOnDestroy from session option values; it does not query tmux. Available as CHOICE (choices: "off", "on", "no-detached"); CHOICE since tmux 3.4 (choices: "off", "on", "no-detached", "previous", "next"); set it with Session.SetDetachOnDestroy or GlobalSessionScope.SetDetachOnDestroy.
DisplayPanesActiveColour method DisplayPanesActiveColour returns materialized "display-panes-active-colour" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as COLOUR; set it with Session.SetDisplayPanesActiveColour or GlobalSessionScope.SetDisplayPanesActiveColour.
DisplayPanesColour method DisplayPanesColour returns materialized "display-panes-colour" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as COLOUR; set it with Session.SetDisplayPanesColour or GlobalSessionScope.SetDisplayPanesColour.
DisplayPanesTime method DisplayPanesTime returns materialized "display-panes-time" as OptionValue with value type OptionValuetime.Duration from session option values; it does not query tmux. Available as NUMBER; set it with Session.SetDisplayPanesTime or GlobalSessionScope.SetDisplayPanesTime.
DisplayTime method DisplayTime returns materialized "display-time" as OptionValue with value type OptionValuetime.Duration from session option values; it does not query tmux. Available as NUMBER; set it with Session.SetDisplayTime or GlobalSessionScope.SetDisplayTime.
FocusFollowsMouse method FocusFollowsMouse returns materialized "focus-follows-mouse" as OptionValue with value type OptionValuebool from session option values; it does not query tmux. Available as FLAG since tmux 3.7; set it with Session.SetFocusFollowsMouse or GlobalSessionScope.SetFocusFollowsMouse.
HistoryLimit method HistoryLimit returns materialized "history-limit" as OptionValue with value type OptionValueint64 from session option values; it does not query tmux. Available as NUMBER; set it with Session.SetHistoryLimit or GlobalSessionScope.SetHistoryLimit.
InitialRepeatTime method InitialRepeatTime returns materialized "initial-repeat-time" as OptionValue with value type OptionValuetime.Duration from session option values; it does not query tmux. Available as NUMBER since tmux 3.6; set it with Session.SetInitialRepeatTime or GlobalSessionScope.SetInitialRepeatTime.
KeyTable method KeyTable returns materialized "key-table" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetKeyTable or GlobalSessionScope.SetKeyTable.
LockAfterTime method LockAfterTime returns materialized "lock-after-time" as OptionValue with value type OptionValuetime.Duration from session option values; it does not query tmux. Available as NUMBER; set it with Session.SetLockAfterTime or GlobalSessionScope.SetLockAfterTime.
LockCommand method LockCommand returns materialized "lock-command" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetLockCommand or GlobalSessionScope.SetLockCommand.
MessageCommandStyle method MessageCommandStyle returns materialized "message-command-style" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetMessageCommandStyle or GlobalSessionScope.SetMessageCommandStyle. It is a style option.
MessageFormat method MessageFormat returns materialized "message-format" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING since tmux 3.7; set it with Session.SetMessageFormat or GlobalSessionScope.SetMessageFormat.
MessageLine method MessageLine returns materialized "message-line" as OptionValue with value type OptionValueMessageLine from session option values; it does not query tmux. Available as CHOICE since tmux 3.4 (choices: "0", "1", "2", "3", "4"); set it with Session.SetMessageLine or GlobalSessionScope.SetMessageLine.
MessageStyle method MessageStyle returns materialized "message-style" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetMessageStyle or GlobalSessionScope.SetMessageStyle. It is a style option.
Mouse method Mouse returns materialized "mouse" as OptionValue with value type OptionValuebool from session option values; it does not query tmux. Available as FLAG; set it with Session.SetMouse or GlobalSessionScope.SetMouse.
Prefix method Prefix returns materialized "prefix" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as KEY; set it with Session.SetPrefix or GlobalSessionScope.SetPrefix.
Prefix2 method Prefix2 returns materialized "prefix2" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as KEY; set it with Session.SetPrefix2 or GlobalSessionScope.SetPrefix2.
PromptCommandCursorStyle method PromptCommandCursorStyle returns materialized "prompt-command-cursor-style" as OptionValue with value type OptionValuePromptCommandCursorStyle from session option values; it does not query tmux. Available as CHOICE since tmux 3.7 (choices: "default", "blinking-block", "block", "blinking-underline", "underline", "blinking-bar", "bar"); set it with Session.SetPromptCommandCursorStyle or GlobalSessionScope.SetPromptCommandCursorStyle.
PromptCursorColour method PromptCursorColour returns materialized "prompt-cursor-colour" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as COLOUR since tmux 3.6; set it with Session.SetPromptCursorColour or GlobalSessionScope.SetPromptCursorColour.
PromptCursorStyle method PromptCursorStyle returns materialized "prompt-cursor-style" as OptionValue with value type OptionValuePromptCursorStyle from session option values; it does not query tmux. Available as CHOICE since tmux 3.6 (choices: "default", "blinking-block", "block", "blinking-underline", "underline", "blinking-bar", "bar"); set it with Session.SetPromptCursorStyle or GlobalSessionScope.SetPromptCursorStyle.
RenumberWindows method RenumberWindows returns materialized "renumber-windows" as OptionValue with value type OptionValuebool from session option values; it does not query tmux. Available as FLAG; set it with Session.SetRenumberWindows or GlobalSessionScope.SetRenumberWindows.
RepeatTime method RepeatTime returns materialized "repeat-time" as OptionValue with value type OptionValuetime.Duration from session option values; it does not query tmux. Available as NUMBER; set it with Session.SetRepeatTime or GlobalSessionScope.SetRepeatTime.
SetTitles method SetTitles returns materialized "set-titles" as OptionValue with value type OptionValuebool from session option values; it does not query tmux. Available as FLAG; set it with Session.SetTitles or GlobalSessionScope.SetTitles.
SetTitlesString method SetTitlesString returns materialized "set-titles-string" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetTitlesString or GlobalSessionScope.SetTitlesString.
SilenceAction method SilenceAction returns materialized "silence-action" as OptionValue with value type OptionValueSilenceAction from session option values; it does not query tmux. Available as CHOICE (choices: "none", "any", "current", "other"); set it with Session.SetSilenceAction or GlobalSessionScope.SetSilenceAction.
Status method Status returns materialized "status" as OptionValue with value type OptionValueStatus from session option values; it does not query tmux. Available as CHOICE (choices: "off", "on", "2", "3", "4", "5"); set it with Session.SetStatus or GlobalSessionScope.SetStatus.
StatusBG method StatusBG returns materialized "status-bg" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as COLOUR; set it with Session.SetStatusBG or GlobalSessionScope.SetStatusBG.
StatusFG method StatusFG returns materialized "status-fg" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as COLOUR; set it with Session.SetStatusFG or GlobalSessionScope.SetStatusFG.
StatusFormat method StatusFormat returns materialized "status-format" as OptionValue with value type OptionValue[SparseArraystring] from session option values; it does not query tmux. Available as STRING; set it with Session.SetStatusFormat or GlobalSessionScope.SetStatusFormat. Its present SparseArray value preserves assigned tmux indexes, including gaps.
StatusInterval method StatusInterval returns materialized "status-interval" as OptionValue with value type OptionValuetime.Duration from session option values; it does not query tmux. Available as NUMBER; set it with Session.SetStatusInterval or GlobalSessionScope.SetStatusInterval.
StatusJustify method StatusJustify returns materialized "status-justify" as OptionValue with value type OptionValueStatusJustify from session option values; it does not query tmux. Available as CHOICE (choices: "left", "centre", "right", "absolute-centre"); set it with Session.SetStatusJustify or GlobalSessionScope.SetStatusJustify.
StatusKeys method StatusKeys returns materialized "status-keys" as OptionValue with value type OptionValueStatusKeys from session option values; it does not query tmux. Available as CHOICE (choices: "emacs", "vi"); set it with Session.SetStatusKeys or GlobalSessionScope.SetStatusKeys.
StatusLeft method StatusLeft returns materialized "status-left" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetStatusLeft or GlobalSessionScope.SetStatusLeft.
StatusLeftLength method StatusLeftLength returns materialized "status-left-length" as OptionValue with value type OptionValueint64 from session option values; it does not query tmux. Available as NUMBER; set it with Session.SetStatusLeftLength or GlobalSessionScope.SetStatusLeftLength.
StatusLeftStyle method StatusLeftStyle returns materialized "status-left-style" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetStatusLeftStyle or GlobalSessionScope.SetStatusLeftStyle. It is a style option.
StatusPosition method StatusPosition returns materialized "status-position" as OptionValue with value type OptionValueStatusPosition from session option values; it does not query tmux. Available as CHOICE (choices: "top", "bottom"); set it with Session.SetStatusPosition or GlobalSessionScope.SetStatusPosition.
StatusRight method StatusRight returns materialized "status-right" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetStatusRight or GlobalSessionScope.SetStatusRight.
StatusRightLength method StatusRightLength returns materialized "status-right-length" as OptionValue with value type OptionValueint64 from session option values; it does not query tmux. Available as NUMBER; set it with Session.SetStatusRightLength or GlobalSessionScope.SetStatusRightLength.
StatusRightStyle method StatusRightStyle returns materialized "status-right-style" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetStatusRightStyle or GlobalSessionScope.SetStatusRightStyle. It is a style option.
StatusStyle method StatusStyle returns materialized "status-style" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetStatusStyle or GlobalSessionScope.SetStatusStyle. It is a style option.
UpdateEnvironment method UpdateEnvironment returns materialized "update-environment" as OptionValue with value type OptionValue[SparseArraystring] from session option values; it does not query tmux. Available as STRING; set it with Session.SetUpdateEnvironment or GlobalSessionScope.SetUpdateEnvironment. Its present SparseArray value preserves assigned tmux indexes, including gaps.
VisualActivity method VisualActivity returns materialized "visual-activity" as OptionValue with value type OptionValueVisualActivity from session option values; it does not query tmux. Available as CHOICE (choices: "off", "on", "both"); set it with Session.SetVisualActivity or GlobalSessionScope.SetVisualActivity.
VisualBell method VisualBell returns materialized "visual-bell" as OptionValue with value type OptionValueVisualBell from session option values; it does not query tmux. Available as CHOICE (choices: "off", "on", "both"); set it with Session.SetVisualBell or GlobalSessionScope.SetVisualBell.
VisualSilence method VisualSilence returns materialized "visual-silence" as OptionValue with value type OptionValueVisualSilence from session option values; it does not query tmux. Available as CHOICE (choices: "off", "on", "both"); set it with Session.SetVisualSilence or GlobalSessionScope.SetVisualSilence.
WordSeparators method WordSeparators returns materialized "word-separators" as OptionValue with value type OptionValuestring from session option values; it does not query tmux. Available as STRING; set it with Session.SetWordSeparators or GlobalSessionScope.SetWordSeparators.

tmux options#

Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.

Options

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

SessionOptionValues

Members54#

tmux options#

Members54#

tmux options#

Related types#