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.

Go API

method libtmux-go latest

Pane.Split

Split creates a tiled pane relative to the receiver's exact linked-pane view. Attach makes the new pane active in that session and winlink; it is not a global client-focus guarantee. The returned Pane is freshly materialized in the receiver SessionID and WindowID. Named Split rather than SplitPane to avoid repeating Pane; Window.SplitPane is the equivalent operation relative to a window.

Source and package
Qualified name
tmux.Pane.Split
Package
tmux
Declared in
Pane
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/pane_create.go
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustJavaC# C++ SwiftKotlinScalaOCaml F# Clojure

Description#

If tmux reports a PaneID before a transport or refresh failure, the partial result also contains the receiver SessionID and WindowID. Other failures return zero; creation is not rolled back.

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
Erlang tmux_pane:split/2
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.split
Rust pane.Pane.split
Java io.github.libtmux.Pane.split
Clojure libtmux.core/split-pane!
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:)
OCaml Libtmux_unix.Client.split_pane
Perl LibTmux::Server::split_pane 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#.

Esc

Type to search.

Reference previewOpen reference