Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-lisp latest

libtmux:open-client

Open an SBCL/Linux subprocess client and check its tmux version. Checks the runtime profile and required OS facilities before resolving PROGRAM. An unsupported profile or facility signals UNSUPPORTED-PLATFORM; ERROR-FEATURE identifies the requirement. PROGRAM must resolve to a native x86_64 ELF tmux executable; pass the underlying binary when PATH selects a script or shim. SOCKET-NAME and SOCKET-PATH are mutually exclusive; omission selects tmux's default socket. No daemon is started. TIMEOUT is seconds; OUTPUT-LIMIT bounds combined stdout/stderr bytes per command. Signals an operational condition on version/launch failure. Returned configuration strings are owned by the client.

Source and package
Qualified name
libtmux:open-client
Declared in
libtmux
Package
libtmux
Source
src/client.lisp
(open-client &key (program "tmux") socket-name socket-path config-file (timeout 30) (output-limit (* 16 1024 1024)))

Public owner: libtmux

Guides#

Pages that discuss open-client.

Esc

Type to search.

Reference previewOpen reference