Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased LibTmux has not been released. Its API may change during development. This site's structure and URLs may change too.

method libtmux-perl latest

Server.get_option

See "get_option" in LibTmux::Server for arguments, returned value, and completion.

Source and package
Qualified name
LibTmux::Async::Server::get_option
Module
LibTmux::Async
Declared in
Server
Package
LibTmux-Async
Source
packages/async/lib/LibTmux/Async/Server.pm
Other languages
Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript RustGo Java C# C++Swift Kotlin Scala OCamlfunction F# Clojure
sub get_option($self, %args)

Methods#

Parameters

tmux command#

The tmux commands behind get_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

Equivalents of Read one server option in other languages
Language Equivalent
Python libtmux.Server.show_option
Lua libtmux.Server:get_option
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.Server.typed_option
Go tmux.Server.RawOption
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.option(_:scope:)
OCaml Libtmux_unix.Client.read_option Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.

No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Read one session option

Equivalents of Read one session option in other languages
Language Equivalent
Python libtmux.Session.show_option
Lua libtmux.Session:get_option
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.Session.typed_option
Go tmux.Session.RawOption
Java reached through Session.options, whose Options.get reads one
C# reached through Session.Options, whose TmuxOptions.GetAsync reads one
C++ libtmux::Session::option
Swift Server.option(_:scope:)
OCaml Libtmux_unix.Client.read_option Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.

No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Read one window option

Equivalents of Read one window option in other languages
Language Equivalent
Python libtmux.Window.show_option
Lua libtmux.Window:get_option
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.Window.typed_option
Go tmux.Window.RawOption
Java reached through Window.options, whose Options.get reads one
C# reached through Window.Options, whose TmuxOptions.GetAsync reads one
C++ libtmux::Window::option
Swift Server.option(_:scope:)
OCaml Libtmux_unix.Client.read_option Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.

No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Read one pane option

Equivalents of Read one pane option in other languages
Language Equivalent
Python libtmux.Pane.show_option
Lua libtmux.Pane:get_option
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.Pane.typed_option
Go tmux.Pane.RawOption
Java reached through Pane.options, whose Options.get reads one
C# reached through Pane.Options, whose TmuxOptions.GetAsync reads one
C++ libtmux::Pane::option
Swift Server.option(_:scope:)
OCaml Libtmux_unix.Client.read_option Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.

No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference