Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-lisp latest

libtmux:lock-client

Request locking of captured terminal TARGET; return a COMMAND-OUTCOME. The frontend runs the session's configured lock-command through its shell. Success acknowledges the request, not lock startup, completion or authentication. An already suspended frontend or an empty/oversized lock command can be a no-op. CLIENT must own TARGET. Blocks under shared preflight/dispatch limits; returns no replacement. Stale or foreign targets signal STALE-TARGET; other failures retain their outcome. Preflight cannot exclude client replacement before dispatch. Never retries.

Source and package
Qualified name
libtmux:lock-client
Declared in
libtmux
Package
libtmux
Source
src/client-operations.lisp
(lock-client client target &key cancel-token timeout output-limit)

Public owner: libtmux

tmux command#

The tmux commands behind lock-client.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss lock-client.

Esc

Type to search.

Reference previewOpen reference