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

Server.SwitchClient

SwitchClient switches tmux's current client to targetSession. TargetSession is a validated session name rather than a stable identity; cancellation does not prove the switch did not occur.

Source and package
Qualified name
tmux.Server.SwitchClient
Package
tmux
Declared in
Server
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/server_clients.go
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Rust Java C# C++ Swift Kotlin Scala OCaml F# Clojure

Description#

The target is sent anchored with tmux's "=" exact-match prefix: an unanchored "-t name" resolves by prefix, so a name that matches no session exactly but starts a different one's name would otherwise switch there silently instead of failing. The anchor is safe here because validateLifecycleSessionName has already refused the period or colon that would make "=name" misread the target itself.

tmux command#

The tmux commands behind SwitchClient.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Switch a client to another session

Equivalents of Switch a client to another session in other languages
Language Equivalent
Python libtmux.Server.switch_client
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no equivalent on Server
Rust no equivalent on Server
Java no equivalent on Server
C# LibTmux.Server.SwitchClientAsync
C++ no equivalent on Server
Swift no equivalent on Server
OCaml Libtmux_unix.Client.switch_client_at
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference