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

Window.rename

Renames this window and returns its replacement capture.

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

Description#

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

A : or . is kept as written on every supported release but 3.7, which refuses the name. A kept delimiter cannot then address the window, since a target splits on both. Unlike a session name, a window name is never rewritten.

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
Rust window.Window.rename
Go tmux.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