# LibTmux.TmuxOptionKey

- **Module:** LibTmux
- **Package:** LibTmux
- **Language:** C#
- **Kind:** class
- **Source:** https://github.com/libtmux/libtmux-dotnet/blob/cf34b255c896d19a97e7d7fabea58609c916012d/src/LibTmux/Options/TmuxOptionKey.cs#L14
- **Page:** https://libtmux.org/en/csharp/latest/reference/libtmux-tmuxoptionkey/

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

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
<see cref="TmuxOptions" /> remain for anything else.

## Members

### Other 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 <c>on</c> or <c>off</c>.
- `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)