Server.server_access
Manage server access control via $ tmux server-access.
Source and package
- Qualified name
-
libtmux.Server .server _access - Module
- libtmux
- Declared in
- Server
- Package
- libtmux
- Source
- src/libtmux/server.py
-
Description#
Requires tmux 3.3+ (introduced in 3.3).
Examples#
>>> from libtmux.common import has_gte_version>>> if has_gte_version("3.3"):... result = server.server_access(list_access=True)... assert isinstance(result, list)- Parameters
-
-
list_access(bool | None) # – List access rules (-lflag). -
read_only(bool | None) # – Force the user to attach read-only (-rflag). Implies allow if the user is not already in the ACL. Mutually exclusive with write — tmux rejects-r -w. -
write(bool | None) # – Allow the user to attach read-write (-wflag). Implies allow if the user is not already in the ACL. Mutually exclusive with read_only.
- Returns
-
list[str] | None Access list when list_access is True, None otherwise.