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.clear_history

Clear the pane's scrollback history.

Source and package
Qualified name
libtmux::pane::Pane::clear_history
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 LuaTypeScriptGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
pub async fn clear_history(&self) -> Result<(), Error>

Description#

Errors

Returns an error when tmux refuses the command.

tmux command#

The tmux commands behind clear_history.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Clear a pane's scrollback

Equivalents of Clear a pane's scrollback in other languages
Language Equivalent
Python libtmux.Pane.clear_history
Lua libtmux.Pane:clear_history
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.clearHistory
Go tmux.Pane.ClearHistory
Java io.github.libtmux.Pane.clearHistory
C# LibTmux.Pane.ClearHistoryAsync
C++ libtmux::Pane::clear_history
Swift Server.clearHistory(_:)
OCaml Libtmux_unix.Client.clear_history
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, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference