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

Window.rename

Rename the window and update this handle.

Source and package
Qualified name
libtmux::window::Window::rename
Module
window
Declared in
Window
Package
libtmux
Source
crates/libtmux/src/window.rs
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
pub async fn rename( &mut self, name: impl Into<TmuxArg> ) -> Result<&mut Self, Error>

Description#

The name belongs to the window, so every session linking it sees the change.

A name given as text reaches tmux as that text, # included. Only a TmuxArg::format() value is expanded as a format, so #(command) in one runs a shell command. See [the crate documentation][crate#a-name-reaches-tmux-as-text].

Errors

Returns an error when tmux refuses the name.

Parameters

tmux command#

The tmux commands behind rename.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Rename a window

Equivalents of Rename a window in other languages
Language Equivalent
Python libtmux.Window.rename_window
Ruby LibTmux::Window#rename
Lua libtmux.Window:rename
Erlang tmux_window:rename/2
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript window.Window.rename
Go tmux.Window.Rename
Java io.github.libtmux.Window.rename
C# LibTmux.Window.RenameAsync
C++ libtmux::Window::rename
Swift Server.rename(_:to:)
OCaml Libtmux_unix.Client.rename_window
Perl LibTmux::Server::rename_window Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes.

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

Esc

Type to search.

Reference previewOpen reference