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

Block until something signals a tmux wait-for channel. A pending signal is consumed. Pair this with a shell command that ends in tmux wait-for -S <channel> to synchronise with work this server did not start. Change tmux state; no client-supplied executable input.

All Rust tools · JSON · Source

Arguments

channel required · string
The channel name, which is any string both sides agree on.
seconds optional · integer | null
How long to wait, in seconds. Defaults to 30, capped at 600.

Schemas

The schema defines required fields, nested values, defaults, and validation constraints.

Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"channel": {
"description": "The channel name, which is any string both sides agree on.",
"type": "string"
},
"seconds": {
"description": "How long to wait, in seconds. Defaults to 30, capped at 600.",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"channel"
],
"type": "object"
}
Output schema
{
"$defs": {
"ChannelWaitOutcomeSchema": {
"enum": [
"signalled",
"deadline"
],
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"channel": {
"description": "The channel that was waited on.",
"type": "string"
},
"outcome": {
"$ref": "#/$defs/ChannelWaitOutcomeSchema",
"description": "`signalled` or `deadline`."
}
},
"required": [
"channel",
"outcome"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": false,
"readOnlyHint": false,
"title": "Wait For Channel"
}
Esc

Type to search.