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-java latest

Pane.retitle

Retitles this pane and returns its replacement capture.

Source and package
Qualified name
io.github.libtmux.Pane.retitle
Package
io.github.libtmux
Declared in
Pane
Distribution
io.github.libtmux:libtmux
Source
libtmux/src/main/java/io/github/libtmux/Pane.java
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptRustGoC#C++Swift Kotlin Scala OCaml F# Clojure
@CheckReturnValue @Operation(Kind.MUTATION) public Pane retitle(String title)

Description#

Retain the result to read the changed title. This handle keeps its original captured state.

A program running in the pane can set its own title through an escape sequence, and tmux reports that one instead. This says what the title is now, not what it will stay.

Parameters

tmux command#

The tmux commands behind retitle.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Set a pane's title

Equivalents of Set a pane's title in other languages
Language Equivalent
Python libtmux.Pane.set_title
Lua libtmux.Pane:set_title
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript pane.Pane.setTitle
Rust pane.Pane.set_title
Go tmux.Pane.SetTitle
C# LibTmux.Pane.SetTitleAsync
C++ libtmux::Pane::set_title
Swift Server.setTitle(_:of:)
OCaml Libtmux_unix.Client.set_pane_title
Perl LibTmux::Server::set_title Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes.

No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference