Workspace ManagerconceptAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

workspace.Window

struct workspace.Window

Window is one window in a workspace.

Guides#

Pages that discuss Window.

Fields12#

Window fields
NameTypeDescription
Name string Name is the window name. Empty lets tmux choose.
Index *int Index requests an explicit winlink index. Nil uses the next free index.
Layout string Layout is a tmux layout name applied after the panes exist.
StartDirectory string StartDirectory overrides the workspace directory for this window.
Shell string Shell replaces the command the window's first pane runs.
Focus Bool Focus selects this window once the workspace is built.
SuppressHistory *Bool SuppressHistory overrides the workspace setting for this window's panes.
Options map[string]string Options are applied after the window's initial pane exists and before additional panes are split.
OptionsAfter map[string]string OptionsAfter are window options applied once the panes exist, for settings that a later split would otherwise overwrite.
Environment map[string]string Environment is written to the session after this window's initial pane exists and before additional panes are split. Repeated names keep the last value written.
CommandsBefore []Command CommandsBefore run in each of this window's panes before the pane's own commands, after the workspace's.
Panes []Pane Panes are created in order. The first pane is the window's initial pane; each later one splits the window.

Other members1#

  • UnmarshalYAML method UnmarshalYAML decodes the window, then its shell_command_before.
Esc

Type to search.

Reference previewOpen reference