API reference
Browse the Haskell types and operations for working with tmux. Start with the core objects below, or search for a type or member.
LibTmux.Id 1 type
Distinct session, physical-window and physical-pane IDs.
LibTmux.Id — Entity identities 3 functions and constants
A session's unsigned 32-bit tmux identifier, written with a $ prefix.
Parse with parseSessionId; render with renderSessionId.
A physical window's identifier, independent of its session links.
Parse with parseWindowId; render with renderWindowId.
A physical pane's identifier, written with a % prefix.
Parse with parsePaneId; render with renderPaneId.
LibTmux.Id — Parse external values 4 functions and constants
Invalid canonical syntax, entity prefix or native unsigned range. Diagnostics retain at most 64 characters of input.
Parse $0 through $4294967295. No whitespace or leading zeroes.
Parse a canonical @number identifying a physical window.
Parse a canonical %number identifying a physical pane.
LibTmux.Id — Render target text 3 functions and constants
Render the session prefix and decimal ID.
Render the physical window prefix and decimal ID.
Render the physical pane prefix and decimal ID.
LibTmux.Id — Read numeric values 3 functions and constants
Read the numeric session ID without narrowing conversion.
Read the numeric physical window ID.
Read the numeric physical pane ID.
LibTmux.Value 1 type
Positive dimensions and nonnegative contextual indices.
LibTmux.Value — Checked types 3 functions and constants
Positive cells, constructed with mkDimension. Command and field limits
are checked separately. Compare dimensions directly or use dimensionValue
with an integer literal.
Nonnegative index of a window link within a session, not a physical window ID.
Construct with mkWindowIndex; read with windowIndexValue.
Nonnegative pane index within a window, not a pane ID.
Construct with mkPaneIndex; read with paneIndexValue.
LibTmux.Value — Validate input 4 functions and constants
A scalar outside its mathematical domain.
Construct a positive dimension without applying a command-specific maximum.
Construct a nonnegative window-link index.
Construct a nonnegative pane index.
LibTmux.Value — Read numeric values 3 functions and constants
Read a dimension as a mathematical integer, without narrowing conversion.
Read a window-link index as a mathematical integer.
Read a pane index as a mathematical integer.
LibTmux.Version 1 type
Parse stable tmux releases and check the supported release range.
LibTmux.Version — Release identity and errors 2 functions and constants
A stable release, constructed by parseVersion and rendered by
renderVersion. Ordering compares numeric components before the patch letter.
Invalid release syntax or a release outside the supported range.
LibTmux.Version — Parse and render 2 functions and constants
Parse a stable release or the output of tmux -V, allowing one final LF.
Development builds and trailing data are rejected rather than assigned
capabilities from a guessed stable version. Diagnostics retain at most 64 chars.
Render the canonical release without the executable name or newline.
LibTmux.Version — Admit a release 1 function or constant
Admit every stable release from 3.3a through 3.8, including intermediate releases. Versions outside that range fail. Individual features need their own capability checks; passing this check does not qualify an entire release.