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.kill

Kill Session, closes linked windows and detach all clients.

Source and package
Qualified name
libtmux.Session.kill
Module
libtmux
Declared in
Session
Package
libtmux
Source
src/libtmux/session.py
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp RubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
kill ( self, all_except: bool | None = None, clear: bool | None = None, group: bool | None = None, ) → None

Description#

$ tmux kill-session.

Examples#

Kill a session:

>>> session_1 = server.new_session()
>>> session_1 in server.sessions
True
>>> session_1.kill()
>>> session_1 not in server.sessions
True

Kill all sessions except the current one:

>>> one_session_to_rule_them_all = server.new_session()
>>> other_sessions = server.new_session(
... ), server.new_session()
>>> all([w in server.sessions for w in other_sessions])
True
>>> one_session_to_rule_them_all.kill(all_except=True)
>>> all([w not in server.sessions for w in other_sessions])
True
>>> one_session_to_rule_them_all in server.sessions
True
Parameters
  • all_except (bool | None) # – Kill all sessions in server except this one.

  • clear (bool | None) # – Clear alerts (bell, activity, or silence) in all windows.

  • group (bool | None) # – Kill all sessions in this session's group (-g flag). Requires tmux 3.7+. If used with tmux < 3.7, a warning is issued and the flag is ignored.

tmux command#

The tmux commands behind kill.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

End a session

Equivalents of End a session in other languages
Language Equivalent
Ruby LibTmux::Session#kill
Lua libtmux.Session:kill
Erlang tmux_session:kill/1
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript session.Session.kill
Rust session.Session.kill
Go tmux.Session.Kill
Java io.github.libtmux.Session.kill
C# LibTmux.Session.KillAsync
C++ libtmux::Session::kill
Swift Server.kill(_:)
OCaml Libtmux_unix.Client.kill_session
Perl LibTmux::Server::kill_session Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes.

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

Esc

Type to search.

Reference previewOpen reference