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

Pane.showOptions

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

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

Description#

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

Examples#

const options = await pane.showOptions();
options.get("remain-on-exit");
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.

Guides#

Pages that discuss showOptions.

In other ports#

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
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(_:)

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

Esc

Type to search.

Reference previewOpen reference