Core LibraryAPI Reference

Choose documentation 1

latest

Current version

latest
English

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

module libtmux-fsharp latest

Mirror

Namespace LibTmux.FSharp.Mirror LibTmux.FSharp

Follows a server's sessions, windows, panes and clients as tmux announces changes.

View as Markdown

Source and package
Module
LibTmux.FSharp
Package
LibTmux.FSharp
Source
src/LibTmux.FSharp/Control.fsi
module Mirror
module [source]

Description#

Each announcement starts a fresh capture; a capture that finds nothing different publishes nothing. tmux does not announce a pane's running command or working directory, nor layout changes in other sessions; use <c>startRefreshing</c> to see those within an interval.

Members6 members#

Common operations5 members#

  • waitUntil function Waits until a view satisfies a condition, testing the current view first.
  • start function Mirrors the server an anchor session belongs to, capturing on each announcement.
  • views function Streams the current view and each newer one, skipping views published while the reader was busy.
  • startRefreshing function Mirrors a server, also capturing whenever it has been quiet for an interval.
  • tryWaitUntil function Waits until a view satisfies a condition, or returns None when none did in time.

Other members1 member#

  • current function Returns the latest published view.
Esc

Type to search.