Server.set_option
set_option(name => string, value => string|integer, scope => session|window|pane|server, target => id?, global => boolean?).
Source and package
-
Description#
Set an option at explicit session/window/pane/server scope. Supply an exact target ID for local settings or global => true for the global level. Empty and zero values are preserved.
"get_option"controls whether inherited values participate.Returns
undefafter command acceptance. Performs I/O; failures propagate throughLibTmux::X. Captured objects are not modified.$server->set_option(scope => 'window', target => $window->id, name => '@build', value => '0');Methods#
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 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++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.
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 |
| 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#.
Set 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#.
Set 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#.
Set a default every session inherits
| Language | Equivalent |
|---|---|
| Python | no equivalent on Server |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | server |
| Rust | server |
| Go | no equivalent on Server |
| Java | no equivalent on Server |
| C# | no equivalent on Server |
| C++ | libtmux:: |
| Swift | no equivalent on Server |
| OCaml | No direct public OCaml equivalent is recorded for this operation. |
No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.