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.

config.WindowConfig

This type appears in public signatures. It is not a package entry point.

struct config.WindowConfig

One window and the panes it should contain.

Guides#

Pages that discuss WindowConfig.

Fields12#

WindowConfig fields
NameTypeDescription
window_name Option<String> The window name, or None to let tmux choose.
window_index Option<i32> The window index to create at, or None for the first free one.
window_shell Option<String> A command that replaces the shell in every pane of this window that does not set its own PaneConfig::shell.
environment Vec<(String, String)> Environment variables set for the processes this window starts.
layout Option<String> A tmux layout name or specification applied after the panes exist.
start_directory Option<PathBuf> A working directory inherited by panes that do not set their own.
focus bool Whether this window should end up selected.
options Vec<(String, String)> Window options to apply once the window exists.
shell_command_before Vec<ShellCommand> Commands run in this window's panes before their own, in order.
suppress_history Option<bool> Whether this window's commands stay out of the shell's history.
panes Vec<PaneConfig> The panes to create, in order. The first is the window's own pane.
unsupported_keys Vec<String> Keys this parser recognized on the window but does not act on.
Esc

Type to search.

Reference previewOpen reference