# libtmux for Erlang

> The Erlang library (libtmux_erlang). These pages include its guides, tested examples and API documentation.

## Concepts

- [Concepts](https://libtmux.org/en/erlang/latest/concepts/): Concepts for libtmux_erlang.
- [Architecture decisions](https://libtmux.org/en/erlang/latest/concepts/architecture/): Architecture decisions: libtmux_erlang documentation.
- [Batched graph capture](https://libtmux.org/en/erlang/latest/concepts/capture-strategy/): Batched graph capture: libtmux_erlang documentation.
- [Object graph](https://libtmux.org/en/erlang/latest/concepts/object-graph/): Object graph: libtmux_erlang documentation.
- [Selections and queries](https://libtmux.org/en/erlang/latest/concepts/queries/): Selections and queries: libtmux_erlang documentation.

## Core

- [tmux client library for Erlang](https://libtmux.org/en/erlang/latest/core/): tmux client library for Erlang. Control tmux, connect to and create servers, navigate sessions, windows, and panes, send keys, capture pane contents

## Erlang API reference

- [API glossary](https://libtmux.org/en/erlang/latest/reference/glossary/): Kinds, modifiers and package labels in the Erlang API reference.

## Erlang Workspace Manager

- [Erlang workspace manager is not published](https://libtmux.org/en/erlang/latest/workspace/): The Erlang source application validates JSON desired state. Its plan and apply workflow and command-line tool are unfinished, and no package or loader command is available.

## Examples

- [Examples](https://libtmux.org/en/erlang/latest/examples/): Run Erlang programs with private tmux servers and checked cleanup.

## Guides

- [Getting started](https://libtmux.org/en/erlang/latest/guides/getting-started/): Getting started: libtmux_erlang documentation.
- [Guides](https://libtmux.org/en/erlang/latest/guides/): Guides for libtmux_erlang.
- [Installation](https://libtmux.org/en/erlang/latest/guides/installation/): Installation: libtmux_erlang documentation.
- [Apply configuration and await its completion signal](https://libtmux.org/en/erlang/latest/guides/configuration/): Apply configuration and await its completion signal: libtmux_erlang documentation.
- [Build commands before running them](https://libtmux.org/en/erlang/latest/guides/commands/): Build commands before running them: libtmux_erlang documentation.
- [Install application keybindings](https://libtmux.org/en/erlang/latest/guides/keys/): Install application keybindings: libtmux_erlang documentation.
- [Isolate and rejoin a running pane](https://libtmux.org/en/erlang/latest/guides/panes/): Isolate and rejoin a running pane: libtmux_erlang documentation.
- [Native API documentation](https://libtmux.org/en/erlang/latest/guides/api-documentation/): Native API documentation: libtmux_erlang documentation.
- [Owned operations](https://libtmux.org/en/erlang/latest/guides/operations/): Owned operations: libtmux_erlang documentation.
- [Pipe pane output](https://libtmux.org/en/erlang/latest/guides/piping/): Pipe pane output: libtmux_erlang documentation.
- [Preserve byte buffers and paste deliberately](https://libtmux.org/en/erlang/latest/guides/buffers/): Preserve byte buffers and paste deliberately: libtmux_erlang documentation.
- [Read and change scoped options](https://libtmux.org/en/erlang/latest/guides/options/): Read and change scoped options: libtmux_erlang documentation.
- [Register a hook and await its effect](https://libtmux.org/en/erlang/latest/guides/hooks/): Register a hook and await its effect: libtmux_erlang documentation.
- [Support and remaining gaps](https://libtmux.org/en/erlang/latest/guides/compatibility/): Support and remaining gaps: libtmux_erlang documentation.
- [Workspace JSON loader](https://libtmux.org/en/erlang/latest/guides/workspace-json/): Workspace JSON loader: libtmux_erlang documentation.

## Linking and consuming our docs

- [Linking and consuming our docs](https://libtmux.org/en/erlang/latest/meta/linking/): Find documentation exports for search engines, bots, LLMs and other documentation sites.
- [Link to libtmux from Sphinx](https://libtmux.org/en/erlang/latest/meta/intersphinx/): Use Intersphinx inventories to reference libtmux APIs and documentation.
- [Intersphinx examples](https://libtmux.org/en/erlang/latest/meta/intersphinx/examples/): Compare Sphinx and MyST references to APIs, tmux C declarations, hooks, format variables, CLI commands and schema fields.

## Meta

- [AI policy](https://libtmux.org/en/erlang/latest/meta/ai-policy/): Use the libtmux packages with AI tools. When contributing, check what you submit and wait for a maintainer's invitation before preparing a pull request.
- [Third-party notices](https://libtmux.org/en/erlang/latest/meta/third-party-notices/): Thanks to tmux's creator and contributors, with licences and attribution for the software behind libtmux.org.

## Reference

- [Command capabilities](https://libtmux.org/en/erlang/latest/reference/commands/): Command capabilities: libtmux_erlang documentation.
- [Fields and operators](https://libtmux.org/en/erlang/latest/reference/fields/): Fields and operators: libtmux_erlang documentation.
- [Options](https://libtmux.org/en/erlang/latest/reference/options/): Options: libtmux_erlang documentation.

## Topics

- [Topics](https://libtmux.org/en/erlang/latest/topics/): Topics for libtmux_erlang.
- [Control connections](https://libtmux.org/en/erlang/latest/topics/control/): Control connections: libtmux_erlang documentation.
- [Diagnostics](https://libtmux.org/en/erlang/latest/topics/diagnostics/): Diagnostics: libtmux_erlang documentation.
- [Ownership and identity](https://libtmux.org/en/erlang/latest/topics/ownership/): Ownership and identity: libtmux_erlang documentation.
- [Project policy](https://libtmux.org/en/erlang/latest/topics/project-policy/): Project policy: libtmux_erlang documentation.

## Reference

- [Erlang API reference](https://libtmux.org/en/erlang/latest/reference/): every public symbol, generated from the source. Hosted on libtmux.org.

## Optional

- [Full documentation text](https://libtmux.org/en/erlang/latest/llms-full.txt): guides and MCP contracts in a single fetch.