# API reference

Source: https://libtmux.org/en/erlang/latest/reference/

> Types, methods, and functions in libtmux for Erlang.

Browse the Erlang types and operations for working with tmux. Start with the core objects below, or search for a type or member.

Server 1 type

[tmux_server](https://libtmux.org/en/erlang/latest/reference/tmux_server/) module 22 members

Open tmux endpoints and execute explicit command values.

Session 1 type

[tmux_session](https://libtmux.org/en/erlang/latest/reference/tmux_session/) module 9 members

Create and observe sessions, or act on a session's registered stable ID.

Window 2 types

[tmux_window](https://libtmux.org/en/erlang/latest/reference/tmux_window/) module 9 members

Create physical windows in a session and act through their registered IDs.

[tmux_window_link](https://libtmux.org/en/erlang/latest/reference/tmux_window_link/) module 10 members

Act on a physical window's observed membership in a particular session.

Pane 1 type

[tmux_pane](https://libtmux.org/en/erlang/latest/reference/tmux_pane/) module 26 members

Create, observe and rearrange panes using registered physical IDs.

Hooks 1 type

[tmux_hook](https://libtmux.org/en/erlang/latest/reference/tmux_hook/) module 10 members

Store builtin hook commands and run them in an explicit observed context.

Options 1 type

[tmux_option](https://libtmux.org/en/erlang/latest/reference/tmux_option/) module 13 members

Read and change explicit tmux option tables through registered references.

Keys and bindings 1 type

[tmux_key](https://libtmux.org/en/erlang/latest/reference/tmux_key/) module 10 members

Register and remove bindings in explicit server key tables.

Buffers 1 type

[tmux_buffer](https://libtmux.org/en/erlang/latest/reference/tmux_buffer/) module 13 members

Load, inspect and paste tmux byte buffers through an explicit endpoint.

Terminal capabilities 1 type

[tmux_capability](https://libtmux.org/en/erlang/latest/reference/tmux_capability/) module 8 members

Look up source-derived native command declarations and feature minimums.

Versions 1 type

[tmux_version](https://libtmux.org/en/erlang/latest/reference/tmux_version/) module 4 members

Parse the output of tmux -V without invoking tmux.

Commands 3 types

[tmux_command](https://libtmux.org/en/erlang/latest/reference/tmux_command/) module 16 members

Build tmux commands and bounded sequences without performing I/O.

[tmux_operation](https://libtmux.org/en/erlang/latest/reference/tmux_operation/) module 12 members

Own a command independently of an individual wait.

[tmux_scope](https://libtmux.org/en/erlang/latest/reference/tmux_scope/) module 4 members

Run synchronous work and cleanup while preserving both outcomes.

Control mode 1 type

[tmux_control](https://libtmux.org/en/erlang/latest/reference/tmux_control/) module 6 members

Own an explicit persistent tmux control attachment.

Queries 6 types

[tmux_filter](https://libtmux.org/en/erlang/latest/reference/tmux_filter/) module 14 members

Construct portable conditions and prepare them against captured values.

[tmux_json](https://libtmux.org/en/erlang/latest/reference/tmux_json/) module 1 member

Decode bounded JSON using OTP's `json` parser and binary object keys.

[tmux_matcher](https://libtmux.org/en/erlang/latest/reference/tmux_matcher/) module 1 member

Prepare a trusted local predicate once for a captured snapshot.

[tmux_query](https://libtmux.org/en/erlang/latest/reference/tmux_query/) module 17 members

Build and execute explicit queries over the tmux graph.

[tmux_schema](https://libtmux.org/en/erlang/latest/reference/tmux_schema/) module 12 members

Validate schema-defined observations and normalize scalar values.

[tmux_select](https://libtmux.org/en/erlang/latest/reference/tmux_select/) module 31 members

Filter ordered captured rows without tmux I/O.

Snapshots 3 types

[tmux_identity](https://libtmux.org/en/erlang/latest/reference/tmux_identity/) module 5 members

Observe a Linux process incarnation using its PID, boot ID and start ticks.

[tmux_model](https://libtmux.org/en/erlang/latest/reference/tmux_model/) module 29 members

Validated native domain records. Constructors perform no tmux I/O.

[tmux_snapshot](https://libtmux.org/en/erlang/latest/reference/tmux_snapshot/) module 17 members

Read an immutable captured graph without performing tmux I/O.

Errors 1 type

[tmux_error](https://libtmux.org/en/erlang/latest/reference/tmux_error/) module 1 member

Explain library exceptions through Erlang's native error formatter.
