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

struct libtmux-go latest

SplitPaneRequest

SplitPaneRequest configures tiled pane creation on tmux 3.3a or later. Its zero value creates a detached pane below the exact target with tmux's default size and command. Nil pointer fields omit their options; nonnil pointers are explicit, including empty style or message strings. Size and Percentage are mutually exclusive. Invalid values are rejected before tmux is mutated.

Source and package
Qualified name
tmux.SplitPaneRequest
Package
tmux
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/pane_create.go
struct tmux.SplitPaneRequest

Description#

Methods copy pointer and map values before I/O; concurrent mutation is unsafe. Empty, styles, Message, and Keep require tmux 3.7 and follow UnsupportedPolicy. Empty and Command conflict only when Empty is supported.

Fields15#

SplitPaneRequest fields
NameTypeDescription
ActiveBorderStyle *string ActiveBorderStyle sets the active border style on tmux 3.7 or later; nil omits it.
Attach bool Attach lets the created pane become active in the exact target winlink; false preserves its active pane.
Command string Command starts the pane with this shell command; empty uses tmux's default.
Direction PaneDirection Direction selects the side of the target; zero means below.
Empty bool Empty requests an empty pane on tmux 3.7 or later.
Environment map[string]string Environment is emitted in lexically sorted key order and is not retained; nil and an empty map both add no entries.
FullWindow bool FullWindow lets the new pane span the full window size.
InactiveBorderStyle *string InactiveBorderStyle sets the inactive border style on tmux 3.7 or later; nil omits it.
Keep bool Keep preserves the pane after its command exits on tmux 3.7 or later.
Message *string Message sets the pane message on tmux 3.7 or later; nil omits it.
Percentage *int Percentage selects a size from 0 through 100; nil omits it. It is sent as tmux's "-l N%", which every supported version accepts; the older -p spelling is rejected by tmux 3.4.
Size *int Size selects a nonnegative absolute pane size; nil omits it.
StartDirectory string StartDirectory expands ~ and ~/... for the current user. Named-user forms such as ~other are rejected; empty inherits tmux's default. A directory that does not exist is not an error: tmux starts the process in the home directory instead, or in / without one.
Style *string Style sets the pane style on tmux 3.7 or later; nil omits it.
Zoom bool Zoom preserves the window's zoomed state after the split.
Esc

Type to search.

Reference previewOpen reference