Core Library0.xAPI Reference

Choose documentation 1

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-raku latest

Options.entries

Read values, array indices and inherited provenance as captured entries.

Source and package
Qualified name
LibTmux::Configuration::Options.entries
Module
LibTmux::Configuration
Declared in
Options
Package
LibTmux
Source
lib/LibTmux/Configuration.rakumod
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptRustGoJavaC#C++Swift Kotlin Scala OCamlfunction F# Clojure
method entries(Str :$name, Bool :$effective = True --> List:D)

Description#

Read values, array indices and inherited provenance as captured entries.

Parameters

tmux command#

The tmux commands behind entries.

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 the options set on the server

Equivalents of Read the options set on the server in other languages
Language Equivalent
Python libtmux.Server.show_options
Ruby LibTmux::Server#options
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.showOptions
Rust server.Server.options
Go tmux.Server.Options
Java io.github.libtmux.Server.options
C# LibTmux.Server.Options
C++ libtmux::Server::options
Swift Server.options(_:)
OCaml Libtmux_unix.Client.capture_options Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Read the options set on a session

Equivalents of Read the options set on a session in other languages
Language Equivalent
Python libtmux.Session.show_options
Ruby LibTmux::Session#options
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript session.Session.showOptions
Rust session.Session.options
Go tmux.Session.Options
Java io.github.libtmux.Session.options
C# LibTmux.Session.Options
C++ libtmux::Session::options
Swift Server.options(_:)
OCaml Libtmux_unix.Client.capture_options Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Read the options set on a window

Equivalents of Read the options set on a window in other languages
Language Equivalent
Python libtmux.Window.show_options
Ruby LibTmux::Window#options
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript window.Window.showOptions
Rust window.Window.options
Go tmux.Window.Options
Java io.github.libtmux.Window.options
C# LibTmux.Window.Options
C++ libtmux::Window::options
Swift Server.options(_:)
OCaml Libtmux_unix.Client.capture_options Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Read the options set on a pane

Equivalents of Read the options set on a pane in other languages
Language Equivalent
Python libtmux.Pane.show_options
Ruby LibTmux::Pane#options
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.showOptions
Rust pane.Pane.options
Go tmux.Pane.Options
Java io.github.libtmux.Pane.options
C# LibTmux.Pane.Options
C++ libtmux::Pane::options
Swift Server.options(_:)
OCaml Libtmux_unix.Client.capture_options Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Esc

Type to search.

Reference previewOpen reference