Core LibraryalphaAPI 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-cxx latest

Server.at_default

The server a bare tmux command reaches from this process, unless the environment names another: the one a person means when they say "my tmux".

Source and package
Qualified name
libtmux::Server::at_default
Namespace
libtmux
Declared in
Server
Package
libtmux-cxx
Source
include/libtmux/server.hpp
[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] static expected<Server, CommandFailure> at_default(CommandObserver observer = {}, ExecutionPolicy policy = {});

Description#

LIBTMUX_SOCKET_PATH selects a socket path (-S), else LIBTMUX_SOCKET a socket name (-L); socket_from_environment() has the rules for both set, for a blank value and for the diagnostic. With neither set the handle names no socket and tmux picks the server: the one TMUX names inside a tmux pane, and the default socket under TMUX_TMPDIR elsewhere. Either way socket_path() reports the server the commands reach. A variable that cannot be used fails with the variable named and its value left out; at_socket_path() and at_socket_name() read neither variable.

Guides#

Pages that discuss at_default.

Esc

Type to search.

Reference previewOpen reference