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

SetPlanOptionRequest

SetPlanOptionRequest names one tmux option write for Plan.SetOption. Its zero value is invalid, because Name is required.

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

Fields7#

SetPlanOptionRequest fields
NameTypeDescription
Append bool Append adds to an existing value rather than replacing it.
Global bool Global writes the server or global scope rather than the target's own.
Name string Name is the tmux option name, such as "status" or a user option "@thing".
Pane bool Pane writes a pane option.
Unset bool Unset removes the option instead of writing it.
Value string Value is the value to write. It is omitted when Unset is set.
Window bool Window writes a window option rather than a session or server one.
Esc

Type to search.

Reference previewOpen reference