Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

1191 symbols, extracted from source. Every type name in a signature links to its own entry; every cross-reference in a doc comment resolves against the same table.

Server 4 types
ServerGeneration 3 members

Identifies one tmux daemon generation.

PsmuxServer 7 members

Reads one isolated, single-session psmux namespace.

Server 67 members

Represents an immutable server handle and snapshot.

OwnedServerScope 2 members

Owns a server and stops it when disposed.

Session 5 types
PsmuxSession 6 members

An immutable observation of the sole psmux session.

Session 37 members

Represents an immutable session handle and snapshot.

OwnedSessionScope 2 members

Owns a session and stops it when disposed.

OwnedWindowScope 2 members

Owns a window and stops it when disposed.

SessionId 6 members

Represents a generation-independent tmux session identifier.

Window 5 types
WindowDirection 2 members

Defines relative window placement.

PsmuxWindow 8 members

An immutable observation of one psmux window.

Window 46 members

Represents an immutable window handle and snapshot.

WindowRotationDirection 2 members

Names which way a window's panes rotate.

WindowId 6 members

Represents a generation-independent tmux window identifier.

Pane 5 types
PaneDirection 4 members

Defines pane placement directions.

Pane 57 members

Represents an immutable pane handle and snapshot.

PaneId 6 members

Represents a generation-independent tmux pane identifier.

PsmuxPane 9 members

An immutable observation of one psmux pane.

PaneReadiness 3 members

Controls whether workspace panes wait for a prompt-like state.

Client 2 types
Client 15 members

Identifies a client and resolves what it is looking at.

ClientAttachment 0 members

What one client is looking at.

Hooks 3 types
TmuxHookEntry 3 members

One command a hook runs, and where it sits in the order.

TmuxHook 3 members

One hook and every command it runs.

TmuxHooks 6 members

The hooks of one server, session, window, or pane.

Options 4 types
OptionScope 4 members

Defines tmux option scopes.

TmuxOptionState 4 members

What tmux reported for an option.

TmuxOptionValue 5 members

One option value as tmux reported it.

TmuxOption 5 members

One option, with its array index when tmux gave it one.

Keys and bindings 1 type
TmuxKeys 3 members

The key bindings of one server.

Buffers 2 types
TmuxBuffers 7 members

The paste buffers of one server.

TmuxBuffer 4 members

One tmux paste buffer.

Layout and geometry 1 type
ResizeDirection 4 members

Defines pane resize directions.

Environment 2 types
TmuxEnvironmentEntry 4 members

One variable in a tmux environment.

TmuxEnvironment 5 members

The environment tmux gives to the processes it spawns.

Versions 1 type
TmuxVersion 22 members

Represents one lossless parsed tmux version.

Commands 4 types
TmuxCommand 9 members

One tmux command and the arguments it carries.

TmuxDispatchState 3 members

Says whether a failed command reached tmux, which is what decides if retrying is safe.

TmuxInvocation 2 members

One tmux invocation, as a TmuxInterceptor sees it.

TmuxWait 1 members

Waits for tmux to reach a state instead of sleeping.

Control mode 3 types
ControlModeSubscriptions 1 members

Subscribes a control client to a format changing.

IControlModeSession 3 members

A live tmux control client.

PaneObservation 1 members

Narrows a control client's event stream to one pane, and ends it cleanly.

Queries 7 types
UnsafeTmuxFilter 0 members

A tmux filter expression passed through without translation.

QueryEdgeParser 1 members

Parses the one legacy lookup spelling this port still carries.

QueryDocument 4 members

One translated query predicate and its wire schema.

QueryExtensions 3 members

Translates, compiles, and applies declarative query predicates.

QueryTarget 4 members

Names the tmux object a field or quantifier reads.

QueryJsonLimits 1 members

Bounds one JSON document so parsing cannot be weaponised.

QueryJson 2 members

Serializes query documents to the stable v1 wire form.

Snapshots 5 types
CapturedRelation 6 members

Holds the children a snapshot captured for one relation.

CapturedValue 6 members

Holds the one child a snapshot captured for a relation, if it read it.

