GitHub LuaRocks

Auto Light Dark

Core Library0.xAPI Reference

Choose documentation 1

latest

Current version

English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Lua API

API reference

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

Server 1 type

Server class In libtmux 30 members

A handle to one running tmux server, reached through a connected runtime.

Session 1 type

Session class In libtmux 22 members

A tmux session.

Window 2 types

Window class In libtmux 16 members

A tmux window. Placement in a session belongs to its window links.

WindowLink class In libtmux 7 members

One placement of a window in a session: a window can be linked into several.

Pane 2 types

Pane class In libtmux 29 members

A tmux pane.

TextWait class 2 members

Client 2 types

Client class In libtmux 2 members

A client attached to the server.

ClientSelector class 2 members

Hooks 2 types, 1 function or constant

HookProgram class 2 members

HookRecord class 8 members

HookName type alias

Options 4 types, 2 functions and constants

OptionArrayInput class 1 member

OptionDescriptor class 17 members

OptionEntry class 2 members

OptionRecord class 8 members

OptionInput type alias

OptionName type alias

Buffers 2 types

Buffer class In libtmux 2 members

A paste buffer. Buffer contents are read and written through the Server.

BufferValue class 3 members

Layout and geometry 1 function or constant

NamedLayout type alias

Environment 1 type

EnvironmentRecord class 7 members

Terminal capabilities 2 types

Capability class 9 members

CapabilityCommand class 2 members

Commands 1 type

CommandOutcome class 4 members

Formats 7 types

Buffer class In libtmux.Fields 4 members

Client class In libtmux.Fields 10 members

Pane class In libtmux.Fields 21 members

Server class In libtmux.Fields 4 members

Session class In libtmux.Fields 9 members

Window class In libtmux.Fields 8 members

WindowLink class In libtmux.Fields 5 members

Queries 7 types, 5 functions and constants

LiveQueryPlan class 15 members

QueryRelation class 4 members

QuerySchema class 3 members

RelationCriteria class 5 members

Selection class 9 members

Where class 3 members

query module 14 members

CompiledQuery type alias

Null type alias

QueryInput type alias

QueryScalar type alias

WhereValue type alias

Queries — Fields 2 types

FieldCriteria class 12 members

QueryField class 3 members

Queries — Expressions 1 function or constant

Predicate type alias

Snapshots 8 types

Capture class 3 members

Snapshot class 14 members

SnapshotBuffer class 5 members

SnapshotClient class 12 members

SnapshotPane class 23 members

SnapshotSession class 11 members

SnapshotWindow class 11 members

SnapshotWindowLink class 8 members

Requests 1 type

Request class 6 members

Errors 2 types

Error class 6 members

QueryError class 4 members

Constants and enums 37 types

BufferOptions class 1 member

CaptureOptions class 16 members

ClearHistoryOptions class 2 members

CommandBatchOptions class 2 members

CommandOptions class 8 members

CommandResult class 4 members

ConnectOptions class 3 members

Options for libtmux.Runtime:connect().

CopyModeOptions class 2 members

CreationOptions class 5 members

CreationProcessOptions class 5 members

EnvironmentGetOptions class 3 members

EnvironmentListOptions class 4 members

EnvironmentOptions class 2 members

What every environment operation accepts; unset and remove take no more.

EnvironmentSetOptions class 3 members

KeyOptions class 2 members

LayoutOptions class 6 members

LinkOptions class 3 members

LiveQueryOptions class 5 members

LiveQueryResult class 6 members

ObservationEvent class 15 members

ObservationOptions class 4 members

PasteBufferOptions class 6 members

RespawnOptions class 6 members

RunHookOptions class 1 member

Running a hook reads only its handle's own scope.

RuntimeOptions class 8 members

SettingGetOptions class 4 members

SettingListOptions class 3 members

SettingOptions class 2 members

What every option and hook operation accepts. Each operation's own class adds the fields it reads; anything else fails with invalid_options.

SettingSetOptions class 4 members

SettingUnsetOptions class 3 members

SnapshotOptions class 5 members

SplitOptions class 10 members

SwapLinkOptions class 2 members

TopologyOptions class 1 member

UnlinkOptions class 2 members

WaitTextOptions class 3 members

WatchOptions class 2 members

Constants and enums — Session 1 type

NewSessionOptions class 9 members

Constants and enums — Window 4 types

NavigateWindowOptions class 2 members

NewWindowOptions class 8 members

ResizeWindowOptions class 7 members

RespawnWindowOptions class 7 members

Constants and enums — Pane 6 types

BreakPaneOptions class 3 members

MovePaneOptions class 8 members

PaneOptions class 1 member

ResizePaneOptions class 5 members

SelectPaneOptions class 2 members

SwapPaneOptions class 3 members

Constants and enums — Client 2 types

ClientOptions class 1 member

SwitchClientOptions class 2 members

Runtime adapters 2 types

luv module 1 member

nvim module 1 member

Other 9 types

Configurable class 11 members

Options and hooks, shared by sessions, windows and panes. Scopes are limited to the handle's own kind; global scopes belong to the Server.

Creation class 5 members

Entity class 2 members

A handle to one tmux object, bound to the snapshot generation it came from. Every handle kind can report its reference and refresh its snapshot record; the concrete classes below add what tmux allows for that kind.

LinkDestination class 4 members

Observation class 5 members

ObservationCoverage class 4 members

Reference class 8 members

Runtime class 5 members

Watch class 2 members

By module 3 modules

Reference preview