Pane.split
Split window and return Pane, by default beneath current pane.
Source and package
-
Examples#
>>> (pane.at_left, pane.at_right,... pane.at_top, pane.at_bottom)(True, True,True, True)>>> new_pane = pane.split()>>> (new_pane.at_left, new_pane.at_right,... new_pane.at_top, new_pane.at_bottom)(True, True,False, True)>>> right_pane = pane.split(direction=PaneDirection.Right)>>> (right_pane.at_left, right_pane.at_right,... right_pane.at_top, right_pane.at_bottom)(False, True,True, False)>>> left_pane = pane.split(direction=PaneDirection.Left)>>> (left_pane.at_left, left_pane.at_right,... left_pane.at_top, left_pane.at_bottom)(True, False,True, False)>>> top_pane = pane.split(direction=PaneDirection.Above)>>> (top_pane.at_left, top_pane.at_right,... top_pane.at_top, top_pane.at_bottom)(False, False,True, False)>>> pane = session.new_window().active_pane>>> top_pane = pane.split(direction=PaneDirection.Above, full_window_split=True)>>> (top_pane.at_left, top_pane.at_right,... top_pane.at_top, top_pane.at_bottom)(True, True,True, False)>>> bottom_pane = pane.split(... direction=PaneDirection.Below,... full_window_split=True)>>> (bottom_pane.at_left, bottom_pane.at_right,... bottom_pane.at_top, bottom_pane.at_bottom)(True, True,False, True)- Parameters
-
-
target(int | str | None) # – Optional, custom target-pane, used byWindow.split(). -
start_directory(StrPath | None) # – specifies the working directory in which the new window is created. -
attach(bool) # – make new window the current window after creating it, default True. -
direction(PaneDirection | None) # – split in direction. If none is specified, assume down. -
full_window_split(bool | None) # – split across full window width or height, rather than active pane. -
shell(str | None) # – execute a command on splitting the window. The pane will close when the command exits. NOTE: When this command exits the pane will close. This feature is useful for long-running processes where the closing of the window upon completion is desired. -
size(str | int | None) # – Cell/row count to occupy with respect to current window. -
percentage(int | None) # – Percentage (0-100) of the window to occupy (-pflag). Mutually exclusive with size. added 0.56 -
environment(dict[str, str] | None) # – Environmental variables for new pane. Passthrough to-e. -
empty(bool | None) # – Create an empty pane with no command (-Eflag) instead of spawning the default shell. Requires tmux 3.7+. If used with tmux < 3.7, a warning is issued and the flag is ignored. -
style(str | None) # – Style for the new pane (-s). Requires tmux 3.7+. -
active_border_style(str | None) # – Active-pane border style (-S). Requires tmux 3.7+. -
inactive_border_style(str | None) # – Inactive-pane border style (-R). Requires tmux 3.7+. -
message(str | None) # – Keep the pane open (until a key is pressed) after exit, showing thisremain-on-exit-formatmessage (-m). Requires tmux 3.7+. -
keep(bool | None) # – Keep the pane open until a key is pressed after exit (-k). Requires tmux 3.7+. These 3.7 flags warn and are ignored below 3.7.
-
tmux command#
The tmux commands behind split.
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
In other ports#
Split a pane in two
| Language | Equivalent |
|---|---|
| Ruby | Lib |
| Lua | libtmux |
| Erlang | tmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | pane |
| Rust | pane |
| Go | tmux |
| Java | io |
| Clojure | libtmux |
| Kotlin | io |
| Scala | io |
| C# | Lib |
| C++ | no direct pane target; Window.split splits the active pane |
| Swift | Server |
| OCaml | Libtmux |
| Perl | Lib Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes. |
No equivalent is recorded in PowerShell, Julia, Elixir, Common Lisp or F#.