# API reference

Source: https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/

> Types, methods, and functions in libtmux for Ruby.

Browse the Ruby types and operations for working with tmux. Start with the core objects below, or search for a type or member.

Server 1 type

[Server](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-server/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 39 members

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

Session 2 types

[Session](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-session-nvps/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 21 members

[SessionWhere](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-sessionwhere/) [module](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#module) 1 member

Window 4 types

[Window](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-window-1vfx/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 18 members

[WindowLink](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-windowlink-tusj/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 19 members

[WindowLinkWhere](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-windowlinkwhere/) [module](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#module) 1 member

[WindowWhere](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-windowwhere/) [module](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#module) 1 member

Pane 2 types

[Pane](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-pane-14z6/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 27 members

[PaneWhere](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-panewhere/) [module](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#module) 1 member

Client 1 type

[ClientWhere](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-clientwhere/) [module](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#module) 1 member

Hooks 1 type

[Hooks](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-hooks/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 5 members

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

Options 1 type

[OptionValue](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-optionvalue/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 7 members

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

Commands 3 types

[Cancellation](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-cancellation/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 5 members

[CreationReceipt](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-creationreceipt/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 5 members

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

[Endpoint](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-endpoint-s6cs/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

Explicit executable and socket selection. Construction starts no clients.

Control mode 4 types

[ControlConnection](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-controlconnection/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 15 members

[ControlSubscription](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-controlsubscription/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[GuardedBlock](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-guardedblock/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[GuardedReply](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-guardedreply/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 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](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-filterexpr-1wz0/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 13 members

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

Snapshots 8 types

[CapturedRecord](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-capturedrecord-18ay/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 7 members

[ClientSnapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-clientsnapshot-w08e/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 21 members

[PaneSnapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-panesnapshot-43mz/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 22 members

[Selection](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-selection/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 14 members

Replayable captured membership. Snapshot construction owns record values.

[SessionSnapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-sessionsnapshot-xllu/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 16 members

[Snapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-snapshot/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 14 members

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

[WindowLinkSnapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-windowlinksnapshot-vzc2/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 14 members

[WindowSnapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-windowsnapshot-19c3/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 16 members

Errors 18 types

[Cancelled](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-cancelled/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[CapacityError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-capacityerror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[ClosedError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-closederror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[CommandError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-commanderror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 9 members

[DeadlineExceeded](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-deadlineexceeded/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[Error](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-error/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[FieldDecodeError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-fielddecodeerror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[IncompleteSnapshotError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-incompletesnapshoterror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[InconsistentSnapshotError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-inconsistentsnapshoterror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[InvalidFilterError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-invalidfiltererror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[MultipleMatchesError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-multiplematcheserror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[NoMatchError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-nomatcherror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[OutcomeUnknown](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-outcomeunknown/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[ProtocolError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-protocolerror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[SubscriptionOverflow](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-subscriptionoverflow/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 9 members

[TargetNotFoundError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-targetnotfounderror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[TransportError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-transporterror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

[UnsupportedFeatureError](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-unsupportedfeatureerror/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 8 members

Constants and enums 5 types

[CommandResult](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-commandresult/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 11 members

[ControlEvent](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-controlevent/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 13 members

[GroupResult](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-groupresult/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 5 members

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

[Options](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-options/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 4 members

Explicit acquisition and mutation at one option scope.

[TerminalResult](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-terminalresult/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 6 members

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

Async 1 type

[Async](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-async/) [module](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#module) 6 members

Other 3 types

[Entity](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-entity-bg78/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 12 members

[EntityRef](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-entityref-162n/) [class](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#class) 9 members

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

[Support](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-support/) [module](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/glossary/#module) 3 members

Here "support" means which tmux releases libtmux supports, not helper code. Every server handle checks its daemon's release before any command runs; this module exposes that check.