Python API

libtmux.Server.bind_key

Python

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

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

bind_key ( self , key : str , command : str , key_table : str | None = None , note : str | None = None , repeat : bool | None = None ) → None method [source] ¶ method [source] ¶ bind_key

Bind a key to a command via $ tmux bind-key.

Examples

>>> server.bind_key('F12', 'display-message test', key_table='root')
>>> server.unbind_key('F12', key_table='root')

Parameters

key ( str ) – Key to bind (e.g. C-a, F12, M-x).
command ( str ) – Tmux command to run when key is pressed.
key_table ( str | None ) – Key table to bind in (-T flag). Defaults to prefix.
note ( str | None ) – Note for the binding (-N flag).
repeat ( bool | None ) – Allow the key to repeat (-r flag).

In other ports Bind a key to a tmux command

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 server.Server.bind_key
Go tmux.Server.BindKey
Java io.github.libtmux.Keys.Keys.bind
.NET LibTmux.TmuxKeys.BindAsync
C++ libtmux::Server::bind_key
Swift no equivalent on Server

0 declared, 0 inherited