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

Server.killServer

Ends the tmux server and every session on it.

Source and package
Qualified name
io.github.libtmux.Server.killServer
Package
io.github.libtmux
Declared in
Server
Distribution
io.github.libtmux:libtmux
Source
libtmux/src/main/java/io/github/libtmux/Server.java
Other languages
Perlmethod Erlangfunction PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptRustGoC#C++SwiftKotlinScala OCaml F# Clojure

Description#

Deliberately explicit and deliberately not what #close() does: closing a client is not a reason to end everyone else's sessions.

Killing a server that has already gone is not a failure. Which is harder to detect than it sounds: tmux answers a doomed request with no server running most of the time, but with server exited unexpectedly when it reaches a socket whose server is still exiting — on every release from 3.3a onwards, and on one in five attempts on 3.7. So the postcondition is checked rather than the wording, which has changed before and says nothing a second look cannot answer better.

Parameters
  • timeout (Duration) # – how long to allow for each of the two commands for killServer(timeout)

tmux command#

The tmux commands behind killServer.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss killServer.

In other ports#

Shut the tmux server down

Equivalents of Shut the tmux server down in other languages
Language Equivalent
Python libtmux.Server.kill
Ruby LibTmux::Server#kill
Erlang tmux_server:stop_owned/1 Requires the ownership token for a library-owned daemon. Closing a borrowed endpoint preserves its daemon.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.kill
Rust server.Server.kill
Go tmux.Server.Kill
Clojure libtmux.core/kill-server!
Kotlin io.github.libtmux.kotlin.Server.killServer
Scala io.github.libtmux.scaladsl.Server.killServer
C# LibTmux.Server.KillAsync
C++ libtmux::Server::kill
Swift Server.killServer()
OCaml Client.close releases transport resources. The public client API does not terminate a borrowed tmux daemon.
Perl LibTmux::Server::kill_server Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes.

No equivalent is recorded in Lua, PowerShell, Julia, Elixir, Common Lisp or F#.

Esc

Type to search.

Reference previewOpen reference