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.

Swift API

method libtmux-swift latest

Server.format(_:)

Evaluates a tmux format against the server rather than any one object.

Source and package
Qualified name
Server.format(_:)
Declared in
Server
Package
libtmux-swift
Source
Sources/LibTmux/Formats.swift

Description#

Reaches the fields that describe the server itself — #{pid}, #{version}, #{socket_path} — and any format tmux resolves without a target.

  • Returns: what tmux printed, minus its trailing newline, or nil when no server is listening. An unknown field name is not an error to tmux and comes back as the empty string, the same as a field that is legitimately empty.
Parameters
Raises

tmux command#

The tmux commands behind format(_:).

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference