Core LibraryAPI Reference

Choose documentation 3

latest

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

C# API

method libtmux-dotnet latest

Session.RenameAsync

Namespace LibTmux

Renames this session.

View as Markdown

Source and package

Module: LibTmux
Declared in: Session
Package: LibTmux
Source: src/LibTmux/Session.Lifecycle.cs
Other languages: Python Ruby Lua TypeScript Rust Go Java C++Swift Kotlin Scala F#

RenameAsync ( name : string , cancellationToken : CancellationToken ) → Task<Session> methodasync [source] ¶

Description#

tmux expands the name as a format, so a # in it does not survive verbatim.

Parameters

name ( string ) – The new name.
cancellationToken ( CancellationToken ) – Cancels the tmux command.

Returns

A replacement handle carrying the new name.

tmux command rename-session

In other ports Rename a session

Python libtmux.Session.rename_session
Ruby LibTmux::Session#rename
Lua libtmux.Session:rename
TypeScript session.Session.rename
Rust session.Session.rename
Go tmux.Session.Rename
Java io.github.libtmux.Session.rename
C++ libtmux::Session::rename
Swift Server.rename(_:to:)
Kotlin No source-verified Kotlin equivalent is recorded for this operation.
Scala No source-verified Scala equivalent is recorded for this operation.
F# No source-verified F# equivalent is recorded for this operation.