Core LibraryalphaAPI 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-cxx latest

Pane.paste

Deliver a buffer's text to this pane, as if it had been typed.

Source and package
Qualified name
libtmux::Pane::paste
Namespace
libtmux
Declared in
Pane
Package
libtmux-cxx
Source
include/libtmux/entities.hpp
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptRustGoJavaC#Swift Kotlin Scala OCaml F# Clojure
[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<void, CommandFailure> paste(const Buffer& buffer, bool consume = false) const;

Description#

The text arrives on the command line and is not run: a caller wanting it executed sends Enter afterwards, which is the same distinction send_text() draws.

consume is tmux's -d, deleting the buffer once it has been pasted, which is what a caller treating it as a one-shot transfer wants.

Parameters

tmux command#

The tmux commands behind paste.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Paste a buffer into a pane

Equivalents of Paste a buffer into a pane in other languages
Language Equivalent
Python libtmux.Pane.paste_buffer
Lua libtmux.Pane:paste_buffer
Erlang tmux_buffer:paste/3
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.pasteBuffer
Rust pane.Pane.paste_buffer
Go tmux.Pane.PasteBuffer
Java io.github.libtmux.Pane.pasteBuffer
C# LibTmux.Pane.PasteBufferAsync
Swift Server.paste(buffer:into:)
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, PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference