workspace.Workspace

struct workspace.Workspace

struct [source] ¶

struct [source] ¶

struct workspace.Workspace

Workspace is one tmuxp-style session description.

Members

• CommandsBefore attribute CommandsBefore run in every pane before that pane's own commands. Window and pane entries add to this list rather than replacing it.
• Environment attribute Environment is written to the session after its initial pane exists and before later windows are created.
• GlobalOptions attribute GlobalOptions are applied after the initial window exists and before later windows are created.
• Options attribute Options are applied after session creation. tmux resolves window-option names against the session's current window.
• SessionName attribute SessionName names the created session. It is required.
• StartDirectory attribute StartDirectory is the default working directory for every window and pane that does not set its own.
• SuppressHistory attribute SuppressHistory prefixes commands with a space unless a window or pane overrides it.
• Windows attribute Windows are created in order. A workspace needs at least one.
• InitialSessionRequest method InitialSessionRequest validates w and returns the request that creates its session and initial window. Use the resulting materialized session with BuildInto to continue the build over a caller-owned transport.
• MissingDirectories method MissingDirectories returns absent start directories in document order. It is separate from Workspace.Validate because a prior command may create them. tmux otherwise falls back to the user's home directory without an error. Names beginning with ~ are resolved as tmux resolves them.
• UnmarshalYAML method UnmarshalYAML decodes the workspace, then its shell_command_before, which accepts one command or a list.
• Validate method Validate reports all problems joined under ErrInvalidWorkspace.