API reference
Browse the F# types and operations for working with tmux. Start with the core objects below, or search for a type or member.
Server 1 type
Starts server reads and queries with the caller's cancellation token.
Session 2 types
Starts queries confined to one session.
Describes a session and its windows, for <c>Server.newSession</c>.
Window 3 types
Identifies window placements and starts queries confined to one window.
Identifies one indexed placement of a window within a server generation.
Describes a window: its first pane, then each pane split off the one before.
Pane 4 types
Reads captured pane fields and starts explicit pane operations.
Recognises how a command run with <c>Pane.run</c> ended.
Recognises how a wait on a pane's output ended.
Recognises what a pane watch yields.
Layout and geometry 2 types
How much of the space split a new pane takes.
Describes a pane split off the pane created before it.
Commands 2 types
Runs an operation again only when tmux never saw it.
Builds commands tmux runs together, each acting on what the one before made.
Control mode 3 types
Represents a decision to continue or stop an event fold.
Opens control clients and reads their event streams.
Follows a server's sessions, windows, panes and clients as tmux announces changes.
Queries 5 types
Selects values from ordinary F# sequences.
Describes a validated portable predicate over one entity type.
Identifies a supported captured relation between two entity types.
Describes text tmux searches for on a pane's visible rows.
Describes a tmux listing: a scope, filters and text panes must show.
Queries — Fields 5 types
Identifies a supported scalar field and its query constant type.
Provides supported session fields and relations for portable filters.
Provides supported window fields and relations for portable filters.
Provides supported pane fields for portable filters.
Provides supported client fields for portable filters.
Snapshots 2 types
Distinguishes captured state from a relation the snapshot did not read.
Reads captured values without contacting tmux.
Errors 2 types
Describes a selection that does not contain exactly one match.
Recognises tmux failures by whether running the operation again could repeat what it did.
Constants and enums 1 type
Reads and writes options through keys that know their value's type.
Async 1 type
Awaits tasks in an <c>async</c> workflow without losing whether tmux may have acted.