Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

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

method libtmux-perl latest

Server.rename_session

rename_session(session => Session|session_id, name => string).

Source and package
Qualified name
LibTmux::Server::rename_session
Module
LibTmux
Declared in
Server
Package
LibTmux
Source
packages/core/lib/LibTmux/Server.pm
Other languages
Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
sub rename_session($self, %args)

Description#

Rename the selected LibTmux::Session using a literal name. Existing captured handles keep the old observed name; use "snapshot" to observe the change.

Returns undef after command acceptance. Performs I/O; failures propagate through LibTmux::X. Captured objects are not modified.

$server->rename_session(session => $session, name => 'application');

Methods#

Parameters

tmux command#

The tmux commands behind rename_session.

display-message (daemon identity or target preflight) rename-session

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

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
Java io.github.libtmux.Session.rename
C# LibTmux.Session.RenameAsync
C++ libtmux::Session::rename
Swift Server.rename(_:to:)
OCaml Libtmux_unix.Client.rename_session

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

Esc

Type to search.

Reference previewOpen reference