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

RunOptions

RunOptions configures Session.Run and Session.Start. Its zero value runs the command in a window tmux names, in the session's default directory and environment, and removes that window once the command has finished.

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

Fields4#

RunOptions fields
NameTypeDescription
Environment map[string]string Environment is added to the command's environment. The map is not retained.
Keep bool Keep leaves the finished window in place, showing what the command printed, instead of removing it.
StartDirectory string StartDirectory expands ~ and ~/... for the current user; empty inherits the session's default. A directory that does not exist is not an error: tmux starts the process in the home directory instead, or in / without one.
WindowName string WindowName names the window the command runs in; empty lets tmux choose.
Esc

Type to search.

Reference previewOpen reference