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-session

Request locking of SESSION's attached frontends; return a COMMAND-OUTCOME. CLIENT must own the captured SESSION. The live session membership determines which frontends receive the request. Each runs its configured lock-command; control clients, suspended frontends and empty/oversized commands are skipped. Success acknowledges the request, not startup, completion or authentication. Blocks under shared preflight/dispatch limits and returns no replacement. Foreign or vanished sessions signal STALE-TARGET; other failures retain their outcome. Lock programs belong to the frontends; closing CLIENT leaves them running. Never retries.

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

Public owner: libtmux

tmux command#

The tmux commands behind lock-session.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss lock-session.

Esc

Type to search.

Reference previewOpen reference