# mouse

Source: https://libtmux.org/en/tmux/3.7c/catalog/options/mouse/

> If on, tmux captures the mouse and allows mouse events to be bound as key bindings.

option tmux3.7c

If on, tmux captures the mouse and allows mouse events to be bound as key bindings.

* Scope

  session

* Type

  Flag (on or off)

* Default

  `off`

* Set

  [`set-option`](https://libtmux.org/en/tmux/3.7c/manual/set-option/) `mouse value`

* Read

  [`show-options`](https://libtmux.org/en/tmux/3.7c/manual/show-options/) `mouse`

## Description[#](https://libtmux.org/en/tmux/3.7c/catalog/options/mouse/#description)

If on, `tmux` captures the mouse and allows mouse events to be bound as key bindings. See the [MOUSE SUPPORT](https://libtmux.org/en/tmux/3.7c/manual/full/#MOUSE_SUPPORT) section for details.

## Releases[#](https://libtmux.org/en/tmux/3.7c/catalog/options/mouse/#releases)

* [tmux 3.7c](https://libtmux.org/en/tmux/3.7c/catalog/options/mouse/) : present
* [tmux 3.2a](https://libtmux.org/en/tmux/3.2a/catalog/options/mouse/) : present

## Source[#](https://libtmux.org/en/tmux/3.7c/catalog/options/mouse/#source)

* Defined in

  [`options-table.c:767`](https://github.com/tmux/tmux/blob/e476c1230b958df0cb12977517d24b3dc931375b/options-table.c#L767)

* C source reference

  [`options_table`](https://libtmux.org/en/tmux/3.7c/reference/c-variable-options_table/)

* CLI Manual

  [Original manual entry](https://libtmux.org/en/tmux/3.7c/manual/full/#options-mouse)

## Used by[#](https://libtmux.org/en/tmux/3.7c/catalog/options/mouse/#used-by)

Library documentation that names this option.

* Rust

  [`options.generated.MOUSE`](https://libtmux.org/en/rs/latest/reference/options-generated-mouse/)