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

module libtmux-fsharp latest

Options

Namespace L.FSharp LibTmux.FSharp

Reads and writes options through keys that know their value's type.

View as Markdown

Source and package

Module: LibTmux.FSharp
Package: LibTmux.FSharp
Source: src/LibTmux.FSharp/Hierarchy.fsi

module Options module [source] ¶: Description#

Pass the options of the scope the option belongs to, such as <c>session.Options</c> for <c>TmuxOptionKey.HistoryLimit</c>. Declare other keys with <c>TmuxOptionKey.Text</c>, <c>Number</c> or <c>Flag</c>.

Members2 members#

Common operations2 members#

get function Reads the value an option has in a scope, set there or inherited, as its key's type.
set function Sets an option in a scope from a value of its key's type.