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

Pane.cmd

Run a raw tmux command against this pane.

Source and package
Qualified name
libtmux::pane::Pane::cmd
Module
pane
Declared in
Pane
Package
libtmux
Source
crates/libtmux/src/pane.rs
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScriptGo Java C# C++ Swift Kotlin Scala OCaml F# Clojure
pub async fn cmd(&self, command: Command) -> Result< CommandResult, Error >

Description#

The escape hatch for anything this crate does not wrap. -t is placed after the subcommand for you, because tmux stops reading flags at the first positional: a target appended after one is taken as text, and the command then succeeds having acted on something else.

A non-zero exit status comes back in the CommandResult rather than as an error, the same as crate::Server::cmd().

Errors

Returns an error when the process cannot be started, captured, or awaited.

Examples#

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("raw").await?;
let window = session.active_window().await?.expect("a window");
let pane = window.active_pane().await?.expect("a pane");
let result = pane
.cmd(libtmux::Command::new("display-message").arg("-p").arg("#{pane_id}"))
.await?;
assert_eq!(result.stdout_lossy().trim(), pane.id().to_string());
guard.shutdown().await?;
Parameters

In other ports#

Run a tmux command addressed at a pane

Equivalents of Run a tmux command addressed at a pane in other languages
Language Equivalent
Python libtmux.Pane.cmd
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.cmd
Go tmux.Pane.Cmd
Java no equivalent on Pane
C# no equivalent on Pane
C++ no equivalent on Pane
Swift no equivalent on Pane
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, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference