tmux.ServerOptions

struct tmux.ServerOptions

struct [source] ¶

struct [source] ¶

struct tmux.ServerOptions

ServerOptions configures a Server without starting tmux. NewServer snapshots the effective environment, working directory, and executable; callers retain ownership of every supplied value.

Members

• Binary attribute Binary is the tmux executable name or path. Empty resolves tmux once through the snapshotted PATH. Relative paths resolve against the constructor's working directory. The resolved absolute path is shared by subprocess and control-mode transports.
• Colors attribute Colors overrides tmux's terminal color capability.
• ConfigFile attribute ConfigFile selects an exact tmux configuration file. Empty lets tmux read its default configuration, so a program inherits whatever the user running it has configured: a base-index other than zero, a prompt that appears in captured pane text, hooks that fire on the sessions this program creates. Point it at a file the program owns, which may be an empty one, when the tmux it drives should not depend on that.
• ProcessEnvironment attribute ProcessEnvironment replaces the child process environment. Nil snapshots the current process environment. A non-nil empty slice supplies no caller-provided variables. Execution may add variables required by Go's target platform and a canonical TMUX_TMPDIR that freezes named or default socket selection. Duplicate names retain their last value. Entries containing NUL are rejected except on Plan 9, where NUL separates path-list elements. NewServer clones the slice.
• SocketName attribute SocketName selects tmux's named socket. SocketPath takes precedence.
• SocketPath attribute SocketPath selects an explicit tmux socket path.
• Unsupported attribute Unsupported selects what happens when a request needs an optional tmux capability the running server does not have. The zero value refuses the request; see UnsupportedPolicy.
• WarningHandler attribute WarningHandler receives nonfatal compatibility warnings. Nil discards warnings. See WarningHandler for delivery and concurrency semantics.