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

Open tmux's interactive option editor in this pane.

Source and package
Qualified name
Pane.customizeMode
Module
pane
Declared in
Pane
Package
libtmux
Source
packages/libtmux/src/pane.ts
Other languages
PowerShell Julia Elixir Python Ruby Lua Rust Go Java C# C++ Swift Kotlin Scala F#
customizeMode(): Promise<void>

Description#

The promise resolves once the mode is on screen, not once someone has chosen: tmux answers this command as soon as it opens the mode. Bind a tmux command to the selection to act on what was picked.

tmux needs a client attached to the session to draw this. With none, it does nothing and reports success, so a headless run is told it worked.

Examples#

await pane.customizeMode();

tmux command#

The tmux commands behind customizeMode.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Open tmux's option editor in a pane

Equivalents of Open tmux's option editor in a pane in other languages
Language Equivalent
Python libtmux.Pane.customize_mode
Rust no equivalent on Pane
Go tmux.Pane.CustomizeMode
Java no equivalent on Pane
C# LibTmux.Pane.EnterCustomizeModeAsync
C++ no equivalent on Pane
Swift no equivalent on Pane

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

Esc

Type to search.

Reference previewOpen reference