Documentation
¶
Overview ¶
Package multiplexer defines implementation-neutral terminal multiplexer values.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AttachStreams ¶
AttachStreams are connected directly to an interactive multiplexer client.
type CaptureOptions ¶
CaptureOptions controls pane capture behavior.
type LaunchResult ¶ added in v0.63.0
LaunchResult describes a session open or launch. Completed is true only when every pane completed successfully and the launch left no terminal to attach to.
type NamedKey ¶
type NamedKey string
NamedKey is one tmux named-key token.
func NewNamedKey ¶
NewNamedKey validates a named key for safe argv transport.
type Pane ¶
type Pane struct {
// Target is the session:window.pane address at discovery time. Window and
// pane indexes can shift when neighbours close, so it is not stable.
Target Target
// NativeID is the multiplexer's own stable pane identifier (tmux %N). It
// survives window and pane renumbering, unlike Target.
NativeID string
// PID is the process ID of the pane's root process (usually the shell).
PID int64
// WindowName is the display name of the window that holds the pane.
WindowName string
// Title is the pane title, which agents often set to their own name.
Title string
// WorkingDirectory is the current directory of the pane's root process.
WorkingDirectory string
// Activity is the Unix timestamp of the last output in the pane's window.
Activity int64
// HiveSession is the Hive slug tagged on the pane when Hive created it
// (tmux @hive-session). It lets Hive find a session after a user renames
// the multiplexer session.
HiveSession string
// InMode reports whether the pane is in copy or view mode, so its visible
// content is scrollback rather than live output.
InMode bool
}
Pane describes a discovered multiplexer pane.
type PaneSpec ¶
type PaneSpec struct {
Command string
WorkingDirectory string
Size string
Split SplitDirection
}
PaneSpec is a fully rendered pane definition.
type PasteOptions ¶
type PasteOptions struct {
Bracketed bool
}
PasteOptions controls buffer paste behavior.
type SessionSpec ¶
type SessionSpec struct {
Target Target
WorkingDirectory string
Windows []WindowSpec
Background bool
}
SessionSpec describes a session and its initial windows.
type SplitDirection ¶
type SplitDirection string
SplitDirection controls the orientation of a pane split.
const ( SplitVertical SplitDirection = "vertical" SplitHorizontal SplitDirection = "horizontal" )
type Target ¶
Target identifies a session, window, or pane. A pane target can contain only Pane when the multiplexer supplied a stable native pane identifier.
func (Target) ValidatePane ¶
ValidatePane validates a qualified or stable native pane target.
func (Target) ValidateSession ¶
ValidateSession validates a session target.
func (Target) ValidateWindow ¶
ValidateWindow validates a qualified window target.