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.

Go API

method libtmux-go latest

Pane.SetTitle

SetTitle sets the title of the receiver's exact linked pane. tmux expands format expressions in title; the value is not a shell command. SetTitle then refreshes by PaneID, so the returned canonical Pane may carry a different linked-session or winlink context. If the mutation is accepted but refresh fails, SetTitle returns the original receiver with that error.

Source and package
Qualified name
tmux.Pane.SetTitle
Package
tmux
Declared in
Pane
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/pane_geometry.go
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptRustJavaC#C++Swift Kotlin Scala OCaml F# Clojure
func (p Pane) SetTitle( ctx context.Context, title string, ) (Pane, error)

Description#

Completed stderr produces a redacted CommandError; nonzero exits without stderr are followed by refresh. Transport errors return zero and are delivery-ambiguous.

Parameters

tmux command#

The tmux commands behind SetTitle.

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
Java io.github.libtmux.Pane.retitle
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