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

Session.Rename

Rename changes the receiver session's name and returns a canonical freshly materialized Session. If the command succeeds but refresh fails, it returns the receiver with that error. A transport or context error can be delivery-ambiguous; no rollback is attempted. Invalid names are rejected before execution and match ErrInvalidRequest.

Source and package
Qualified name
tmux.Session.Rename
Package
tmux
Declared in
Session
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/session_lifecycle.go
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustJavaC#C++Swift Kotlin Scala OCaml F# Clojure
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 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
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