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

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

struct config.PaneConfig

One pane.

Description#

The default is a pane that runs nothing and would press Enter after anything it were given, which is what tmuxp's - pane, - blank and an empty - all mean.

Guides#

Pages that discuss PaneConfig.

Fields11#

PaneConfig fields
NameTypeDescription
shell_command_before Vec<ShellCommand> Commands run in this pane before Self::shell_commands, in order, after the workspace's and the window's own WindowConfig::shell_command_before.
shell_commands Vec<ShellCommand> Commands to run in the pane once it exists.
environment Option<Vec<(String, String)>> Environment variables set for the process this pane starts.
start_directory Option<PathBuf> The pane's working directory.
focus bool Whether this pane should end up selected.
shell Option<String> A command that replaces this pane's shell, overriding WindowConfig::window_shell when both are given.
enter bool Whether to press Enter after each command, until a command sets its own ShellCommand::enter.
sleep_before Option<Duration> How long to wait before each command, until a command sets its own.
sleep_after Option<Duration> How long to wait after each command, until a command sets its own.
suppress_history Option<bool> Whether this pane's commands stay out of the shell's history.
unsupported_keys Vec<String> Keys this parser recognized on the pane but does not act on.
Esc

Type to search.

Reference previewOpen reference