Skip to content

Commit 6fc1ca7

Browse files
committed
Docs(control): document client flags, flow, subscriptions
why: Expose new control-mode helper surface to users with tmux 3.2+ guidance. what: - Add runtime client flag section covering !flag semantics and pause-after - Describe set_pane_flow resume helper - Document subscribe helper and supported scopes
1 parent 40f5c34 commit 6fc1ca7

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/topics/control_mode.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,25 @@ print(server.list_sessions()) # legacy behavior
149149
- Notifications are queued; drops are counted when consumers fall behind.
150150
- Timeouts raise ``ControlModeTimeout`` and restart the control client.
151151

152+
## Runtime client flags
153+
154+
- Use :meth:`ControlModeEngine.set_client_flags` to toggle tmux's control
155+
client flags at runtime (``no-output``, ``pause-after``, ``wait-exit``, and
156+
general client flags like ``read-only`` and ``ignore-size``). Passing
157+
``False`` clears a flag using tmux's ``!flag`` syntax; ``pause_after=0`` also
158+
clears pause-after.
159+
- Per-pane flow control can be adjusted with
160+
:meth:`ControlModeEngine.set_pane_flow`, which wraps ``refresh-client -A``.
161+
Call ``set_pane_flow(pane_id, state="continue")`` to resume a paused pane.
162+
163+
## Subscriptions
164+
165+
- :meth:`ControlModeEngine.subscribe` wraps ``refresh-client -B`` to add or
166+
remove control-mode subscriptions. Provide a ``name``, optional ``what``
167+
scope (``%1``, ``@2``, ``%*``, ``@*``, or empty for the attached session),
168+
and a ``format`` string. Pass ``format=None`` to remove a subscription by
169+
name.
170+
152171
## Errors, timeouts, and retries
153172

154173
- ``ControlModeTimeout`` — command block did not finish before

0 commit comments

Comments
 (0)