ControlMode.attach
Attach to a session in control mode.
Source and package
- Qualified name
-
libtmux::control:: Control Mode:: attach - Module
- control
- Declared in
ControlMode- Package
- libtmux
- Source
- crates/libtmux/src/control.rs
- Other languages
- Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript GoJavaC#C++ Swift Kotlin Scala OCaml F# Clojure
-
Description#
When this returns, tmux has the client attached: anything that changes the server afterwards is reported. Returning as soon as the process started would look the same and lose every notification racing the attach, which is the hardest kind of bug to see.
Errors
Refuses a daemon ranking below 3.7 final (
next-3.7, 3.7 release candidates). Capacity, metadata, socket pinning and the opening handshake share one deadline from attach entry. Process, pipe and framing failures also refuse the attachment.Cancel safety
Nothing is left held: a dropped attach kills and reaps the tmux client it started.
Guides#
Pages that discuss attach.
In other ports#
Attach a client to a session
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | no direct equivalent; the client is out of scope for this port |
| Go | tmux |
| Java | io |
| C# | Lib |
| C++ | libtmux:: |
| Swift | reached through Server.connected(attachingTo:), which scopes a block rather than attaching a client |
| OCaml | No direct public OCaml equivalent is recorded for this operation. |
| Perl | attach_argv builds caller-owned terminal arguments without performing attachment; the caller owns process and TTY lifetime. |
No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.