Core Library0.xAPI Reference

Choose documentation 3

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-ts latest

Server.showOptions

Every server-scope option tmux currently reports.

Source and package
Qualified name
Server.showOptions
Module
server
Declared in
Server
Package
libtmux
Source
packages/libtmux/src/server.ts
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua RustGoJavaC#C++Swift Kotlin Scala OCamlfunction F# Clojure

Examples#

const options = await server.showOptions();
options.get("escape-time");
Parameters

tmux command#

The tmux commands behind showOptions.

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.
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#.

Esc

Type to search.

Reference previewOpen reference