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.

Go API

struct libtmux-go latest

AttachSessionOptions

AttachSessionOptions configures terminal ownership and attach behavior shared by server- and session-scoped attachment. Nil StartDirectory omits its flag and a nonnil empty string is explicit; ClientFlags is copied. The Stdin, Stdout, and Stderr pointers are retained for the attach call and are never owned or closed by this package.

Source and package
Qualified name
tmux.AttachSessionOptions
Package
tmux
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/server_attach.go
struct tmux.AttachSessionOptions

Fields9#

AttachSessionOptions fields
NameTypeDescription
ClientFlags []string ClientFlags are comma-joined client flags copied before attachment starts.
DetachOthers bool DetachOthers disconnects other clients attached to the target session.
DetachParent bool DetachParent detaches the invoking client from its parent session first.
NoUpdateEnvironment bool NoUpdateEnvironment preserves the invoking client's environment.
ReadOnly bool ReadOnly attaches the client with read-only permissions.
StartDirectory *string StartDirectory selects the attached client's initial directory.
Stderr *os.File Stderr is the attached tmux client's error stream; nil inherits process stderr.
Stdin *os.File Stdin is the attached tmux client's input stream; nil inherits process stdin.
Stdout *os.File Stdout is the attached tmux client's output stream; nil inherits process stdout.
Esc

Type to search.

Reference previewOpen reference