Window.new_pane
Create a floating Pane in this window ($ tmux new-pane).
Source and package
- Qualified name
-
libtmux.Window. new _pane - Module
- libtmux
- Declared in
Window- Package
- libtmux
- Source
- src/libtmux/window.py
-
Description#
Use
split()for a tiled pane. Floating panes require tmux 3.7+; delegates toPane.new_pane()on the active pane.Examples#
>>> from libtmux.common import has_gte_version>>> if has_gte_version("3.7"):... floating = window.new_pane(width=40, height=10, shell="sleep 5")... is_floating = floating.pane_floating_flag... else:... is_floating = "1">>> is_floating'1'- Parameters
-
-
start_directory(StrPath | None) # – Working directory for the new pane (-c). -
attach(bool) # – Make the new pane active, default False (-dotherwise). -
shell(str | None) # – Command to run; the pane closes when it exits. -
environment(dict[str, str] | None) # – Environment variables for the new pane (-e). -
empty(bool | None) # – Create an empty pane with no command (-E). -
active_border_style(str | None) # – Border style when the pane is active (-S). -
inactive_border_style(str | None) # – Border style when the pane is inactive (-R). -
message(str | None) # – Keep the pane open (until a key is pressed) after the command exits, showing thisremain-on-exit-formatmessage (-m). -
keep(bool | None) # – Keep the pane open until a key is pressed after exit (-k), using the defaultremain-on-exit-format.
- Returns
-
PaneThe newly created floating pane.
tmux command#
The tmux commands behind new_pane.
tmux C API#
The C declarations in tmux that implement these commands.
Each path starts at a function a command runs, which is degree 1. The degree counts steps from there along the path, and each step is a call or a reference: degree 2 is reached from that function, degree 3 from the next, and so on.
Split a window
- 1
cmd_split_window_exec - references → 2
spawn_pane - calls → 3
window_add_pane - calls → 4
window_pane_create