Client.read_option
Read one exact name, including user-option inheritance. None means no entry under the selected policy. An invalid target remains an error. The default follows inheritance; this does not identify the defining parent scope.
Source and package
- Qualified name
-
Libtmux_unix .Client. read _option - Module
- Libtmux_unix
- Declared in
Client- Package
- libtmux-unix
- Source
- unix/libtmux_unix.mli
- Other languages
- Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript RustGo Java C# C++Swift Kotlin Scala F# Clojure
- val read_option : ?cancel:Cancellation
.t -> ?include_inherited:bool -> t -> Libtmux.Options -> string -> (Libtmux.scope .Options option, Libtmux.value .Error ) result.t -
Public owner:
Libtmux_unix- Parameters
-
-
include_inherited? (bool) #
tmux command#
The tmux commands behind read_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#
Read one server 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; Server.showOptions returns them all |
| Rust | server |
| Go | tmux |
| Java | reached through Server.options, whose Options.get reads one |
| C# | reached through Server.Options, whose TmuxOptions.GetAsync reads one |
| C++ | no single-option read; Server::options returns them all |
| Swift | Server |
| Perl | Lib Pass scope => 'server' 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#.
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 |
| Rust | session |
| 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 |
| 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#.
Read one window 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; Window.showOptions returns them all |
| Rust | window |
| Go | tmux |
| Java | reached through Window.options, whose Options.get reads one |
| C# | reached through Window.Options, whose TmuxOptions.GetAsync reads one |
| C++ | libtmux:: |
| Swift | Server |
| Perl | Lib Pass scope => 'window' 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#.
Read one pane 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; Pane.showOptions returns them all |
| Rust | pane |
| Go | tmux |
| Java | reached through Pane.options, whose Options.get reads one |
| C# | reached through Pane.Options, whose TmuxOptions.GetAsync reads one |
| C++ | libtmux:: |
| Swift | Server |
| Perl | Lib Pass scope => 'pane' 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#.