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.

property libtmux-ts latest

ServerOptions.socketName

The socket name, passed to tmux as -L.

Source and package
Qualified name
ServerOptions.socketName
Module
server
Declared in
ServerOptions
Package
libtmux
Source
packages/libtmux/src/server.ts
socketName : string

Description#

With neither socketName nor socketPath given, the server reads LIBTMUX_SOCKET_PATH, else LIBTMUX_SOCKET, from ServerOptions.environment; a variable that is empty or only whitespace counts as unset. With none set it passes tmux no socket, and tmux picks the server: the one TMUX names inside tmux, otherwise its default socket. A socket given here is never overridden by either variable.

Esc

Type to search.

Reference previewOpen reference