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-ruby latest

Session.kill

Both allowlists are required for guarded deletion of a changing topology.

Source and package
Qualified name
LibTmux::Session#kill
Module
LibTmux
Declared in
Session
Package
libtmux
Source
gems/libtmux/lib/libtmux/operations.rb
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
def kill: ( ?expected_windows: ::Array[::LibTmux::EntityRef]?, ?expected_panes: ::Array[::LibTmux::EntityRef]?, ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux::CommandResult

Description#

Behavior contract: Entity removal.

Parameters

tmux command#

The tmux commands behind kill.

if-shell (expected windows or panes are given) kill-session list-commands (expected windows or panes are given) show-options (expected windows or panes are given)

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
Python 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