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

NewPaneRequest

NewPaneRequest configures a floating pane and requires tmux 3.7 or later. Its zero value creates a detached floating pane with tmux's default size, position, styles, and command. Nil pointer fields omit their options; nonnil pointers are explicit, including empty style or message strings. Width and Height must be nonnegative. Empty and Command are mutually exclusive. Unsupported tmux versions return VersionTooLowError rather than omitting fields.

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

Description#

Methods copy pointers and Environment before I/O; concurrent mutation during the copy is unsafe.

Fields15#

NewPaneRequest fields
NameTypeDescription
ActiveBorderStyle *string ActiveBorderStyle sets the active border style; 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.
Empty bool Empty creates a pane without starting a command.
Environment map[string]string Environment is emitted in lexically sorted key order. The map is not retained; nil and an empty map both add no entries.
Height *int Height sets a nonnegative pane height; nil lets tmux choose.
InactiveBorderStyle *string InactiveBorderStyle sets the inactive border style; nil omits it.
Keep bool Keep preserves the pane after its command exits.
Message *string Message sets the pane message; 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; nil omits it.
Width *int Width sets a nonnegative pane width; nil lets tmux choose.
X *int X sets the horizontal position; nil lets tmux choose.
Y *int Y sets the vertical position; nil lets tmux choose.
Zoom bool Zoom preserves the target window's zoomed state.
Esc

Type to search.

Reference previewOpen reference