GlobalSessionScope
GlobalSessionScope is an immutable handle for global session options and hooks. Its zero value is invalid because it contains a zero Server.
Source and package
- Qualified name
-
tmux.Global Session Scope - Package
- tmux
- Distribution
- github.com/libtmux/libtmux-go/tmux
- Source
- tmux/option_scope.go
Members66#
- AppendHook method AppendHook appends a global session-scope hook without refreshing models. Completed failures are secret-safe option errors; cancellation does not prove tmux did not accept the append.
- AppendOption method AppendOption appends to a global session option without refreshing models. Completed failures are secret-safe option errors; cancellation does not prove the append was not accepted.
- Hooks method Hooks returns a freshly decoded, caller-owned view of known global session-scope hooks, including inherited values. A read failure is returned rather than answered with zero values.
- Options method Options returns a freshly decoded, caller-owned view of known global session options, including defaults. A read failure is returned rather than answered with zero values; context errors propagate. Each returned accessor names the setter that writes it, so
SessionOptionValues.Statuspairs withGlobalSessionScope.SetStatus. - RawHook method RawHook returns one exact global session-scope hook value. A successful string is caller-owned; ok reports presence. Targeted reads do not use list leniency, and completed failures return a secret-safe option error. An unindexed empty hook array is ambiguous; use Hooks for typed presence.
- RawOption method RawOption returns one exact global session-option value. A successful string is caller-owned, and ok reports presence. An unindexed empty array is indistinguishable from an empty scalar; use Options for typed array presence.
- RunHook method RunHook asks tmux to run one global hook directly. It intentionally performs no racy target preflight; stale targets and global execution context remain tmux-defined. Completed failures are secret-safe option errors; cancellation does not prove hook delivery or execution did not occur.
- SetActivityAction method SetActivityAction stores the "activity-action" session option as ActivityAction. Read it with
SessionOptionValues.ActivityActionfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetAssumePasteTime method SetAssumePasteTime stores the "assume-paste-time" session option as time.Duration. Read it with
SessionOptionValues.AssumePasteTimefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetBaseIndex method SetBaseIndex stores the "base-index" session option as int64. Read it with
SessionOptionValues.BaseIndexfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetBellAction method SetBellAction stores the "bell-action" session option as BellAction. Read it with
SessionOptionValues.BellActionfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetDefaultCommand method SetDefaultCommand stores the "default-command" session option as string. Read it with
SessionOptionValues.DefaultCommandfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetDefaultShell method SetDefaultShell stores the "default-shell" session option as string. Read it with
SessionOptionValues.DefaultShellfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetDefaultSize method SetDefaultSize stores the "default-size" session option as string. Read it with
SessionOptionValues.DefaultSizefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetDestroyUnattached method SetDestroyUnattached stores the "destroy-unattached" session option as DestroyUnattached. Read it with
SessionOptionValues.DestroyUnattachedfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetDetachOnDestroy method SetDetachOnDestroy stores the "detach-on-destroy" session option as DetachOnDestroy. Read it with
SessionOptionValues.DetachOnDestroyfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetDisplayPanesActiveColour method SetDisplayPanesActiveColour stores the "display-panes-active-colour" session option as string. Read it with
SessionOptionValues.DisplayPanesActiveColourfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetDisplayPanesColour method SetDisplayPanesColour stores the "display-panes-colour" session option as string. Read it with
SessionOptionValues.DisplayPanesColourfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetDisplayPanesTime method SetDisplayPanesTime stores the "display-panes-time" session option as time.Duration. Read it with
SessionOptionValues.DisplayPanesTimefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetDisplayTime method SetDisplayTime stores the "display-time" session option as time.Duration. Read it with
SessionOptionValues.DisplayTimefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetFocusFollowsMouse method SetFocusFollowsMouse stores the "focus-follows-mouse" session option as bool (tmux 3.7 or later). Read it with
SessionOptionValues.FocusFollowsMousefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetHistoryLimit method SetHistoryLimit stores the "history-limit" session option as int64. Read it with
SessionOptionValues.HistoryLimitfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetHook method SetHook stores a global session-scope hook without refreshing models. Completed failures are secret-safe option errors; cancellation does not prove tmux did not accept the mutation.
- SetHooks method SetHooks applies indexed global session-scope hook commands in ascending order. With ClearExisting it confirms clearing before applying sparse Values. It stops at the first failure without rollback; the returned result reports only confirmed partial progress and owns AppliedIndices. Cancellation may follow accepted commands and cannot disprove their delivery.
- SetInitialRepeatTime method SetInitialRepeatTime stores the "initial-repeat-time" session option as time.Duration (tmux 3.6 or later). Read it with
SessionOptionValues.InitialRepeatTimefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetKeyTable method SetKeyTable stores the "key-table" session option as string. Read it with
SessionOptionValues.KeyTablefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetLockAfterTime method SetLockAfterTime stores the "lock-after-time" session option as time.Duration. Read it with
SessionOptionValues.LockAfterTimefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetLockCommand method SetLockCommand stores the "lock-command" session option as string. Read it with
SessionOptionValues.LockCommandfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetMessageCommandStyle method SetMessageCommandStyle stores the "message-command-style" session option as string. Read it with
SessionOptionValues.MessageCommandStylefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetMessageFormat method SetMessageFormat stores the "message-format" session option as string (tmux 3.7 or later). Read it with
SessionOptionValues.MessageFormatfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetMessageLine method SetMessageLine stores the "message-line" session option as MessageLine (tmux 3.4 or later). Read it with
SessionOptionValues.MessageLinefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetMessageStyle method SetMessageStyle stores the "message-style" session option as string. Read it with
SessionOptionValues.MessageStylefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetMouse method SetMouse stores the "mouse" session option as bool. Read it with
SessionOptionValues.MousefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetOption method SetOption stores a global session option without refreshing existing models. Completed failures are secret-safe option errors; cancellation does not prove tmux did not accept the mutation.
- SetPrefix method SetPrefix stores the "prefix" session option as string. Read it with
SessionOptionValues.PrefixfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetPrefix2 method SetPrefix2 stores the "prefix2" session option as string. Read it with
SessionOptionValues.Prefix2fromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetPromptCommandCursorStyle method SetPromptCommandCursorStyle stores the "prompt-command-cursor-style" session option as PromptCommandCursorStyle (tmux 3.7 or later). Read it with
SessionOptionValues.PromptCommandCursorStylefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetPromptCursorColour method SetPromptCursorColour stores the "prompt-cursor-colour" session option as string (tmux 3.6 or later). Read it with
SessionOptionValues.PromptCursorColourfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetPromptCursorStyle method SetPromptCursorStyle stores the "prompt-cursor-style" session option as PromptCursorStyle (tmux 3.6 or later). Read it with
SessionOptionValues.PromptCursorStylefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetRenumberWindows method SetRenumberWindows stores the "renumber-windows" session option as bool. Read it with
SessionOptionValues.RenumberWindowsfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetRepeatTime method SetRepeatTime stores the "repeat-time" session option as time.Duration. Read it with
SessionOptionValues.RepeatTimefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetSilenceAction method SetSilenceAction stores the "silence-action" session option as SilenceAction. Read it with
SessionOptionValues.SilenceActionfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatus method SetStatus stores the "status" session option as Status. Read it with
SessionOptionValues.StatusfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusBG method SetStatusBG stores the "status-bg" session option as string. Read it with
SessionOptionValues.StatusBGfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusFG method SetStatusFG stores the "status-fg" session option as string. Read it with
SessionOptionValues.StatusFGfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusFormat method SetStatusFormat replaces the complete "status-format" session option array with SparseArray
string, preserving holes and empty values. Read it withSessionOptionValues.StatusFormatfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. Replacement is not atomic: the result reports confirmed writes, and failures stop without rollback. Serialize concurrent replacement of the same target and option. - SetStatusInterval method SetStatusInterval stores the "status-interval" session option as time.Duration. Read it with
SessionOptionValues.StatusIntervalfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusJustify method SetStatusJustify stores the "status-justify" session option as StatusJustify. Read it with
SessionOptionValues.StatusJustifyfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusKeys method SetStatusKeys stores the "status-keys" session option as StatusKeys. Read it with
SessionOptionValues.StatusKeysfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusLeft method SetStatusLeft stores the "status-left" session option as string. Read it with
SessionOptionValues.StatusLeftfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusLeftLength method SetStatusLeftLength stores the "status-left-length" session option as int64. Read it with
SessionOptionValues.StatusLeftLengthfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusLeftStyle method SetStatusLeftStyle stores the "status-left-style" session option as string. Read it with
SessionOptionValues.StatusLeftStylefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusPosition method SetStatusPosition stores the "status-position" session option as StatusPosition. Read it with
SessionOptionValues.StatusPositionfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusRight method SetStatusRight stores the "status-right" session option as string. Read it with
SessionOptionValues.StatusRightfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusRightLength method SetStatusRightLength stores the "status-right-length" session option as int64. Read it with
SessionOptionValues.StatusRightLengthfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusRightStyle method SetStatusRightStyle stores the "status-right-style" session option as string. Read it with
SessionOptionValues.StatusRightStylefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetStatusStyle method SetStatusStyle stores the "status-style" session option as string. Read it with
SessionOptionValues.StatusStylefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetTitles method SetTitles stores the "set-titles" session option as bool. Read it with
SessionOptionValues.SetTitlesfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetTitlesString method SetTitlesString stores the "set-titles-string" session option as string. Read it with
SessionOptionValues.SetTitlesStringfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetUpdateEnvironment method SetUpdateEnvironment replaces the complete "update-environment" session option array with SparseArray
string, preserving holes and empty values. Read it withSessionOptionValues.UpdateEnvironmentfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. Replacement is not atomic: the result reports confirmed writes, and failures stop without rollback. Serialize concurrent replacement of the same target and option. - SetVisualActivity method SetVisualActivity stores the "visual-activity" session option as VisualActivity. Read it with
SessionOptionValues.VisualActivityfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetVisualBell method SetVisualBell stores the "visual-bell" session option as VisualBell. Read it with
SessionOptionValues.VisualBellfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetVisualSilence method SetVisualSilence stores the "visual-silence" session option as VisualSilence. Read it with
SessionOptionValues.VisualSilencefromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - SetWordSeparators method SetWordSeparators stores the "word-separators" session option as string. Read it with
SessionOptionValues.WordSeparatorsfromGlobalSessionScope.Options;GlobalSessionScope.UnsetOptionrestores inheritance or the global default. - UnsetHook method UnsetHook removes every matching global session-scope hook index without refreshing models. Completed failures are secret-safe option errors; cancellation does not prove tmux did not accept the unset.
- UnsetOption method UnsetOption unsets a global session option without refreshing models. UnsetPanes is invalid at this scope; cancellation does not prove the unset was not accepted.