io.github.libtmux.ServerConfig.ServerConfig

class io.github.libtmux.ServerConfig.ServerConfig

classreadonly [source] ¶

classreadonly [source] ¶

class io.github.libtmux.ServerConfig.ServerConfig

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

<p>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.

<p>Nothing here contacts tmux. A config can be built, stored and compared on a machine that has no tmux installed.

Members

• Builder class Collects the choices; #build() checks them.
• 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.
• 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.
• endpointCommand method The argv prefix every command on this server begins with: the binary, the server selection, and the config file if one was pinned.
• toBuilder method A builder holding every choice this config made.