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.

struct libtmux-go latest

ServerOptions

ServerOptions configures a harness-owned tmux.Server. All inputs are copied before filesystem or process operations, so callers retain ownership.

Source and package
Qualified name
tmuxtest.ServerOptions
Package
tmuxtest
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/tmuxtest/harness.go
struct tmuxtest.ServerOptions

Fields5#

ServerOptions fields
NameTypeDescription
Binary string Binary is the tmux executable. An empty value resolves tmux from PATH.
Config []byte Config is appended to the harness-owned config file; it cannot replace the private file that prevents user configuration from loading.
FixedShell bool FixedShell gives panes without an explicit command a POSIX shell with no startup files and the prompt ShellPrompt. RunInPane sets it; the default preserves tmux process behavior for tests that need it.
InitialSession *tmux.NewSessionRequest InitialSession starts the daemon with this copied request. Nil returns a lazy bare server; a later tmux command may start it.
ProcessEnvironment []string ProcessEnvironment supplies the server environment. Nil snapshots the current process environment, while a non-nil empty slice remains empty. TMUX, TMUX_PANE, and every LIBTMUX_SOCKET* variable are removed in either case. TMUX_TMPDIR is kept.
Esc

Type to search.

Reference previewOpen reference