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

TmuxOptionKey

Namespace LibTmux.TmuxOptionKey LibTmux

A tmux option and the .NET type its value reads as.

View as Markdown

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

Description#

Declared by the caller rather than catalogued: tmux has hundreds of options, adds them between releases and changes a few of their types, so a closed catalogue would be wrong somewhere on every release it did not track. A key says how to read one option; the request methods on TmuxOptions remain for anything else.

Members11 members#

Other members11 members#

  • AutomaticRename property Gets whether a window renames itself after what its pane runs; a window option.
  • BaseIndex property Gets the index a session's first window gets; a session option.
  • EscapeTime property Gets how many milliseconds tmux waits after an escape for a key sequence; a server option.
  • Flag method Declares an option tmux holds as a flag, which it reports as on or off.
  • HistoryLimit property Gets how many lines of scrollback a pane keeps; a session option.
  • Mouse property Gets whether tmux captures the mouse; a session option.
  • Name property Gets the option's name, as tmux spells it.
  • Number method Declares an option tmux holds as a whole number.
  • SynchronizePanes property Gets whether keys typed into one pane go to every pane in its window; a window or pane option.
  • Text method Declares an option read as the text tmux reports, which suits a string, a choice, a style or a colour.
  • ToString method
Esc

Type to search.