Python API

libtmux.Pane.set_option

Python

Python
Ruby Unavailable
Lua
TypeScript
Rust
Go
Java Unavailable
.NET Unavailable
C++
Swift

Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/options.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++Swift

Inherited from libtmux.options.OptionsMixin

Set option for tmux target.

Wraps $ tmux set-option <option> <value>.

Parameters

option ( str ) – option to set, e.g. 'aggressive-resize'
value ( int | str ) – option value. True/False will turn in 'on' and 'off', also accepts string of 'on' or 'off' directly.

Raises

Discussed in Options and hooks

In other ports Set a pane option

Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Pane:set_option
TypeScript pane.Pane.setOption
Rust pane.Pane.set_option
Go tmux.Pane.SetOption
Java reached through Pane.options, whose Options carries the write
.NET reached through Pane.Options, whose TmuxOptions carries the write
C++ libtmux::Pane::set_option
Swift Server.setOption(_:to:scope:)

Examples

Python TypeScript

>>> import typing as t
>>> from libtmux.common import tmux_cmd
>>> from libtmux.constants import OptionScope
>>> from libtmux._internal.sparse_array import SparseArray

>>> class MyServer(OptionsMixin):
...     socket_name = server.socket_name
...     def cmd(self, cmd: str, *args: object):
...         cmd_args: t.List[t.Union[str, int]] = [cmd]
...         if self.socket_name:
...             cmd_args.insert(0, f"-L{self.socket_name}")
...         cmd_args.insert(0, "-f/dev/null")
...         return tmux_cmd(*cmd_args, *args)
...
...     default_option_scope = OptionScope.Server

>>> MyServer().set_option('escape-time', 1250)
<libtmux.options.MyServer object at ...>

>>> MyServer()._show_option('escape-time')
1250

>>> MyServer().set_option('escape-time', 495)
<libtmux.options.MyServer object at ...>

>>> MyServer()._show_option('escape-time')
495

await pane.setOption("remain-on-exit", "on");

0 declared, 0 inherited