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-go latest

Server.ListKeys

ListKeys returns an owned snapshot of raw tmux key-binding lines. Format requires tmux 3.7 and follows UnsupportedPolicy. tmux 3.7 through 3.7c send a table's sole matching binding to client status and leave stdout empty; this method preserves that upstream and Python behavior. Listing failures remain errors.

Source and package
Qualified name
tmux.Server.ListKeys
Package
tmux
Declared in
Server
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/server_keys.go
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Rust JavaC# C++ Swift Kotlin Scala OCaml F# Clojure

Description#

On an unused socket, tmux starts an empty server to answer. With the default exit-empty setting, that server exits at once and leaves its socket file.

tmux command#

The tmux commands behind ListKeys.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

List the key bindings

Equivalents of List the key bindings in other languages
Language Equivalent
Python libtmux.Server.list_keys
Erlang tmux_key:listing/1
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no equivalent on Server
Rust no equivalent on Server
Java io.github.libtmux.Keys.list
C# LibTmux.TmuxKeys.GetAllAsync
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, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference