Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

config.WindowConfig

Rust
  • Python Unavailable
  • TypeScript Unavailable
  • Rust
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

API reference · Markdown

struct config.WindowConfig
structoverload [source]
structoverload [source]
struct config.WindowConfig

One window and the panes it should contain.

Discussed in Rust workspace builder API

Members

window_name

window_name : Option<String>
attribute [source]
attribute [source]
window_name

The window name, or None to let tmux choose.

window_index

window_index : Option<i32>
attribute [source]
attribute [source]
window_index

The window index to create at, or None for the first free one.

window_shell

window_shell : Option<String>
attribute [source]
attribute [source]
window_shell

A command to run instead of the window's default shell.

environment

environment : Vec<(String, String)>
attribute [source]
attribute [source]
environment

Environment variables set for the processes this window starts.

layout

layout : Option<String>
attribute [source]
attribute [source]
layout

A tmux layout name or specification applied after the panes exist.

start_directory

start_directory : Option<PathBuf>
attribute [source]
attribute [source]
start_directory

A working directory inherited by panes that do not set their own.

focus

focus : bool
attribute [source]
attribute [source]
focus

Whether this window should end up selected.

options

options : Vec<(String, String)>
attribute [source]
attribute [source]
options

Window options to apply once the window exists.

shell_command_before

shell_command_before : Vec<ShellCommand>
attribute [source]
attribute [source]
shell_command_before

Commands run in this window's panes before their own, in order.

suppress_history

suppress_history : Option<bool>
attribute [source]
attribute [source]
suppress_history

Whether this window's commands stay out of the shell's history.

None inherits the workspace setting.

panes

panes : Vec<PaneConfig>
attribute [source]
attribute [source]
panes

The panes to create, in order. The first is the window's own pane.

unsupported_keys

unsupported_keys : Vec<String>
attribute [source]
attribute [source]
unsupported_keys

Keys this parser recognized on the window but does not act on.

Esc

Type to search.