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 below for more detailed behavior:
- Architecture: locate operations and field definitions in each port’s source.
- Traversal: navigate related objects, test membership, and compare identity.
- Context managers: manage cleanup on block exit and identify objects that need an explicit 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 fields absent from a scope, version, or capture.
- Waiting and retrying: wait on a condition or a named tmux signal.
- Environment: locate objects from process variables and configure values inherited by new panes.
- Socket and servers: select a server, check liveness, and detect a replacement daemon.
- Errors and exceptions: handle command failures and determine whether a mutation can be retried.
Use your port’s API reference for signatures and defaults. These pages call out differences that affect how you use the APIs.