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 latest

Session.attach

Return $ tmux attach-session aka alias: $ tmux attach.

Source and package
Qualified name
libtmux.Session.attach
Module
libtmux
Declared in
Session
Package
libtmux
Source
src/libtmux/session.py
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript RustGoJavaC#C++ Swift Kotlin Scala OCaml F# Clojure
attach ( self, exit_: bool | None = None, flags_: list[str] | None = None, ) → Session

Examples#

>>> session = server.new_session()
>>> session not in server.attached_sessions
True
Parameters

tmux command#

The tmux commands behind attach.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Attach a client to a session

Equivalents of Attach a client to a session in other languages
Language Equivalent
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
Rust control.ControlMode.attach
Go tmux.Server.AttachSession
Java io.github.libtmux.control.ControlClient.attach
C# LibTmux.Server.AttachSessionAsync
C++ libtmux::Session::attach_command
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#.

Esc

Type to search.

Reference previewOpen reference