Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

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

function libtmux-erlang latest

tmux_window:rename/2

Rename the registered physical window with a literal name. Performs I/O and returns the command result. Captured rows and snapshots remain unchanged.

Source and package
Qualified name
tmux_window:rename/2
Declared in
tmux_window
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_window.erl
Other languages
Perlmethod PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
rename(Window, Name) -spec rename(tmux_model:window(), binary()) -> {ok, map()} | {error, map()}.
Parameters

tmux command#

The tmux commands behind rename/2.

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