Session.set_option
Set one option to text, unchecked.
Source and package
- Qualified name
-
libtmux::session:: Session:: set _option - Module
- session
- Declared in
Session- Package
- libtmux
- Source
- crates/libtmux/src/session/settings.rs
- Other languages
- Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptGo Java C# C++Swift Kotlin Scala OCaml F# Clojure
-
Description#
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::OptionScopeMismatchwhen tmux keeps the option in another of its tables.
tmux command#
The tmux commands behind set_option.
tmux C API#
The C declarations in tmux that implement these commands.
tmux options#
Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.
In other ports#
Set a session option
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Lua | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | session |
| Go | tmux |
| Java | reached through Session.options, whose Options carries the write |
| C# | reached through Session.Options, whose TmuxOptions carries the write |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
| Perl | Lib Pass scope => 'session' and the explicit target ID where applicable; inherited and global reads are deliberate options. |
No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.