Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

0.x Released; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Examples CLI Manual API Reference Configuration Internals

concept Working example; may change without notice. Read more

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.

Swift API

method libtmux-swift latest

Server.captureRange(_:startingAt:endingAt:joiningWrappedLines:maximumLines:)

Reads a bounded tmux capture range using tmux's relative row numbering.

Source and package

Qualified name: Server.captureRange(_:startingAt:endingAt:joiningWrappedLines:maximumLines:)
Declared in: Server
Package: libtmux-swift
Source: Sources/LibTmux/PaneInteraction.swift

captureRange( pane: Pane, startingAt: Int?, endingAt: Int?, joiningWrappedLines: Bool, maximumLines: Int ) -> PaneCapture method async [source] ¶

Parameters

pane (Pane) #
startingAt (Int?) #
endingAt (Int?) #
joiningWrappedLines (Bool) #
maximumLines (Int) #

Raises

TmuxError

tmux command#

The tmux commands behind captureRange(_:startingAt:endingAt:joiningWrappedLines:maximumLines:).

capture-pane display-message

tmux C API#

The C declarations in tmux that implement these commands.

cmd_capture_pane_entry cmd_capture_pane_exec cmd_display_message_entry cmd_display_message_exec

Reference preview