Python API

method libtmux latest

Server.display_menu

Display a popup menu via $ tmux display-menu.

Source and package

Qualified name: libtmux.Server.display_menu
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript RustGo Java C# C++ Swift Kotlin Scala OCaml F# Clojure

Description#

Requires a TTY-backed attached client. Control-mode clients have tty.sy=0, which causes menu_prepare() to return NULL. This method cannot be tested with ControlMode.

Examples#

Cannot run end-to-end (requires a TTY-backed client; see the tty.sy=0 note above). For broader coverage, see tests/test_server.py::test_display_menu_flags.

>>> captured = []
>>> def fake_cmd(name, *args, **_kw):
...     captured.append((name, args))
...     return type('R', (), {'stderr': [], 'stdout': []})()
>>> monkeypatch.setattr(server, 'cmd', fake_cmd)
>>> server.display_menu('First', '1', 'select-pane', title='menu')
>>> captured[0][0]
'display-menu'

Parameters

items (str) #
title (str | None) # – Menu title (-T flag).
target_pane (str | None) # – Target pane for format expansion (-t flag).
target_client (str | None) # – Target client (-c flag).
x (int | str | None) # – Menu x position (-x flag).
y (int | str | None) # – Menu y position (-y flag).
starting_choice (int | str | None) # – Pre-selected item index (-C flag). Use - for none. Requires tmux 3.4+.
border_lines (str | None) # – Border line style (-b flag). Requires tmux 3.4+.
style (str | None) # – Menu style (-s flag). Requires tmux 3.4+.
border_style (str | None) # – Border style (-S flag). Requires tmux 3.4+.
selected_style (str | None) # – Style for the currently selected menu item (-H flag). Requires tmux 3.4+.
mouse (bool | None) # – Always enable mouse handling in the menu (-M flag). Requires tmux 3.5+.
stay_open (bool | None) # – Keep the menu open when the mouse is released (-O flag). Requires tmux 3.2+.

tmux command#

The tmux commands behind display_menu.

display-menu

tmux C API#

The C declarations in tmux that implement these commands.

cmd_display_menu_entry cmd_display_menu_exec

In other ports#

Show a menu over a client

Equivalents of Show a menu over a client in other languages
Language	Equivalent
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	no equivalent on `Server`
Rust	`server.Server.display_menu`
Go	`tmux.Server.DisplayMenu`
Java	no equivalent on `Server`
C#	no equivalent on `Server`
C++	no equivalent on `Server`
Swift	no equivalent on `Server`
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.display_menu

Description#

Examples#

tmux command#

tmux C API#

In other ports#

Description#

Examples#

tmux command#

tmux C API#

In other ports#

Related types#