# libtmux.Pane.copy_mode

- **Module:** libtmux
- **Package:** libtmux
- **Language:** Python
- **Kind:** method
- **Source:** https://github.com/tmux-python/libtmux/blob/38e368c11117fb4aeb2f082d552cd4f210eae06a/src/libtmux/pane.py#L1959
- **Page:** https://libtmux.org/en/py/stable/reference/libtmux-pane-copy_mode/

tmux command: [`copy-mode`](/en/tmux/latest/manual/copy-mode/)

```
libtmux.Pane.copy_mode(
    self,
    scroll_up: bool | None = None,
    exit_on_bottom: bool | None = None,
    mouse_drag: bool | None = None,
    cancel: bool | None = None,
    page_down: bool | None = None,
    source_pane: str | None = None,
) -> None
```

Enter copy mode via [`$ tmux copy-mode`](/en/tmux/latest/manual/copy-mode/).

## Examples

```python
>>> pane.copy_mode()
```

## Parameters

- `scroll_up` (`bool | None`): Start scrolled up one page (``-u`` flag).
- `exit_on_bottom` (`bool | None`): Exit copy mode when scrolling reaches the bottom of the
history (``-e`` flag).
- `mouse_drag` (`bool | None`): Start mouse drag (``-M`` flag).
- `cancel` (`bool | None`): Cancel copy mode and any other modes (``-q`` flag).
- `page_down` (`bool | None`): Scroll a page down if already in copy mode (``-d`` flag).
Requires tmux 3.5+.
- `source_pane` (`str | None`): Source pane whose contents should be displayed in copy
mode (``-s`` flag). Lets you scroll/copy from another
pane's history. Requires tmux 3.2+.

## In other ports

### Put a pane into copy mode

- Ruby: [`LibTmux::Pane#copy_mode`](/en/ruby/latest/reference/libtmux-pane-copy_mode/) (method)
- Lua: [`libtmux.Pane:copy_mode`](/en/lua/latest/reference/libtmux-pane-copy_mode/) (method)
- TypeScript: [`pane.Pane.enterCopyMode`](/en/ts/latest/reference/pane-pane-entercopymode/) (method)
- Rust: [`pane.Pane.copy_mode`](/en/rs/latest/reference/pane-pane-copy_mode/) (method)
- Go: [`tmux.Pane.CopyMode`](/en/go/latest/reference/tmux-pane-copymode/) (method)
- Java: [`io.github.libtmux.Pane.Pane.copyMode`](/en/java/latest/reference/io-github-libtmux-pane-pane-copymode/) (method)
- C#: [`LibTmux.Pane.EnterCopyModeAsync`](/en/csharp/latest/reference/libtmux-pane-entercopymodeasync/) (method)
- C++: [`libtmux::Pane::enter_copy_mode`](/en/cxx/latest/reference/libtmux-pane-enter_copy_mode/) (method)