Rust

Choose a port 22

Scripting & web

RubyNo matching page

LuaNo matching page

JuliaNo matching page

TypeScriptNo matching page

PerlNo matching page

Compiled & native

Common LispNo matching page

SwiftNo matching page

OCamlNo matching page

HaskellNo matching page

JVM

KotlinNo matching page

ScalaNo matching page

ClojureNo matching page

.NET

F#No matching page

PowerShellNo matching page

BEAM

ElixirNo matching page

tmux

GitHub crates.io docs.rs

Packages

Packages and source 13

Source

libtmuxcrates/libtmux libtmux-rslibtmux/libtmux-rs libtmux-macroscrates/libtmux-macros tmux-mcpcrates/tmux-mcp tmux-workspacecrates/tmux-workspace

Packages

libtmuxcrates.io libtmux-macroscrates.io tmux-mcpcrates.io tmux-workspacecrates.io

API reference

libtmuxdocs.rs libtmux-macrosdocs.rs tmux-mcpdocs.rs tmux-workspacedocs.rs

Rust · libtmux/libtmux-rs

Auto Light Dark

Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

Other references docs.rs

0.x Released; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Examples CLI Manual API Reference Configuration Internals

concept Working example; may change without notice. Read more

latest

Current version

English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Rust API

method libtmux-rs latest

Server.bind_key

Bind a key in one key table.

Source and package

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

pub async fn bind_key( &self, table: &str, key: &str, command: impl Into<OsString>, ) -> Result<(), Error> method async [source] ¶

Description#

Errors

Returns an error when tmux rejects the key or the command.

Parameters

table (&str) #
key (&str) #
command (impl Into<OsString>) #

tmux command#

The tmux commands behind bind_key.

bind-key

tmux C API#

The C declarations in tmux that implement these commands.

cmd_bind_key_entry cmd_bind_key_exec

In other ports#

Bind a key to a tmux command

Equivalents of Bind a key to a tmux command in other languages
Language	Equivalent
Python	`libtmux.Server.bind_key`
Erlang	`tmux_key:bind/3`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	no equivalent on `Server`
Go	`tmux.Server.BindKey`
Java	`io.github.libtmux.Keys.bind`
C#	`LibTmux.TmuxKeys.BindAsync`
C++	`libtmux::Server::bind_key`
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#.

Reference preview