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

765 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 1 type
Server 38 members

Connects to an existing endpoint. Closing retires clients, never the daemon.

Session 1 type, 1 function or constant
SessionWhere
modulelibtmux [source]
modulelibtmux [source]
SessionWhere
Window 2 types, 2 functions and constants
WindowLinkWhere
modulelibtmux [source]
modulelibtmux [source]
WindowLinkWhere
WindowWhere
modulelibtmux [source]
modulelibtmux [source]
WindowWhere
Pane 1 type, 1 function or constant
PaneWhere
modulelibtmux [source]
modulelibtmux [source]
PaneWhere
Client 1 function or constant
ClientWhere
modulelibtmux [source]
modulelibtmux [source]
ClientWhere
Hooks 1 type
Hooks 5 members

Hook values are executable tmux command strings, never literal data.

Options 1 type
OptionValue 7 members

Raw bytes remain available even when a caller requests a typed conversion.

Commands 3 types
CreationReceipt 5 members

IDs printed by the creation command itself, before later topology changes. A receipt proves creation, not continued ownership or current membership.

Endpoint 8 members

Explicit executable and socket selection. Construction starts no clients.

Control mode 4 types
GuardedReply 7 members

Blocks observed between private boundaries may include hooks. They do not establish command ownership, final status, or completion of delayed effects.

Queries — Expressions 1 type
FilterExpr 13 members

A schema-validated predicate over captured records; evaluation performs no I/O.

Snapshots 8 types
Selection 14 members

Replayable captured membership. Snapshot construction owns record values.

Snapshot 14 members

A validated graph observed over an interval, with no transport reference.

Errors 18 types
Constants and enums 5 types
GroupResult 5 members

Final client status cannot attribute a merged group result to individual steps.

Options 4 members

Explicit acquisition and mutation at one option scope.

TerminalResult 6 members

Terminal bytes go directly to the caller's TTY and are not captured.

Async 1 function or constant
Async
modulelibtmux-async [source]
modulelibtmux-async [source]
Async
Other 2 types
EntityRef 9 members

A target belongs to one open server binding; names never identify it.

Esc

Type to search.