Core LibraryAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

class libtmux-dotnet latest

TmuxOptions

Namespace LibTmux.TmuxOptions LibTmux

The options of one server, session, window, or pane.

View as Markdown

Source and package
Module
LibTmux
Package
LibTmux
Source
src/LibTmux/Options/TmuxOptions.cs
class LibTmux.TmuxOptions
class [source]

Description#

tmux keeps four option tables and picks between them with a flag, so the scope is fixed when the accessor is reached rather than passed to every call. A request may still name another scope, which is what makes a window-scoped read from a session possible without a second accessor.

Members5 members#

Common operations4 members#

  • GetAllAsync method Reads every option in the scope.
  • GetAsync method Reads one option.
  • SetAsync method Sets an option in this scope from a value of its key's type.
  • UnsetAsync method Unsets one option, returning it to what it inherits.

Other members1 member#

  • Scope property Gets the scope these options are read and written in by default.
Esc

Type to search.