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

Session.KillWith

KillWith applies one kill-session mode without refreshing the materialized receiver. The zero request destroys the receiver; AllExcept destroys every other session while preserving the receiver and its current window; ClearAlerts only clears alerts in windows linked to the receiver and leaves sessions, winlinks, panes, client attachments, and current-window selections unchanged. Destroying a session handles clients as Session.Kill describes and removes its winlinks; windows left without links and their panes are also destroyed. Group destroys the receiver's group and requires tmux 3.7; on older versions it follows UnsupportedPolicy.

Source and package
Qualified name
tmux.Session.KillWith
Package
tmux
Declared in
Session
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/lifecycle_kill.go

Description#

The three modes are mutually exclusive. Only stderr makes a completed command a CommandError; nonzero exits without stderr are ignored. Transport errors are delivery-ambiguous.

tmux command#

The tmux commands behind KillWith.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference