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_session:rename/2

Rename the registered session using a literal name and return the command result. Performs I/O. Previously captured records keep their old names; detached or stale references fail validation before the action.

Source and package
Qualified name
tmux_session:rename/2
Declared in
tmux_session
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_session.erl
Other languages
Perlmethod PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
rename(Session, Name) -spec rename(tmux_model:session(), 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.

Guides#

Pages that discuss rename/2.

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

Esc

Type to search.

Reference previewOpen reference