Session.typed_option
Read one option, decoded according to what tmux declares about it.
Source and package
- Qualified name
-
libtmux::session:: Session:: typed _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 Lua TypeScript Go Java C# C++Swift Kotlin Scala OCamlfunction F# Clojure
-
Description#
A flag comes back as
OptionValue::Flagand a number asOptionValue::Number, so a caller does not decide for itself thatonmeans one. Everything else, including user options, stays text. The one way to read a single option;OptionValuesays how reads and writes fit together.Nonemeans the option holds nothing at this session. A user option, whose name begins with@, exists only while it is set, and a built-in one always exists, so both report an unset option asNone.Errors
Returns an error when tmux does not recognize the option name.
tmux options#
Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.
In other ports#
Read one 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 | no single-option read; Session.showOptions returns them all |
| Go | tmux |
| Java | reached through Session.options, whose Options.get reads one |
| C# | reached through Session.Options, whose TmuxOptions.GetAsync reads one |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy. |
| 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#.