WindowOptionValues
WindowOptionValues is an immutable materialized view of known window option values; its zero value is empty and it does not refresh. Obtain it with Window.Options or GlobalWindowScope.Options. OptionValue.Get reports presence and OptionValue.Origin reports inheritance. Use Window.RawOption or GlobalWindowScope.RawOption for caller-named or undecoded values.
Source and package
- Qualified name
-
tmux.Window Option Values - Package
- tmux
- Distribution
- github.com/libtmux/libtmux-go/tmux
- Source
- tmux/option_generated.go
Members74#
- AggressiveResize method AggressiveResize returns materialized "aggressive-resize" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG; set it withWindow.SetAggressiveResizeorGlobalWindowScope.SetAggressiveResize. - AllowPassthrough method AllowPassthrough returns materialized "allow-passthrough" as
OptionValuewith value type OptionValueAllowPassthroughfrom window option values; it does not query tmux. Available as FLAG; CHOICE since tmux 3.4 (choices: "off", "on", "all"); set it withWindow.SetAllowPassthroughorGlobalWindowScope.SetAllowPassthrough. - AllowRename method AllowRename returns materialized "allow-rename" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG; set it withWindow.SetAllowRenameorGlobalWindowScope.SetAllowRename. - AllowSetTitle method AllowSetTitle returns materialized "allow-set-title" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG since tmux 3.5; set it withWindow.SetAllowSetTitleorGlobalWindowScope.SetAllowSetTitle. - AlternateScreen method AlternateScreen returns materialized "alternate-screen" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG; set it withWindow.SetAlternateScreenorGlobalWindowScope.SetAlternateScreen. - AutomaticRename method AutomaticRename returns materialized "automatic-rename" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG; set it withWindow.SetAutomaticRenameorGlobalWindowScope.SetAutomaticRename. - AutomaticRenameFormat method AutomaticRenameFormat returns materialized "automatic-rename-format" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetAutomaticRenameFormatorGlobalWindowScope.SetAutomaticRenameFormat. - ClockModeColour method ClockModeColour returns materialized "clock-mode-colour" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as COLOUR; set it withWindow.SetClockModeColourorGlobalWindowScope.SetClockModeColour. - ClockModeStyle method ClockModeStyle returns materialized "clock-mode-style" as
OptionValuewith value type OptionValueClockModeStylefrom window option values; it does not query tmux. Available as CHOICE (choices: "12", "24"); CHOICE since tmux 3.6 (choices: "12", "24", "12-with-seconds", "24-with-seconds"); set it withWindow.SetClockModeStyleorGlobalWindowScope.SetClockModeStyle. - CopyModeCurrentLineNumberStyle method CopyModeCurrentLineNumberStyle returns materialized "copy-mode-current-line-number-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.7; set it withWindow.SetCopyModeCurrentLineNumberStyleorGlobalWindowScope.SetCopyModeCurrentLineNumberStyle. It is a style option. - CopyModeCurrentMatchStyle method CopyModeCurrentMatchStyle returns materialized "copy-mode-current-match-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetCopyModeCurrentMatchStyleorGlobalWindowScope.SetCopyModeCurrentMatchStyle. It is a style option. - CopyModeLineNumbers method CopyModeLineNumbers returns materialized "copy-mode-line-numbers" as
OptionValuewith value type OptionValueCopyModeLineNumbersfrom window option values; it does not query tmux. Available as CHOICE since tmux 3.7 (choices: "off", "default", "absolute", "relative", "hybrid"); set it withWindow.SetCopyModeLineNumbersorGlobalWindowScope.SetCopyModeLineNumbers. - CopyModeLineNumberStyle method CopyModeLineNumberStyle returns materialized "copy-mode-line-number-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.7; set it withWindow.SetCopyModeLineNumberStyleorGlobalWindowScope.SetCopyModeLineNumberStyle. It is a style option. - CopyModeMarkStyle method CopyModeMarkStyle returns materialized "copy-mode-mark-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetCopyModeMarkStyleorGlobalWindowScope.SetCopyModeMarkStyle. It is a style option. - CopyModeMatchStyle method CopyModeMatchStyle returns materialized "copy-mode-match-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetCopyModeMatchStyleorGlobalWindowScope.SetCopyModeMatchStyle. It is a style option. - CopyModePositionFormat method CopyModePositionFormat returns materialized "copy-mode-position-format" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.6; set it withWindow.SetCopyModePositionFormatorGlobalWindowScope.SetCopyModePositionFormat. - CopyModePositionStyle method CopyModePositionStyle returns materialized "copy-mode-position-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.6; set it withWindow.SetCopyModePositionStyleorGlobalWindowScope.SetCopyModePositionStyle. It is a style option. - CopyModeSelectionStyle method CopyModeSelectionStyle returns materialized "copy-mode-selection-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.6; set it withWindow.SetCopyModeSelectionStyleorGlobalWindowScope.SetCopyModeSelectionStyle. It is a style option. - CursorColour method CursorColour returns materialized "cursor-colour" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as COLOUR; set it withWindow.SetCursorColourorGlobalWindowScope.SetCursorColour. - CursorStyle method CursorStyle returns materialized "cursor-style" as
OptionValuewith value type OptionValueCursorStylefrom window option values; it does not query tmux. Available as CHOICE (choices: "default", "blinking-block", "block", "blinking-underline", "underline", "blinking-bar", "bar"); set it withWindow.SetCursorStyleorGlobalWindowScope.SetCursorStyle. - FillCharacter method FillCharacter returns materialized "fill-character" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetFillCharacterorGlobalWindowScope.SetFillCharacter. - MainPaneHeight method MainPaneHeight returns materialized "main-pane-height" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetMainPaneHeightorGlobalWindowScope.SetMainPaneHeight. - MainPaneWidth method MainPaneWidth returns materialized "main-pane-width" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetMainPaneWidthorGlobalWindowScope.SetMainPaneWidth. - MenuBorderLines method MenuBorderLines returns materialized "menu-border-lines" as
OptionValuewith value type OptionValueMenuBorderLinesfrom window option values; it does not query tmux. Available as CHOICE since tmux 3.4 (choices: "single", "double", "heavy", "simple", "rounded", "padded", "none"); set it withWindow.SetMenuBorderLinesorGlobalWindowScope.SetMenuBorderLines. - MenuBorderStyle method MenuBorderStyle returns materialized "menu-border-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.4; set it withWindow.SetMenuBorderStyleorGlobalWindowScope.SetMenuBorderStyle. It is a style option. - MenuSelectedStyle method MenuSelectedStyle returns materialized "menu-selected-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.4; set it withWindow.SetMenuSelectedStyleorGlobalWindowScope.SetMenuSelectedStyle. It is a style option. - MenuStyle method MenuStyle returns materialized "menu-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.4; set it withWindow.SetMenuStyleorGlobalWindowScope.SetMenuStyle. It is a style option. - ModeKeys method ModeKeys returns materialized "mode-keys" as
OptionValuewith value type OptionValueModeKeysfrom window option values; it does not query tmux. Available as CHOICE (choices: "emacs", "vi"); set it withWindow.SetModeKeysorGlobalWindowScope.SetModeKeys. - ModeStyle method ModeStyle returns materialized "mode-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetModeStyleorGlobalWindowScope.SetModeStyle. It is a style option. - MonitorActivity method MonitorActivity returns materialized "monitor-activity" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG; set it withWindow.SetMonitorActivityorGlobalWindowScope.SetMonitorActivity. - MonitorBell method MonitorBell returns materialized "monitor-bell" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG; set it withWindow.SetMonitorBellorGlobalWindowScope.SetMonitorBell. - MonitorSilence method MonitorSilence returns materialized "monitor-silence" as
OptionValuewith value type OptionValueint64from window option values; it does not query tmux. Available as NUMBER; set it withWindow.SetMonitorSilenceorGlobalWindowScope.SetMonitorSilence. - OtherPaneHeight method OtherPaneHeight returns materialized "other-pane-height" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetOtherPaneHeightorGlobalWindowScope.SetOtherPaneHeight. - OtherPaneWidth method OtherPaneWidth returns materialized "other-pane-width" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetOtherPaneWidthorGlobalWindowScope.SetOtherPaneWidth. - PaneActiveBorderStyle method PaneActiveBorderStyle returns materialized "pane-active-border-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; STRING since tmux 3.7; set it withWindow.SetPaneActiveBorderStyleorGlobalWindowScope.SetPaneActiveBorderStyle. It is a style option. - PaneBaseIndex method PaneBaseIndex returns materialized "pane-base-index" as
OptionValuewith value type OptionValueint64from window option values; it does not query tmux. Available as NUMBER; set it withWindow.SetPaneBaseIndexorGlobalWindowScope.SetPaneBaseIndex. - PaneBorderFormat method PaneBorderFormat returns materialized "pane-border-format" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetPaneBorderFormatorGlobalWindowScope.SetPaneBorderFormat. - PaneBorderIndicators method PaneBorderIndicators returns materialized "pane-border-indicators" as
OptionValuewith value type OptionValuePaneBorderIndicatorsfrom window option values; it does not query tmux. Available as CHOICE (choices: "off", "colour", "arrows", "both"); set it withWindow.SetPaneBorderIndicatorsorGlobalWindowScope.SetPaneBorderIndicators. - PaneBorderLines method PaneBorderLines returns materialized "pane-border-lines" as
OptionValuewith value type OptionValuePaneBorderLinesfrom window option values; it does not query tmux. Available as CHOICE (choices: "single", "double", "heavy", "simple", "number"); CHOICE since tmux 3.6 (choices: "single", "double", "heavy", "simple", "number", "spaces"); set it withWindow.SetPaneBorderLinesorGlobalWindowScope.SetPaneBorderLines. - PaneBorderStatus method PaneBorderStatus returns materialized "pane-border-status" as
OptionValuewith value type OptionValuePaneBorderStatusfrom window option values; it does not query tmux. Available as CHOICE (choices: "off", "top", "bottom"); set it withWindow.SetPaneBorderStatusorGlobalWindowScope.SetPaneBorderStatus. - PaneBorderStyle method PaneBorderStyle returns materialized "pane-border-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; STRING since tmux 3.7; set it withWindow.SetPaneBorderStyleorGlobalWindowScope.SetPaneBorderStyle. It is a style option. - PaneColours method PaneColours returns materialized "pane-colours" as
OptionValuewith value type OptionValue[SparseArraystring] from window option values; it does not query tmux. Available as COLOUR; set it withWindow.SetPaneColoursorGlobalWindowScope.SetPaneColours. Its present SparseArray value preserves assigned tmux indexes, including gaps. - PaneScrollbars method PaneScrollbars returns materialized "pane-scrollbars" as
OptionValuewith value type OptionValuePaneScrollbarsfrom window option values; it does not query tmux. Available as CHOICE since tmux 3.6 (choices: "off", "modal", "on"); set it withWindow.SetPaneScrollbarsorGlobalWindowScope.SetPaneScrollbars. - PaneScrollbarsPosition method PaneScrollbarsPosition returns materialized "pane-scrollbars-position" as
OptionValuewith value type OptionValuePaneScrollbarsPositionfrom window option values; it does not query tmux. Available as CHOICE since tmux 3.6 (choices: "right", "left"); set it withWindow.SetPaneScrollbarsPositionorGlobalWindowScope.SetPaneScrollbarsPosition. - PaneScrollbarsStyle method PaneScrollbarsStyle returns materialized "pane-scrollbars-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.6; set it withWindow.SetPaneScrollbarsStyleorGlobalWindowScope.SetPaneScrollbarsStyle. It is a style option. - PaneStatusCurrentStyle method PaneStatusCurrentStyle returns materialized "pane-status-current-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.6; set it withWindow.SetPaneStatusCurrentStyleorGlobalWindowScope.SetPaneStatusCurrentStyle. It is a style option. - PaneStatusStyle method PaneStatusStyle returns materialized "pane-status-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.6; set it withWindow.SetPaneStatusStyleorGlobalWindowScope.SetPaneStatusStyle. It is a style option. - PopupBorderLines method PopupBorderLines returns materialized "popup-border-lines" as
OptionValuewith value type OptionValuePopupBorderLinesfrom window option values; it does not query tmux. Available as CHOICE (choices: "single", "double", "heavy", "simple", "rounded", "padded", "none"); set it withWindow.SetPopupBorderLinesorGlobalWindowScope.SetPopupBorderLines. - PopupBorderStyle method PopupBorderStyle returns materialized "popup-border-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetPopupBorderStyleorGlobalWindowScope.SetPopupBorderStyle. It is a style option. - PopupStyle method PopupStyle returns materialized "popup-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetPopupStyleorGlobalWindowScope.SetPopupStyle. It is a style option. - RemainOnExit method RemainOnExit returns materialized "remain-on-exit" as
OptionValuewith value type OptionValueRemainOnExitfrom window option values; it does not query tmux. Available as CHOICE (choices: "off", "on", "failed"); CHOICE since tmux 3.7 (choices: "off", "on", "failed", "key"); set it withWindow.SetRemainOnExitorGlobalWindowScope.SetRemainOnExit. - RemainOnExitFormat method RemainOnExitFormat returns materialized "remain-on-exit-format" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetRemainOnExitFormatorGlobalWindowScope.SetRemainOnExitFormat. - ScrollOnClear method ScrollOnClear returns materialized "scroll-on-clear" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG; set it withWindow.SetScrollOnClearorGlobalWindowScope.SetScrollOnClear. - SessionStatusCurrentStyle method SessionStatusCurrentStyle returns materialized "session-status-current-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.6; set it withWindow.SetSessionStatusCurrentStyleorGlobalWindowScope.SetSessionStatusCurrentStyle. It is a style option. - SessionStatusStyle method SessionStatusStyle returns materialized "session-status-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.6; set it withWindow.SetSessionStatusStyleorGlobalWindowScope.SetSessionStatusStyle. It is a style option. - SynchronizePanes method SynchronizePanes returns materialized "synchronize-panes" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG; set it withWindow.SetSynchronizePanesorGlobalWindowScope.SetSynchronizePanes. - TiledLayoutMaxColumns method TiledLayoutMaxColumns returns materialized "tiled-layout-max-columns" as
OptionValuewith value type OptionValueint64from window option values; it does not query tmux. Available as NUMBER since tmux 3.6; set it withWindow.SetTiledLayoutMaxColumnsorGlobalWindowScope.SetTiledLayoutMaxColumns. - TreeModePreviewFormat method TreeModePreviewFormat returns materialized "tree-mode-preview-format" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.7; set it withWindow.SetTreeModePreviewFormatorGlobalWindowScope.SetTreeModePreviewFormat. - TreeModePreviewStyle method TreeModePreviewStyle returns materialized "tree-mode-preview-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.7; set it withWindow.SetTreeModePreviewStyleorGlobalWindowScope.SetTreeModePreviewStyle. It is a style option. - WindowActiveStyle method WindowActiveStyle returns materialized "window-active-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetWindowActiveStyleorGlobalWindowScope.SetWindowActiveStyle. It is a style option. - WindowPaneCurrentStatusFormat method WindowPaneCurrentStatusFormat returns materialized "window-pane-current-status-format" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.7; set it withWindow.SetWindowPaneCurrentStatusFormatorGlobalWindowScope.SetWindowPaneCurrentStatusFormat. - WindowPaneStatusFormat method WindowPaneStatusFormat returns materialized "window-pane-status-format" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING since tmux 3.7; set it withWindow.SetWindowPaneStatusFormatorGlobalWindowScope.SetWindowPaneStatusFormat. - WindowSize method WindowSize returns materialized "window-size" as
OptionValuewith value type OptionValueWindowSizefrom window option values; it does not query tmux. Available as CHOICE (choices: "largest", "smallest", "manual", "latest"); set it withWindow.SetWindowSizeorGlobalWindowScope.SetWindowSize. - WindowStatusActivityStyle method WindowStatusActivityStyle returns materialized "window-status-activity-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetWindowStatusActivityStyleorGlobalWindowScope.SetWindowStatusActivityStyle. It is a style option. - WindowStatusBellStyle method WindowStatusBellStyle returns materialized "window-status-bell-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetWindowStatusBellStyleorGlobalWindowScope.SetWindowStatusBellStyle. It is a style option. - WindowStatusCurrentFormat method WindowStatusCurrentFormat returns materialized "window-status-current-format" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetWindowStatusCurrentFormatorGlobalWindowScope.SetWindowStatusCurrentFormat. - WindowStatusCurrentStyle method WindowStatusCurrentStyle returns materialized "window-status-current-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetWindowStatusCurrentStyleorGlobalWindowScope.SetWindowStatusCurrentStyle. It is a style option. - WindowStatusFormat method WindowStatusFormat returns materialized "window-status-format" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetWindowStatusFormatorGlobalWindowScope.SetWindowStatusFormat. - WindowStatusLastStyle method WindowStatusLastStyle returns materialized "window-status-last-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetWindowStatusLastStyleorGlobalWindowScope.SetWindowStatusLastStyle. It is a style option. - WindowStatusSeparator method WindowStatusSeparator returns materialized "window-status-separator" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetWindowStatusSeparatororGlobalWindowScope.SetWindowStatusSeparator. - WindowStatusStyle method WindowStatusStyle returns materialized "window-status-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetWindowStatusStyleorGlobalWindowScope.SetWindowStatusStyle. It is a style option. - WindowStyle method WindowStyle returns materialized "window-style" as
OptionValuewith value type OptionValuestringfrom window option values; it does not query tmux. Available as STRING; set it withWindow.SetWindowStyleorGlobalWindowScope.SetWindowStyle. It is a style option. - WrapSearch method WrapSearch returns materialized "wrap-search" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG; set it withWindow.SetWrapSearchorGlobalWindowScope.SetWrapSearch. - XTermKeys method XTermKeys returns materialized "xterm-keys" as
OptionValuewith value type OptionValueboolfrom window option values; it does not query tmux. Available as FLAG; set it withWindow.SetXTermKeysorGlobalWindowScope.SetXTermKeys.
tmux options#
Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.