Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-erlang latest

tmux_pane:split/2

Split a pane, or the supplied window's active pane, and observe the new pane. Defaults to a detached vertical split. Options and launch semantics are described in the module docs. Performs I/O; a post-creation read error retains the completed mutation rather than pretending that no pane was created.

Source and package
Qualified name
tmux_pane:split/2
Declared in
tmux_pane
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_pane.erl
Other languages
Perlmethod PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC# C++ SwiftKotlinScalaOCaml F# Clojure
split(Row, Options) -spec split(tmux_model:pane() | tmux_model:window(), split_options()) -> {ok, tmux_model:pane()} | {error, map()}.

tmux command#

The tmux commands behind split/2.

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

Guides#

Pages that discuss split/2.

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
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.split
Rust pane.Pane.split
Go tmux.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