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

Pane.split

Split this pane and resolve the created pane.

Source and package
Qualified name
Pane.split
Module
pane
Declared in
Pane
Package
libtmux
Source
packages/libtmux/src/pane.ts
Other languages
PowerShell Julia Elixir PythonRubyLuaRustGoJavaC# C++ SwiftKotlinScala F#

Examples#

import { PaneDirection } from "libtmux";
const created = await pane.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 pane in two

Equivalents of Split a pane in two in other languages
Language Equivalent
Python libtmux.Pane.split
Ruby LibTmux::Pane#split
Lua libtmux.Pane:split
Rust pane.Pane.split
Go tmux.Pane.Split
Java io.github.libtmux.Pane.split
Kotlin io.github.libtmux.kotlin.Pane.split
Scala io.github.libtmux.scaladsl.Pane.split
C# LibTmux.Pane.SplitAsync
C++ no direct pane target; Window.split splits the active pane
Swift Server.split(_:direction:size:startDirectory:environment:shell:)

No equivalent is recorded in PowerShell, Julia, Elixir or F#.

Esc

Type to search.

Reference previewOpen reference