Server.unset_option
unset_option(name => string, scope => scope, target => id?, global => boolean?).
Source and package
-
Description#
Remove the selected local/global option so inheritance can take effect. Scope and target follow
"set_option"; removing an override differs from assigning empty text.Returns
undefafter command acceptance. Performs I/O; failures propagate throughLibTmux::X. Captured objects are not modified.$server->unset_option(scope => 'window', target => $window->id, name => '@build');Methods#
tmux command#
The tmux commands behind unset_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#
Unset a 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 | server |
| Rust | server |
| Go | tmux |
| Java | reached through Server.options, whose Options carries the write |
| C# | reached through Server.Options, whose TmuxOptions carries the write |
| C++ | no equivalent on Server |
| Swift | Server |
| OCaml | Libtmux |
No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.
Unset 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 |
| Rust | 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 |
No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.
Unset a 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 | window |
| Rust | window |
| Go | tmux |
| Java | reached through Window.options, whose Options carries the write |
| C# | reached through Window.Options, whose TmuxOptions carries the write |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.
Unset a 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 | pane |
| Rust | pane |
| Go | tmux |
| Java | reached through Pane.options, whose Options carries the write |
| C# | reached through Pane.Options, whose TmuxOptions carries the write |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.