Java API

class libtmux-java latest

ServerConfig

What a server needs to know before it runs anything: which tmux, which server, which config.

Source and package

class io.github.libtmux.ServerConfig class readonly [source] ¶: Description#

Deliberately a builder-built class rather than a record. tmux keeps growing flags, and a record's canonical constructor is public API: every field added later would break both source and binary compatibility for anyone who had constructed one.
Nothing here contacts tmux. A config can be built, stored and compared on a machine that has no tmux installed. The one thing it reads is the process environment, once, when a config with no endpoint is built: see Builder#endpoint().

Members12#

binary method The tmux executable, resolved on PATH unless it is an absolute path.
binaryPath method The binary as a path, resolved the way this process resolves it.
builder method A builder holding the documented defaults.
Builder class Collects the choices; #build() checks them.
configFile method The config file tmux should read, if the caller pinned one.
defaultTimeout method How long a request waits when the caller does not say.
endpoint method Which tmux server to talk to, as chosen when this config was built.
endpointCommand method The argv prefix every command on this server begins with: the binary, -u, optional color flag, the server selection, and the config file if one was pinned.
force256Colors method Whether tmux clients advertise 256-color support regardless of terminal detection.
maxConcurrentCommands method How many tmux commands Server#open() lets run at once; more wait their turn.
observer method Where each command's report goes. OperationObserver#NONE until a caller sets one.
toBuilder method A builder holding every choice this config made.

Pages that discuss ServerConfig.