Auto Light Dark

Core LibraryAPI Reference

Choose documentation 1

latest

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

F# API

function libtmux-fsharp latest

Pane.findOnScreen

Namespace L.FSharp LibTmux.FSharp

Returns the first visible row showing the text, counted from 1, or None.

View as Markdown

Source and package

Module: LibTmux.FSharp
Declared in: Pane
Package: LibTmux.FSharp
Source: src/LibTmux.FSharp/Hierarchy.fsi

F# value signatures Declares the name and type of a value or function in a signature. Language documentation findOnScreen: cancellationToken: CancellationToken -> search: ScreenSearch -> pane: LibTmux.Pane -> Task<int option>

function [source] ¶

Description#

tmux searches only the rows on screen. Capture the history and filter its lines to search further back.

Parameters

cancellationToken ( CancellationToken )
search ( ScreenSearch )
pane ( LibTmux.Pane )

Raises

System.ArgumentException – The text cannot be written as a tmux format.

Discussed in Querying and filtering