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.Pane

struct workspace.Pane

Pane is one pane in a window. YAML accepts either a bare command string or a mapping, so "echo hello" and {shell_command: echo hello} are equivalent.

Guides#

Pages that discuss Pane.

Fields10#

Pane fields
NameTypeDescription
Commands []Command Commands run in the pane, in order.
CommandsBefore []Command CommandsBefore run before Commands, after the window's.
StartDirectory string StartDirectory overrides the window directory for this pane.
Shell string Shell replaces this pane's command. On the first pane it conflicts with Window.Shell because tmux creates that pane with the window.
Focus Bool Focus selects this pane once its window is built.
SuppressHistory *Bool SuppressHistory overrides the window setting for this pane.
Environment map[string]string Environment is written to the session after all panes in the window exist and before this pane's commands are sent. Pane entries are processed in order, so repeated names keep the last value written.
Enter *Bool Enter applies to every command in this pane unless the command sets its own. Nil presses Enter, matching tmuxp.
SleepBefore time.Duration SleepBefore delays before each of this pane's commands. YAML writes it as a number of seconds, matching tmuxp, so 0.5 is half a second.
SleepAfter time.Duration SleepAfter delays after each of this pane's commands, in the same units.

Other members1#

  • UnmarshalYAML method UnmarshalYAML decodes a pane written as a bare command or as a mapping.
Esc

Type to search.

Reference previewOpen reference