SessionWindowEdge 5 members

Places one window at one index inside one session.

SnapshotDepth 4 members

Names how far down the tmux hierarchy a snapshot captured.

WindowEntityKey 1 members

Identifies one window linked into one session.

Requests 31 types
ITmuxRequest 1 members

A request that becomes one tmux command against a target.

BindKeyRequest 7 members

Describes one bind-key invocation.

ChooseTreeSort 4 members

Names how a chooser orders its rows.

ChooseTreeRequest 8 members

Describes one choose-tree invocation.

PromptType 4 members

What a command prompt is asking for.

CommandPromptRequest 15 members

Describes one command-prompt invocation.

ConfirmBeforeRequest 7 members

Describes one confirm-before invocation.

CopyModeRequest 7 members

Describes one copy-mode invocation.

DisplayMenuRequest 15 members

Describes one display-menu invocation.

DisplayMessageRequest 11 members

Describes one display-message invocation.

PopupCloseMode 2 members

Names when a popup closes on its own.

DisplayPopupRequest 18 members

Describes one display-popup invocation.

GetOptionRequest 8 members

Describes one show-options invocation for a single option.

GetOptionsRequest 6 members

Describes one show-options invocation for every option in a scope.

HookRequest 4 members

Describes one hook to read, run, or unset.

IfShellRequest 7 members

Describes one if-shell invocation.

ListBuffersRequest 3 members

Describes one list-buffers invocation.

ListHooksRequest 3 members

Describes one show-hooks invocation.

PasteBufferRequest 7 members

Describes one paste-buffer invocation.

RespawnRequest 5 members

Describes one respawn-window or respawn-pane invocation.

RunShellRequest 10 members

Describes one run-shell invocation.

SelectLayoutMode 3 members

Names a layout change that needs no layout string.

SelectLayoutRequest 3 members

Describes one select-layout invocation.

SendKeysRequest 12 members

Describes one send-keys invocation.

SetHookRequest 9 members

Describes one set-hook invocation.

SetHooksRequest 6 members

Describes setting several entries of one hook at once.

SetOptionRequest 10 members

Describes one set-option invocation.

UnbindKeyRequest 5 members

Describes one unbind-key invocation.

UnsetOptionRequest 7 members

Describes one set-option -u invocation.

TmuxWaitMode 4 members

What to do with a wait-for channel.

WaitForRequest 4 members

Describes one wait-for invocation.

Requests — Server 1 type
ServerAccessRequest 6 members

Describes one server-access invocation.

Requests — Session 2 types
AttachSessionRequest 6 members

Describes one attach-session invocation.

NewSessionRequest 13 members

Describes one new-session invocation.

Requests — Window 6 types
FindWindowRequest 8 members

Describes one find-window invocation.

LinkWindowRequest 7 members

Describes one link-window invocation.

MoveWindowRequest 7 members

Describes one move-window invocation.

NewWindowRequest 11 members

Describes one new-window invocation.

WindowResizeMode 2 members

Names how a window is resized against its clients.

ResizeWindowRequest 6 members

Describes one resize-window invocation.

Requests — Pane 11 types
CapturePanePosition 4 members

Names one end of a capture range.

CapturePaneRequest 15 members

Describes one capture-pane invocation.

MovePaneRequest 8 members

Describes one move-pane or join-pane invocation.

NewPaneRequest 17 members

Describes one new-pane invocation.

PipePaneRequest 5 members

Describes one pipe-pane invocation.

ResizePaneRequest 8 members

Describes one resize-pane invocation.

PaneSelectDirection 5 members

Names which pane a selection moves to.

SelectPaneRequest 6 members

Describes one select-pane invocation.

SplitPaneRequest 17 members

Describes one split-window invocation.

PaneSwapDirection 2 members

Names which neighbouring pane a swap uses.

SwapPaneRequest 5 members

Describes one swap-pane invocation.

Errors 16 types
ControlModeCommandException 4 members

Reports a command rejected by a live tmux control client.

IncompleteSnapshotException 3 members

Thrown when a snapshot never captured the requested relation.

