Core Library0.xAPI 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.

method libtmux-ts latest

Window.split

Split this window and resolve the created pane.

Source and package
Qualified name
Window.split
Module
window
Declared in
Window
Package
libtmux
Source
packages/libtmux/src/window.ts
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua RustGoJavaC#C++SwiftKotlinScala OCaml F# Clojure

Examples#

import { PaneDirection } from "libtmux";
const created = await window.split({ direction: PaneDirection.Below });
created.id;
Parameters
Raises
  • TypeError – when options combines direction with vertical.

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. 1 cmd_split_window_exec
  2. references → 2 spawn_pane
  3. calls → 3 window_add_pane
  4. calls → 4 window_pane_create

In other ports#

Split a window's active pane

Equivalents of Split a window's active pane in other languages
Language Equivalent
Python libtmux.Window.split
Ruby LibTmux::Window#split
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Rust window.Window.split
Go tmux.Window.SplitPane
Java io.github.libtmux.Window.split
Kotlin io.github.libtmux.kotlin.Window.split
Scala io.github.libtmux.scaladsl.Window.split
C# LibTmux.Window.SplitPaneAsync
C++ libtmux::Window::split
Swift Server.splitWindow(_:direction:size:startDirectory:environment:shell:)
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure or F#.

Esc

Type to search.

Reference previewOpen reference