server.ServerOptions

interface server.ServerOptions

interface [source] ¶

interface [source] ¶

interface server.ServerOptions

How to reach a tmux server, and what to assume when it is quiet.

Every field is optional and every default is tmux's own, except ServerOptions.environment , which replaces the process environment rather than extending it. socketName and socketPath name the same thing two ways and are mutually exclusive.

Members

• onInvocation property Called once per tmux invocation, after it answers or fails.
• colors property
• configFile property
• engine property Run this server's commands somewhere other than a local tmux.
• environment property The complete environment passed to every spawned tmux process.
• maxInFlight property How many tmux invocations this server runs at once. Defaults to 16.
• socketName property
• socketPath property
• timeoutMs property Default deadline, in milliseconds, for every command this server runs: 30 seconds unless set. null removes it, so commands wait as long as tmux takes.
• tmuxBin property