Core LibraryAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

C# API

method libtmux-dotnet latest

Server.DetachAllClientsAsync

Namespace LibTmux.Server.DetachAllClientsAsync LibTmux

Detaches every client except one.

View as Markdown

Source and package
Module
LibTmux
Declared in
Server
Package
LibTmux
Source
src/LibTmux/Server.Clients.cs
Other languages
Python Ruby Lua TypeScript Rust Go Java C++ Swift Kotlin Scala F#
DetachAllClientsAsync ( keepClient : string? , shellCommand : string? , cancellationToken : CancellationToken ) → Task
method [source]

Description#

tmux reads the kept client from the same target flag it uses to name a client, so this always spares one. Naming none does not mean "spare none": tmux falls back to whichever client it resolves for the caller, which from a process with no client of its own leaves that client attached and detaches nothing.

Parameters
  • keepClient ( string? ) – The client to leave attached.

  • shellCommand ( string? ) – A command the detached clients run.

  • cancellationToken ( CancellationToken ) – Cancels the tmux command.

In other ports Detach every client on the server
  • Python libtmux.Server.detach_all_clients
  • Ruby No source-verified Ruby equivalent is recorded for this operation.
  • Lua No source-verified Lua equivalent is recorded for this operation.
  • TypeScript no equivalent on Server
  • Rust no equivalent on Server
  • Go tmux.Server.DetachAllClients
  • Java no equivalent on Server
  • C++ no equivalent on Server
  • Swift no equivalent on Server
  • 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.
Esc

Type to search.