Auto Light Dark

Core LibraryAPI Reference

Choose documentation 3

latest

Current version

English

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

C# API

method libtmux-dotnet latest

TmuxKeys.BindAsync

Namespace LibTmux

Binds a key to a tmux command.

View as Markdown

Source and package

Module: LibTmux
Declared in: TmuxKeys
Package: LibTmux
Source: src/LibTmux/Keys/TmuxKeys.cs
Other languages: Python Ruby Lua TypeScript Rust Go Java C++ Swift Kotlin Scala F#

BindAsync ( request : BindKeyRequest , cancellationToken : CancellationToken ) → Task method [source] ¶

Parameters

request ( BindKeyRequest ) – Which key, to what, and in which table.
cancellationToken ( CancellationToken ) – Cancels the tmux command.

Returns

A task that completes once the binding is in place.

Raises

ArgumentNullException – request is null.

tmux command bind-key

In other ports Bind a key to a tmux command

Python libtmux.Server.bind_key
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.bind
C++ libtmux::Server::bind_key
Swift no equivalent on Server
Kotlin No source-verified Kotlin equivalent is recorded for this operation.
Scala No source-verified Scala equivalent is recorded for this operation.
F# No source-verified F# equivalent is recorded for this operation.