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

RunShellRequest

RunShellRequest configures a command executed by tmux's run-shell command. Its zero value is invalid because Command is required. Pointer fields distinguish omitted flags from explicit empty arguments; RunShell copies Delay, StartDirectory, and Args before invoking tmux.

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

Fields8#

RunShellRequest fields
NameTypeDescription
Args []string Args are extra job arguments copied before tmux runs. They require tmux 3.7; see UnsupportedPolicy.
AsTmuxCommand bool AsTmuxCommand asks tmux to interpret Command as tmux command syntax.
Background bool Background returns after tmux accepts the job instead of waiting for stdout.
Command string Command is the required shell or tmux command to run.
Delay *string Delay supplies run-shell's optional delay; nil omits it and an empty value is explicit.
ShowStderr bool ShowStderr requests job stderr and requires tmux 3.6; see UnsupportedPolicy.
StartDirectory *string StartDirectory selects the job directory; nil omits it. It requires tmux 3.4; see UnsupportedPolicy. A directory that does not exist is not an error: tmux starts the process in the home directory instead, or in / without one.
TargetPane PaneID TargetPane selects a stable pane target; its zero value leaves target selection to tmux.
Esc

Type to search.

Reference previewOpen reference