Java API

method libtmux-java latest

Session.rename

Renames this session and returns its replacement capture.

Source and package

Qualified name: io.github.libtmux.Session.rename
Package: io.github.libtmux
Declared in: Session
Distribution: io.github.libtmux:libtmux
Source: libtmux/src/main/java/io/github/libtmux/Session.java
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoC#C++Swift Kotlin Scala OCaml F# Clojure

Description#

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

Parameters

The tmux commands behind rename.

The C declarations in tmux that implement these commands.

Rename a session

Equivalents of Rename a session in other languages
Language	Equivalent
Python	`libtmux.Session.rename_session`
Ruby	`LibTmux::Session#rename`
Lua	`libtmux.Session:rename`
Erlang	`tmux_session:rename/2`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`session.Session.rename`
Rust	`session.Session.rename`
Go	`tmux.Session.Rename`
C#	`LibTmux.Session.RenameAsync`
C++	`libtmux::Session::rename`
Swift	`Server.rename(_:to:)`
OCaml	`Libtmux_unix.Client.rename_session`
Perl	`LibTmux::Server::rename_session` 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#.