Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-ocaml latest

Client.clear_history

Clear stored scrollback for this pane. The visible screen and running process remain; later captures cannot recover discarded history.

Source and package
Qualified name
Libtmux_unix.Client.clear_history
Module
Libtmux_unix
Declared in
Client
Package
libtmux-unix
Source
unix/libtmux_unix.mli
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala F# Clojure
val clear_history : ?cancel:Cancellation.t -> t -> Libtmux.Pane.target -> (unit, Libtmux.Error.t) result

Public owner: Libtmux_unix

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
Rust pane.Pane.clear_history
Go tmux.Pane.ClearHistory
Java io.github.libtmux.Pane.clearHistory
C# LibTmux.Pane.ClearHistoryAsync
C++ libtmux::Pane::clear_history
Swift Server.clearHistory(_:)
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