Server.show_option
Return option value for the target.
Source and package
- show_option ( self, option: str, global_: bool = False, g: bool = False, scope: Option
Scope | _DefaultOption | None = DEFAULT_OPTION_SCOPE, ignore_errors: bool | None = None, include_hooks: bool | None = None, include_inherited: bool | None = None, ) tScope .Any | None -
Inherited from
libtmux.options.OptionsMixinExamples#
>>> import typing as t>>> from libtmux.common import tmux_cmd>>> from libtmux.constants import OptionScope>>> 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().cmd('new-session', '-d')<libtmux.common.tmux_cmd object at ...>>>> MyServer().show_option('exit-unattached', global_=True)False- Parameters
- Raises
tmux command#
The tmux commands behind show_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 |
|---|---|
| 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 |
| OCaml | Libtmux Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy. |
| 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#.