# LibTmux::Pane#copy_mode

- **Module:** LibTmux
- **Package:** libtmux
- **Language:** Ruby
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ruby/blob/dcc9f8b5a6970144a9e7d80cd5f381d8f6198372/gems/libtmux/lib/libtmux/operations.rb#L383
- **Page:** https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-pane-copy_mode/

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

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

Behavior: Copy mode.

Behavior contract: Copy mode.

## In other ports

### Put a pane into copy mode

- Python: [`libtmux.Pane.copy_mode`](/en/py/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)