# tmux copy-mode

Source: https://libtmux.org/en/tmux/3.7c/manual/copy-mode/

> Enter copy mode.

Enter copy mode.

## Syntax

```tmux-usage
tmux copy-mode [-deHMqSu] [-s src-pane] [-t target-pane]
```

## Behavior

Enter copy mode.

`-u` enters copy mode and scrolls one page up and `-d` one page down. `-H` hides the position indicator in the top right. `-q` cancels copy mode and any other modes.

`-M` begins a mouse drag (only valid if bound to a mouse key binding, see [MOUSE SUPPORT](https://libtmux.org/en/tmux/3.7c/manual/full/#MOUSE_SUPPORT)).

`-S` enters copy-mode and scrolls when bound to a mouse drag event; See `scroll-to-mouse`.

`-s` copies from `src-pane` instead of `target-pane`.

`-e` specifies that scrolling to the bottom of the history (to the visible screen) should exit copy mode. While in copy mode, pressing a key other than those used for scrolling will disable this behaviour. This is intended to allow fast scrolling through a pane's history, for example with:

```tmux-config
bind PageUp copy-mode -eu
bind PageDown copy-mode -ed
```

## C implementation

Internal declarations in tmux 3.7c:

* [`cmd_copy_mode_entry`](https://libtmux.org/en/tmux/3.7c/reference/c-variable-cmd_copy_mode_entry/)
* [`cmd_copy_mode_exec`](https://libtmux.org/en/tmux/3.7c/reference/c-function-cmd-copy-mode-c-cmd_copy_mode_exec/)

## Use from a library

Each API describes its own defaults, errors and execution model.

* [Python](https://libtmux.org/en/py/latest/reference/libtmux-pane-copy_mode/)
* [TypeScript](https://libtmux.org/en/ts/latest/reference/pane-pane-entercopymode/)
* [Rust](https://libtmux.org/en/rs/latest/reference/pane-pane-copy_mode/)
* [Go](https://libtmux.org/en/go/latest/reference/tmux-pane-copymode/)
* [Java](https://libtmux.org/en/java/latest/reference/io-github-libtmux-pane-pane-copymode/)
* [C#](https://libtmux.org/en/csharp/latest/reference/libtmux-pane-entercopymodeasync/)
* [C++](https://libtmux.org/en/cxx/latest/reference/libtmux-pane-enter_copy_mode/)
* [Ruby](https://libtmux.org/en/ruby/latest/reference/libtmux-pane-copy_mode/)
* [Lua](https://libtmux.org/en/lua/latest/reference/libtmux-pane-copy_mode/)

tmux sources and license

Syntax comes from `tmux 3.7c list-commands`. See the [global options](https://libtmux.org/en/tmux/3.7c/manual/full/#DESCRIPTION) for sockets and configuration, and [command syntax and targets](https://libtmux.org/en/tmux/3.7c/manual/full/#COMMANDS).

Behavior is taken from the [tmux 3.7c manual](https://github.com/tmux/tmux/blob/79072dd1a9f5fb437a5859e362a496fd57ec0981/tmux.1).

[Command declaration](https://github.com/tmux/tmux/blob/79072dd1a9f5fb437a5859e362a496fd57ec0981/cmd-copy-mode.c#L30)

```
Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
```