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:server-access

Change PRINCIPAL's native daemon ACL entry; return a COMMAND-OUTCOME. PRINCIPAL is a nonempty literal account name, resolved by the daemon's name service, not a numeric UID/GID. GROUP-P selects a group and requires live tmux 3.8; older daemons signal UNSUPPORTED-CAPABILITY before payload dispatch.

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

Public owner: libtmux

Description#

ACCESS is :ALLOW (add a writable entry), :DENY (remove an entry), :READ-ONLY or :READ-WRITE (update or add). Adding an existing entry and removing an absent one are errors. Root and the daemon-owner UID cannot be changed. :DENY creates no deny rule: from 3.8, a removed user can still match its peer GID's entry. Explicit UID entries take precedence over that GID; supplementary groups are not searched. Cross-user filesystem access must be configured separately.

From 3.8, removal and permission updates recompute every connected client's read-only state. This can clear an unrelated frontend's separate read-only flag when its effective ACL entry is writable. Updates can schedule client disconnection; success does not prove frontend exit. Already scheduled exits are not cancelled by a later grant.

Blocks under shared preflight/dispatch limits, acquires no observation and never retries. Invalid input signals INVALID-ARGUMENT; native errors and uncertain effects retain their outcome. Earlier captures stay unchanged.

See also: libtmux:error-outcome, libtmux:fetch-clients, libtmux:list-server-access, libtmux:refresh.

tmux command#

The tmux commands behind server-access.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss server-access.

Esc

Type to search.

Reference previewOpen reference