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.

function libtmux-ocaml latest

Client.rename_session

Set the session name, rejecting a conflicting existing name. Bound IDs remain usable; existing snapshots retain their captured names.

Source and package
Qualified name
Libtmux_eio.Client.rename_session
Module
Libtmux_eio
Declared in
Client
Package
libtmux-eio
Source
eio/libtmux_eio.mli
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala F# Clojure
val rename_session : t -> Libtmux.Session.target -> name:string -> (unit, Libtmux.Error.t) result

Public owner: Libtmux_eio

Parameters

tmux command#

The tmux commands behind 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:)
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