LibTmuxException 2 members

Provides the base exception for remote tmux failures.

TmuxCleanupException 4 members

Reports a failure to clean up a canceled tmux client.

TmuxCommandException 2 members

Reports a command-policy failure.

TmuxCommandNotFoundException 2 members

Reports a missing tmux executable.

TmuxObjectNotFoundException 2 members

Reports a missing tmux object.

TmuxOperationCanceledException 3 members

Reports cancellation after a tmux client started.

TmuxOptionException 2 members

Thrown when tmux refuses an option name or value.

TmuxProtocolException 2 members

Reports an answer from tmux this library could not read.

TmuxTransportException 2 members

Reports a process-transport failure.

TmuxVersionTooLowException 3 members

Reports an unsupported tmux version.

TmuxWaitTimeoutException 2 members

Reports an expired bounded wait.

UnsupportedQueryExpressionException 2 members

Thrown when an expression cannot be translated to a query.

WorkspaceBuildException 2 members

Reports a workspace failure and the tmux state created before it.

WorkspaceFormatException 1 members

Thrown when a workspace file cannot be read.

Errors — Server 1 type
StaleServerGenerationException 3 members

Reports a stale server generation.

Errors — Session 1 type
TmuxSessionExistsException 2 members

Thrown when a session name is already taken.

Errors — Window 1 type
TmuxWindowException 2 members

Thrown when a window operation is refused before tmux sees it.

Errors — Pane 1 type
TmuxPaneException 2 members

Thrown when a pane operation is refused before tmux sees it.

Constants and enums 12 types
TmuxEvent 0 members

One thing a tmux control client reported without being asked.

TmuxOutputEvent 0 members

Bytes a pane wrote.

TmuxNotificationEvent 0 members

A notification this library does not parse further.

TmuxEventsDroppedEvent 0 members

Reports notifications discarded because the bounded event buffer was full.

TmuxExitEvent 0 members

The control client ended.

TmuxOptions 5 members

The options of one server, session, window, or pane.

PsmuxCaptureOptions 5 members

Chooses the psmux pane text that can be captured safely.

PsmuxConnectionOptions 6 members

Configures the bounded psmux query preview.

ShowMessagesMode 3 members

What show-messages should list.

TmuxColorMode 3 members

Defines the tmux client color mode.

TmuxCommandResult 9 members

Contains the inspectable result of one raw tmux command.

WorkspaceResult 7 members

Describes workspace state materialized by a build.

Constants and enums — Server 1 type
ServerConnectionOptions 14 members

Configures a tmux server connection without mutating process-wide state.

Constants and enums — Pane 2 types
TmuxPaneGoneEvent 0 members

The pane a stream was watching left its window's arrangement.

PaneInputMode 2 members

Names whether a pane accepts input.

Testing utilities 9 types
TemporaryHierarchyScope 5 members

A server, session, window, and pane a test owns together.

TemporaryServerScope 2 members

Creates a throwaway server for a test and stops it afterwards.

TemporarySessionScope 2 members

Owns a throwaway session and any private server created with it.

TemporaryWindowScope 2 members

Owns a throwaway window and any private session and server created with it.

TestEnvironment 5 members

The directory and variables a test's tmux runs with.

TmuxNameGenerator 5 members

Makes names no other test is using.

TmuxTestContext 3 members

A tmux server a test owns, and the environment it runs in.

TmuxTestFactory 6 members

Makes the tmux objects a test needs, each owning its own cleanup.

TmuxTestOptions 6 members

How a test's tmux is reached and how long it is waited on.

Other 6 types
TmuxChain 3 members

Commands tmux runs together, in one process.

TmuxChaining 4 members

Runs a request on its own, as a chain of one command.

LibTmuxInfo 3 members

Reports package identity and supported tmux range.

TmuxDiagnostics 0 members

Names the diagnostic sources this library publishes.

TmuxMenuItem 4 members

One line of a tmux menu.

TmuxWaitChannel 4 members

An open wait on a tmux wait-for channel.

By module 7 modules

Esc

Type to search.