from_env

env = ENV #

Mapping used to read TMUX. The value must contain a socket path, process ID, and session index separated by commas. An absent or empty value selects the named default socket; a malformed value raises ArgumentError . Explicit socket selectors bypass this lookup.

socket_path = nothing #

Path to a tmux socket. When supplied, select this endpoint instead of reading env; relative paths become absolute against the current directory. Supply either socket_path or socket_name , never both. An empty path or a path containing NUL raises ArgumentError .

socket_name = nothing #

Name of a tmux socket, used as tmux's -L selector. When supplied, select this endpoint instead of reading env. The name must be nonempty and contain neither a slash nor NUL. Supply either socket_name or socket_path, never both.

tmux = "tmux" #

Executable name or path for later operations on the returned server. A bare name is resolved through PATH when an operation runs. This call checks that the value is a nonempty string without NUL; it does not check whether the executable or socket exists.