# LibTmux::Pane#copy_mode

- **Module:** LibTmux::Pane#
- **Package:** libtmux
- **Language:** Ruby
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ruby/blob/c6d9d21771828e583692ca899ed817f9640d6a55/gems/libtmux/lib/libtmux/operations.rb#L383
- **Page:** https://libtmux.org/en/ruby/latest/reference/libtmux-pane-copy_mode/

```
LibTmux::Pane#copy_mode(scroll_up: bool = nil, exit_on_bottom: bool = nil, mouse_drag: bool = nil, cancel_mode: bool = nil, page_down: bool = nil, source: ::LibTmux::EntityRef? = nil, timeout: ::Numeric = nil, cancel: untyped = nil) -> ::LibTmux::CommandResult
```

Behavior: Copy mode.

Behavior contract: Copy mode.