Topics
Architecture
Locate operations and field definitions in the library source.
Traversal
Navigate related objects, test membership, and compare identity.
Ownership and cleanup
Manage cleanup on block exit and identify objects that need a kill.
Pane interaction
Choose input modes, capture ranges, and completion waits.
Options and hooks
Configure tmux and register event commands at a supported scope.
Format-token fields
Read typed state and handle absent fields.
Waiting and retrying
Wait on a condition or a named tmux signal.
Environment
Locate objects from process variables and configure new panes.
Socket and servers
Select a server, check liveness, and detect a replacement daemon.
Errors and exceptions
Handle command failures and decide whether a mutation can be retried.
Use these pages for object traversal, cleanup, pane I/O, configuration, and failure handling. Concepts introduces the shared object model.
The concept guides also cover control mode vs one-shot, filtering and queries, and workspaces. Choose a topic for more detailed behavior.
Use your port’s API reference for signatures and defaults. Each topic explains the behavior behind those calls.