Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

pane.Pane.set_option

Rust

View as Markdown

Module
pane
Declared in
Pane
Package
libtmux
Source
crates/libtmux/src/pane/settings.rs
Other languages
Python Ruby LuaTypeScriptGo Java .NET C++Swift
set_option ( self , name : &str , value : impl Into<OsString> ) → Result<(), Error>
method [source]
method [source]
set_option

Set one option to text, unchecked.

The value is marked sensitive, so it never reaches Debug, an error, or a tracing span. tmux validates it; Self::set_typed_option checks it against tmux's option table first.

Errors

Returns an error when tmux rejects the name or value.

Returns crate::Error::OptionScopeMismatch when tmux keeps the option in another of its tables.

Discussed in Options and hooks

In other ports Set a pane option

0 declared, 0 inherited

Esc

Type to search.