tmux_pane

Description#

split/2 accepts a pane or a window; a window means its active pane at execution. Options (split_options/0) are direction (horizontal or vertical), size ({cells, N} or {percent, N}), before, full_size, zoom, cwd, env, launch and detach. It defaults to a detached vertical split. get/2 returns newly observed fields; existing rows remain unchanged. Reads span several commands and do not claim atomicity. Launch and environment options follow tmux_session:create/2. An absent or zero tmux pane_pid is represented as none. A captured positive PID is an observation, not a guarantee that the process remains alive.

A successful split followed by a failed observation retains the completed mutation and command result in its error. kill/1 returns the command result. Detached or stale references cannot act. resize_command/2 builds a reusable value without tmux I/O; the other calls perform I/O after validation.

send_text/2 sends up to 2,000 literal bytes, including NUL, in one command using tmux's hexadecimal key form. It adds no Enter key and never splits a large input into partially applied commands. send_keys/2 accepts up to 256 named keys, single UTF-8 characters, {function, 1..12} and {control, <<Letter>>}. Named keys are enter, tab, escape, backspace, space, up, down, left, right, home, 'end', insert, delete, page_up, page_down and back_tab. Terminal modes still govern how input is consumed; command completion does not mean a program processed it.

capture/2 returns stdout bytes unchanged, including final newlines. Options (capture_options/0) are start and 'end' (line integers or all), join_lines, escape_sequences, escape_control, retain_trailing_spaces, alternate, pending and quiet. Defaults are tmux's current-screen capture without escapes, joined wraps or padding. The endpoint's output limit applies; an oversized capture returns an error.

Use join/3, move/3 and swap/3 to rearrange existing panes without respawning their processes. break/4 takes an explicit source window link: breaking a window's only pane moves that membership, while breaking one of several panes creates a new physical window. The topology guide shows the distinction. Use get/2 or a new snapshot for updated parents and indexes; actions leave captured values unchanged.

pipe/3 connects a tmux-owned shell process to pane output, input or both. It protects the shell text from tmux hash/strftime expansion; shell quoting remains the caller's responsibility. stop_pipe/1 closes that native pipe. These actions do not create an Erlang output subscription or transfer process ownership to the endpoint. Use an application acknowledgement for consumer readiness, delivered bytes and job completion.