Java API reference

One tmux server, reached over one transport.

What a server needs to know before it runs anything: which tmux, which server, which config.

Which tmux server to talk to.

Which tmux server a handle belongs to.

One tmux session, as one capture saw it.

A tmux session id, such as $0.

How a session should be made.

One tmux window at one of its positions, as one capture saw it.

A tmux window id, such as @1.

Where a window sits in one session.

Where a new window is inserted relative to the current one.

How a window should be made.

One window, its panes, and how they are arranged.

One tmux pane, as one capture saw it.

Which sides of its window a pane touches.

A tmux pane id, such as %2.

How big a new pane should be.

What runs in a new pane.

One pane and what to run in it.

One attached tmux client, as one capture saw it.

What a client was looking at.

The tmux hooks at one scope.

One tmux paste buffer, as a listing described it.

The tmux server's paste buffers.

How big something is, in terminal cells.

Which way to move or grow something.

One of tmux's built-in pane arrangements.

Which layout names are safe to hand to tmux.

Where a new pane goes relative to the one being split.

How a pane should be split.

What tmux tells a program running inside one of its panes.

A released tmux version, ordered the way tmux releases are.

The running tmux does not have something the call asked for.

A sequence of tmux commands where each one acts on what the last one made.

How certain the transport is that tmux applied a request.

Turns a drained pipe into lines the way callers already expect.

The default transport: one child process per call, drained by a bounded pool of platform threads.

Runs one tmux command and blocks until it has an answer.

A tmux client that stays attached and answers one command at a time.

Reads bounded physical lines from a control client's byte stream.

Frames control-mode replies and encodes requests for tmux's command parser.

One command's reply in control mode.

Owns the process-pipe write and the FIFO that attributes replies to requests.

Pulls events volunteered by one control client.

Terminal output tmux pushed without being asked.

A listing template and the reader for the rows it produces.

The token this process marks its own text with.

The name__contains=dev form, confined to the edge.

Cardinality with the ambiguity removed.

The versioned wire form of a filter expression.

What a document's field and relation ids mean.

A named, kinded accessor.

Typed field handles.

The scalar comparisons an expression can hold. Evaluation stays a total switch.

A filter that is both runnable and readable.

What part of a pane to read, and how.

A client as one capture saw it.

A pane as one capture saw it.

One tmux hierarchy, as it was at one moment.

A session as one capture saw it.

One tmux winlink: a window as it appears in one session, at one index.

A window as one capture saw it, at one of its positions.

Reads a whole tmux server into one snapshot.

A session described in a file, before anything has been built.

Applies a validated workspace as one session and attempts to remove it after a failure.

Builds a tmux session from a written description.

Converts the supported YAML shape into immutable workspace values.

One tmux invocation: how to reach the server, then the commands to run there.

A listing row did not have the shape its template asked for.

The root of every operational failure this library raises.

A live server does not have the object a handle addresses.

A request crossed the process boundary but did not finish before its deadline.

A transport failure, carrying how certain it is that tmux applied the command.

A document could not be read as the expression it claims to be.

What became of every operation in one batch.

One operation's own result within a batch.

Something tmux volunteered, rather than an answer to a request.

The tmux options at one scope.

The value kind a field reads.

One completed invocation.

A mode a pane can be in, as tmux names them.

Gives each test its own tmux server and guarantees it is gone afterwards.

The socket a fixture server is listening on.

Byte-preserving UTF-8 decoding shared by process and control transports.

Encodes a tmux command for each of the two parsers tmux reads commands with.

Owns bounded, idempotent termination of one process and its observable descendants.

Several tmux commands in one invocation, each with an outcome of its own.

What became of one operation in a batch.

One of tmux's wait-for channels, named once.

What to look for when opening the window browser narrowed to a match.

Shared validation for the sigil-prefixed ids tmux hands out.

Why a wait on a tmux channel ended.

The wire ids for this library's own entities.