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

Session.showOptions

Every option set on this session itself, not the ones it inherits.

Source and package
Qualified name
Session.showOptions
Module
session
Declared in
Session
Package
libtmux
Source
packages/libtmux/src/session.ts
Other languages
PowerShell Julia Elixir PythonRuby Lua RustGoJavaC#C++Swift Kotlin Scala F#

Description#

A fresh session usually has none, so an empty map here means nothing was set on this session — not that the option has no value. showResolvedOptions() answers what actually governs it.

Examples#

const options = await session.showOptions();
options.get("status");
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 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
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(_:)

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

Esc

Type to search.

Reference previewOpen reference