libtmux Reference MCP Search
On this page

session.settings.Session.get_option

View as Markdown

Module
session.settings
Declared in
Session
Package
libtmux
Source
crates/libtmux/src/session/settings.rs
get_option ( self , name : &str ) Result<Option<TmuxText>, Error>
method [source]
method [source]
get_option

Read one option's exact stored value.

A user option, whose name begins with @, exists only while it is set, so an unset one reports None. A built-in option always exists, so an unset one also reports None. An unrecognized built-in name is an error.

Errors

Returns an error when tmux does not recognize the option name.

0 declared, 0 inherited

Esc

Type to search.