Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-java latest

ServerEndpoint.fromEnvironment

The server an environment names, or tmux's own default when it names none.

Source and package
Qualified name
io.github.libtmux.ServerEndpoint.fromEnvironment
Package
io.github.libtmux
Declared in
ServerEndpoint
Distribution
io.github.libtmux:libtmux
Source
libtmux/src/main/java/io/github/libtmux/ServerEndpoint.java

Description#

LIBTMUX_SOCKET_PATH names a socket path and selects it with -S; LIBTMUX_SOCKET names a socket and selects it with -L. When both are set the path wins, as it does in the Python libtmux and in tmux itself, which ignores -L beside -S. A variable that is empty or blank counts as unset, each one on its own. With neither set the result is #defaultSocket().

TMUX is never read. tmux follows it by itself when no socket is selected, and TmuxEnvironment#config() is the way to ask for that server by path.

Parameters
Raises
  • IllegalArgumentException – if LIBTMUX_SOCKET holds a path separator; the message names the variable and leaves its value out

Esc

Type to search.

Reference previewOpen reference