# LibTmux.TmuxOptionKey.Flag

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

```
LibTmux.TmuxOptionKey.Flag(name: string) -> TmuxOptionKey<bool>
```

Declares an option tmux holds as a flag, which it reports as <c>on</c> or <c>off</c>.

## Parameters

- `name` (`string`): The option name.

## Returns

A key reading the option as a flag.

## Raises

- [`ArgumentException`](https://learn.microsoft.com/dotnet/api/system.argumentexception): The name is blank.