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

wait_for_channel

Change tmux state; no client-supplied executable input. Block until something signals a tmux wait-for channel with ‘tmux wait-for -S ’. Use when you composed a shell command that signals it. For an ordinary command whose completion you want, run_shell_command already does this and also reports the exit status.

All .NET tools · JSON · Source

Arguments

channel required · string
The tmux wait-for channel.
timeoutSeconds optional · number | null
Requested timeout in seconds.

Default: null.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"channel": {
"description": "The tmux wait-for channel.",
"type": "string"
},
"timeoutSeconds": {
"default": null,
"description": "Requested timeout in seconds.",
"type": [
"number",
"null"
]
}
},
"required": [
"channel"
],
"type": "object"
}
Output schema
{
"properties": {
"changed": {
"type": "string"
},
"channel": {
"type": "string"
},
"effectiveTimeoutSeconds": {
"type": "number"
},
"elapsedSeconds": {
"type": "number"
},
"signalled": {
"type": "boolean"
}
},
"required": [
"changed",
"channel",
"signalled",
"elapsedSeconds",
"effectiveTimeoutSeconds"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Wait for channel"
}
Esc

Type to search.