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

Server.key_bindings

List key bindings as tmux prints them.

Source and package
Qualified name
libtmux::server::Server::key_bindings
Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server.rs
pub async fn key_bindings( &self, table: Option<&str> ) -> Result<Vec<String>, Error>

Description#

Each line is a complete bind-key command in tmux's own quoting, which this crate deliberately does not re-parse: the same value is rendered bare, double quoted, or single quoted depending on content, and a table name is printed bare, spaces and all. Self::typed_key_bindings() reads the same bindings as fields on tmux 3.7 and later.

On tmux 3.7 through 3.7c, a table holding exactly one binding lists empty: those releases send a one-line listing to the message log.

Errors

Returns an error when tmux refuses the listing.

Parameters

tmux command#

The tmux commands behind key_bindings.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference