Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

libtmux.Server.list_keys

Python

Python
Ruby Unavailable
Lua Unavailable
TypeScript Unavailable
Rust Unavailable
Go
Java
.NET
C++ Unavailable
Swift Unavailable

View as Markdown

Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++ Swift

list_keys ( self , key_table : str | None = None , format_ : str | None = None ) → list[str] method [source] ¶ method [source] ¶ list_keys

List key bindings via $ tmux list-keys.

Examples

>>> result = server.list_keys()
>>> isinstance(result, list)
True

Parameters

key_table ( str | None ) – Filter by key table (-T flag).
format_ ( str | None ) – Custom output format applied to each line (-F flag). Requires tmux 3.7+; warns and is ignored on older tmux.

Returns

list[str] Key binding lines.

In other ports List the key bindings

Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript no equivalent on Server
Rust no equivalent on Server
Go tmux.Server.ListKeys
Java io.github.libtmux.Keys.Keys.list
.NET LibTmux.TmuxKeys.GetAllAsync
C++ no equivalent on Server
Swift no equivalent on Server

0 declared, 0 inherited